ParticleFilter Class Reference

#include <ParticleFilter.h>

Inheritance diagram for ParticleFilter:

Public Member Functions
	ParticleFilter (const InputParameters &parameters)
virtual std::string	binName (unsigned int bin_index) const override
virtual bool	skipBin (const unsigned int bin) const
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...

Constructor & Destructor Documentation

ParticleFilter()

ParticleFilter::ParticleFilter

(

const InputParameters &

parameters

)

Member Function Documentation

binName()

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

overridevirtual

A function which returns the short-form name for each bin of this filter. Used to label auxvariables a TallyBase scores in. ParticleFilter(s) uses different names depending on the particle.

Parameters

[in]

the

bin index

Returns

a short name for the bin represented by bin_index

Implements FilterBase.

getWrappedFilter()

openmc::Filter* FilterBase::getWrappedFilter ( )

inherited

Get the OpenMC filter that this object wraps.

Returns

the OpenMC filter object

numBins()

int FilterBase::numBins ( ) const

inlineinherited

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

inlinevirtualinherited

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 ParticleFilter::validParams ( )

static

Member Data Documentation

_filter

openmc::Filter* FilterBase::_filter = nullptr

protectedinherited

The OpenMC filter this class wraps.

_filter_index

unsigned int FilterBase::_filter_index

protectedinherited

The index of the OpenMC filter this class wraps.

_openmc_problem

OpenMCCellAverageProblem& FilterBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem using the tally system.

---

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

• include/filters/ParticleFilter.h