FilterBase Class Reference

#include <FilterBase.h>

Inheritance diagram for FilterBase:

Public Member Functions
	FilterBase (const InputParameters &parameters)
virtual bool	skipBin (const unsigned int bin) const
virtual std::string	binName (unsigned int bin_index) const =0
int	numBins () const
openmc::Filter *	getWrappedFilter ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
OpenMCCellAverageProblem &	_openmc_problem
	The OpenMCCellAverageProblem using the tally system. More...
openmc::Filter *	_filter = nullptr
	The OpenMC filter this class wraps. More...
unsigned int	_filter_index
	The index of the OpenMC filter this class wraps. More...

Detailed Description

A class which provides a thin wrapper around an OpenMC Filter for the purposes of adding a tally via the MOOSE input syntax. This class does not need init / reset functions as non-spatial tallies don't change during simulation execution (at the moment).

The filter system should NOT wrap spatial filters as the problem geometry (through the MoabSkinner) will change during execution. The OpenMC -> MOOSE mesh data transfer also prevents the use of spatial filters in this system. Create a new tally object if a different spatial filter is required.

Constructor & Destructor Documentation

FilterBase()

FilterBase::FilterBase

(

const InputParameters &

parameters

)

Member Function Documentation

binName()

virtual std::string FilterBase::binName ( unsigned int  bin_index ) const

pure virtual

A function which returns the short-form name for each bin of this filter. Used to label auxvariables a TallyBase scores in. Each derived filter must override this function.

Parameters

[in]

the

bin index

Returns

a short name for the bin represented by bin_index

Implemented in SphericalHarmonicsFilter, AngularLegendreFilter, EnergyFilter, EnergyOutFilter, AzimuthalAngleFilter, FromXMLFilter, PolarAngleFilter, and ParticleFilter.

getWrappedFilter()

openmc::Filter* FilterBase::getWrappedFilter

(

)

Get the OpenMC filter that this object wraps.

Returns

the OpenMC filter object

numBins()

int FilterBase::numBins ( ) const

inline

A function which gets the number of bins in the wrapped filter.

Returns

the number of bins in the filter

skipBin()

virtual bool FilterBase::skipBin ( const unsigned int  bin ) const

inlinevirtual

Whether a specific bin should be skipped when computing sums and means for normalization. This is useful for functional expansion filters, where not all bins represent an average.

Parameters

[in]

bin

the filter bin

Returns

whether the bin should be skipped.

Reimplemented in AngularLegendreFilter, and SphericalHarmonicsFilter.

validParams()

static InputParameters FilterBase::validParams ( )

static

Member Data Documentation

_filter

openmc::Filter* FilterBase::_filter = nullptr

protected

The OpenMC filter this class wraps.

_filter_index

unsigned int FilterBase::_filter_index

protected

The index of the OpenMC filter this class wraps.

_openmc_problem

OpenMCCellAverageProblem& FilterBase::_openmc_problem

protected

The OpenMCCellAverageProblem using the tally system.

---

The documentation for this class was generated from the following file:

• include/filters/FilterBase.h