#include <OpenMCTallyEditor.h>

Inheritance diagram for OpenMCTallyEditor:

Public Member Functions
	OpenMCTallyEditor (const InputParameters &parameters)

bool	tallyExists () const

int32_t	tallyIndex () const

virtual void	execute () override

virtual void	initialize () override

virtual void	finalize () override

void	duplicateTallyError (const int32_t &id) const

void	mappedTallyError (const int32_t &id) const

int32_t	tallyId () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const int32_t &	_tally_id
	Tally ID to modify.

OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

Detailed Description

User object to modify an OpenMC tally

Constructor & Destructor Documentation

◆ OpenMCTallyEditor()

OpenMCTallyEditor::OpenMCTallyEditor ( const InputParameters & parameters )

Member Function Documentation

◆ duplicateTallyError()

void OpenMCTallyEditor::duplicateTallyError ( const int32_t & id ) const

Error to throw if multiple tally editor objects have the same tally id

Parameters

[in] id ID to use in error message

◆ execute()

virtual void OpenMCTallyEditor::execute ( )

overridevirtual

◆ finalize()

virtual void OpenMCTallyEditor::finalize ( )

inlineoverridevirtual

◆ initialize()

virtual void OpenMCTallyEditor::initialize ( )

inlineoverridevirtual

◆ mappedTallyError()

void OpenMCTallyEditor::mappedTallyError ( const int32_t & id ) const

Error to throw if tally editor is trying to edit a tally Cardinal is controlling for multiphysics

Parameters

[in] id ID to use in error message

◆ tallyExists()

bool OpenMCTallyEditor::tallyExists ( ) const

◆ tallyId()

int32_t OpenMCTallyEditor::tallyId ( ) const

inline

Get the tally ID

Returns: tally ID

◆ tallyIndex()

int32_t OpenMCTallyEditor::tallyIndex ( ) const

Get the index of the tally in OpenMC's data space, creating it if necessary

Returns: tally index

◆ validParams()

static InputParameters OpenMCTallyEditor::validParams ( )

static

Member Data Documentation

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _tally_id

const int32_t& OpenMCTallyEditor::_tally_id

protected

Tally ID to modify.

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

include/userobjects/OpenMCTallyEditor.h

Public Member Functions

Static Public Member Functions

Protected Attributes