SpatialBinUserObject.h

Go to the documentation of this file.

/********************************************************************/
/* SOFTWARE COPYRIGHT NOTIFICATION */
/* Cardinal */
/* */
/* (c) 2021 UChicago Argonne, LLC */
/* ALL RIGHTS RESERVED */
/* */
/* Prepared by UChicago Argonne, LLC */
/* Under Contract No. DE-AC02-06CH11357 */
/* With the U. S. Department of Energy */
/* */
/* Prepared by Battelle Energy Alliance, LLC */
/* Under Contract No. DE-AC07-05ID14517 */
/* With the U. S. Department of Energy */
/* */
/* See LICENSE for full restrictions */
/********************************************************************/
 
#pragma once
 
#include "ThreadedGeneralUserObject.h"
 
class SpatialBinUserObject : public ThreadedGeneralUserObject
{
public:
 static InputParameters validParams();
 
 SpatialBinUserObject(const InputParameters & parameters);
 
 virtual void execute() final {}
 virtual void initialize() final {}
 virtual void finalize() final {}
 
 virtual Real spatialValue(const Point & p) const override;
 
 virtual unsigned int bin(const Point & p) const = 0;
 
 virtual unsigned int num_bins() const = 0;
 
 unsigned int binFromBounds(const Real & pt, const std::vector<Real> & bounds) const;
 
 virtual const std::vector<Point> & getBinCenters() const { return _bin_centers; }
 
 virtual const std::vector<unsigned int> directions() const { return _directions; }
 
protected:
 std::vector<Point> _bin_centers;
 
 std::vector<unsigned int> _directions;
};