OpenMCInitAction Class Reference

#include <OpenMCInitAction.h>

Inheritance diagram for OpenMCInitAction:

Public Member Functions
	OpenMCInitAction (const InputParameters &parameters)
virtual void	act () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
bool	isOpenMCCellAverageProblemRequested (std::string &xml_directory, Real &scaling) const
bool	isOpenMCMeshGeneratorRequested (std::string &xml_directory, Real &scaling) const
void	initOpenMC (const std::string &xml_directory)

Detailed Description

Initialize OpenMC.

Constructor & Destructor Documentation

OpenMCInitAction()

OpenMCInitAction::OpenMCInitAction

(

const InputParameters &

parameters

)

Member Function Documentation

act()

virtual void OpenMCInitAction::act ( )

overridevirtual

initOpenMC()

void OpenMCInitAction::initOpenMC ( const std::string &  xml_directory )

protected

Call the OpenMC initialization handle

Parameters

[in]

xml_directory

directory in which OpenMC settings xml files are located

isOpenMCCellAverageProblemRequested()

bool OpenMCInitAction::isOpenMCCellAverageProblemRequested ( std::string &  xml_directory, Real &  scaling  ) const

protected

Check whether an OpenMCCellAverageProblem have been requested in the input file and returns the associated path to the XML directory if an OpenMCCellAverageProblem is present in the input file.

Parameters

[out]	xml_directory	directory in which OpenMC settings xml files are located
[out]	scaling	scaling factor for OpenMC

Returns

whether an OpenMCCellAverageProblem have been requested in the input file

isOpenMCMeshGeneratorRequested()

bool OpenMCInitAction::isOpenMCMeshGeneratorRequested ( std::string &  xml_directory, Real &  scaling  ) const

protected

Check whether an OpenMCMeshGenerator have been requested in the input file and returns the associated path to the XML directory if an OpenMCMeshGenerator is present in the input file.

If multiple OpenMCMeshGenerators are requested but the xml_directory values are not exactly the same, it returns an error because we cannot initialize OpenMC more than once. Additionally, the scaling factor should be the same for all instances of OpenMCMeshGenerators or an error will be raised.

Parameters

[out]	xml_directory	directory in which OpenMC settings xml files are located
[out]	scaling	scaling factor for OpenMC

Returns

whether an OpenMCMeshGenerator have been requested in the input file

validParams()

static InputParameters OpenMCInitAction::validParams ( )

static

---

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

• include/actions/OpenMCInitAction.h