OpenMCWallTime Class Reference

#include <OpenMCWallTime.h>

Inheritance diagram for OpenMCWallTime:

Public Member Functions
	OpenMCWallTime (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual Real	getValue () const override
	CreateMooseEnumClass (OpenMCTime, initialization_time=0, total_simulation_time=1, transport_time=2, inactive_batch_time=3, active_batch_time=4, fission_bank_time=5, tally_accumulation_time=6, finalization_time=7, total_elapsed_time=8)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
Real	stdev (const double &mean, const double &sum_sq, unsigned int realizations) const
Real	kMean (const eigenvalue::EigenvalueEnum estimator) const
Real	kStandardDeviation (const eigenvalue::EigenvalueEnum estimator) const

Protected Attributes
const bool &	_accumulate_time
	Whether the simulation time should be accumulated or not. More...
const OpenMCTime	_openmc_time
	The type of time to report from OpenMC. More...
Real	_walltime
	The accumulate or step walltime. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

OpenMCWallTime is a post-processsor that returns the OpenMC wall time. This is one of several options at present:

1. Total time spent during initialization;
2. Total time spent running a simulation;
3. Total time running transport;
4. Total time running inactive batches;
5. Total time running active batches;
6. Total time synchronizing the fission bank;
7. Total time accumulating tallies;
8. Total time spent in finalization;
9. Total time elapsed. The accumulated time (over all time steps / adaptivity steps / Picard iterations) is returned by default to facilitate the computation of figures of merit. This behaviour can be adjusted to return the wall time for a single simulation, if desired.

Constructor & Destructor Documentation

OpenMCWallTime()

OpenMCWallTime::OpenMCWallTime

(

const InputParameters &

parameters

)

Member Function Documentation

CreateMooseEnumClass()

OpenMCWallTime::CreateMooseEnumClass	(	OpenMCTime	,
		initialization_time	= 0,
		total_simulation_time	= 1,
		transport_time	= 2,
		inactive_batch_time	= 3,
		active_batch_time	= 4,
		fission_bank_time	= 5,
		tally_accumulation_time	= 6,
		finalization_time	= 7,
		total_elapsed_time	= 8
	)

Declare the OpenMCTime enum. These will correspond 1 to 1 to the enums used in the input file.

execute()

virtual void OpenMCWallTime::execute ( )

overridevirtual

getValue()

virtual Real OpenMCWallTime::getValue ( ) const

overridevirtual

initialize()

virtual void OpenMCWallTime::initialize ( )

inlineoverridevirtual

kMean()

Real OpenMCBase::kMean ( const eigenvalue::EigenvalueEnum  estimator ) const

protectedinherited

A function which computes the mean value of \(k_{eff}\).

Parameters

[in]

estimator

type of estimator

Returns

the mean value of the k-eigenvalue

kStandardDeviation()

Real OpenMCBase::kStandardDeviation ( const eigenvalue::EigenvalueEnum  estimator ) const

protectedinherited

A function which computes the standard deviation of \(k_{eff}\).

Parameters

[in]

estimator

type of estimator

Returns

the standard deviation of the k-eigenvalue

stdev()

Real OpenMCBase::stdev ( const double &  mean, const double &  sum_sq, unsigned int  realizations  ) const

protectedinherited

Compute standard deviation of a variable

Parameters

[in]	mean	mean
[in]	sum_sq	sum squared
[in]	realizations	the number of realizations of the variable

Returns

standard deviation

validParams()

static InputParameters OpenMCWallTime::validParams ( )

static

Member Data Documentation

_accumulate_time

const bool& OpenMCWallTime::_accumulate_time

protected

Whether the simulation time should be accumulated or not.

_openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

_openmc_time

const OpenMCTime OpenMCWallTime::_openmc_time

protected

The type of time to report from OpenMC.

_walltime

Real OpenMCWallTime::_walltime

protected

The accumulate or step walltime.

---

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

• include/postprocessors/OpenMCWallTime.h