Cardinal
NekPlaneSpatialBinUserObject.h
Go to the documentation of this file.
1 /********************************************************************/
2 /* SOFTWARE COPYRIGHT NOTIFICATION */
3 /* Cardinal */
4 /* */
5 /* (c) 2021 UChicago Argonne, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by UChicago Argonne, LLC */
9 /* Under Contract No. DE-AC02-06CH11357 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* Prepared by Battelle Energy Alliance, LLC */
13 /* Under Contract No. DE-AC07-05ID14517 */
14 /* With the U. S. Department of Energy */
15 /* */
16 /* See LICENSE for full restrictions */
17 /********************************************************************/
18 
19 #pragma once
20 
23 
31 {
32 public:
33  static InputParameters validParams();
34 
35  NekPlaneSpatialBinUserObject(const InputParameters & parameters);
36 
37  virtual Real distanceFromGap(const Point & point, const unsigned int & gap_index) const;
38 
39  virtual unsigned int gapIndex(const Point & point) const;
40 
41  virtual void
42  gapIndexAndDistance(const Point & point, unsigned int & index, Real & distance) const;
43 
44 protected:
46  const Real & _gap_thickness;
47 
50 
52  unsigned int _side_index;
53 };
NekSpatialBinUserObject
Definition: NekSpatialBinUserObject.h:29
NekPlaneSpatialBinUserObject::gapIndexAndDistance
virtual void gapIndexAndDistance(const Point &point, unsigned int &index, Real &distance) const
PlaneSpatialBinUserObject.h
PlaneSpatialBinUserObject
Definition: PlaneSpatialBinUserObject.h:26
NekPlaneSpatialBinUserObject::validParams
static InputParameters validParams()
NekPlaneSpatialBinUserObject::_side_index
unsigned int _side_index
The index into the _bins that represents the side bin object.
Definition: NekPlaneSpatialBinUserObject.h:52
NekPlaneSpatialBinUserObject::NekPlaneSpatialBinUserObject
NekPlaneSpatialBinUserObject(const InputParameters &parameters)
NekPlaneSpatialBinUserObject::distanceFromGap
virtual Real distanceFromGap(const Point &point, const unsigned int &gap_index) const
NekPlaneSpatialBinUserObject::gapIndex
virtual unsigned int gapIndex(const Point &point) const
NekPlaneSpatialBinUserObject::_gap_thickness
const Real & _gap_thickness
Width of region enclosing gap for which points contribute to gap integral.
Definition: NekPlaneSpatialBinUserObject.h:46
NekSpatialBinUserObject.h
NekPlaneSpatialBinUserObject
Definition: NekPlaneSpatialBinUserObject.h:30
NekPlaneSpatialBinUserObject::_side_bin
const PlaneSpatialBinUserObject * _side_bin
The user object providing the side binning.
Definition: NekPlaneSpatialBinUserObject.h:49