PlaneSpatialBinUserObject.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 "SpatialBinUserObject.h"
 
class PlaneSpatialBinUserObject : public SpatialBinUserObject
{
public:
 static InputParameters validParams();
 
 PlaneSpatialBinUserObject(const InputParameters & parameters);
 
 virtual Real distanceFromGap(const Point & point, const unsigned int & gap_index) const = 0;
 
 virtual unsigned int gapIndex(const Point & point) const = 0;
 
 virtual void
 gapIndexAndDistance(const Point & point, unsigned int & index, Real & distance) const = 0;
 
 virtual const std::vector<Point> & gapUnitNormals() const = 0;
 
 virtual Real adjustBinValue(const unsigned int & /* bin */) const { return 1.0; }
};