Cardinal
Loading...
Searching...
No Matches
FoMAux.h
Go to the documentation of this file.
1/********************************************************************/
2/* SOFTWARE COPYRIGHT NOTIFICATION */
3/* Cardinal */
4/* */
5/* (c) 2021 UChicago Argonne, LLC */
6/* ALL RIGHTS RESERVED */
7/* */
8/* Prepared by UChicago Argonne, LLC */
9/* Under Contract No. DE-AC02-06CH11357 */
10/* With the U. S. Department of Energy */
11/* */
12/* Prepared by Battelle Energy Alliance, LLC */
13/* Under Contract No. DE-AC07-05ID14517 */
14/* With the U. S. Department of Energy */
15/* */
16/* See LICENSE for full restrictions */
17/********************************************************************/
18
19#pragma once
20
21#include "OpenMCAuxKernel.h"
22
32class FoMAux : public OpenMCAuxKernel
33{
34public:
35 static InputParameters validParams();
36
37 FoMAux(const InputParameters & parameters);
38
39protected:
40 virtual Real computeValue() override;
41
43 const VariableValue * _tally_val;
44
46 const VariableValue * _tally_val_init;
47
49 const VariableValue & _tally_val_rel_err;
50
52 const Real & _sim_time;
53
55 const enum class FoMType { VR = 0, AMR = 1 } _fom_type;
56};
Definition FoMAux.h:33
const Real & _sim_time
The simulation time. Used for both FoMs.
Definition FoMAux.h:52
const VariableValue & _tally_val_rel_err
The statistical relative error of the tally. Used for both FoMs.
Definition FoMAux.h:49
const VariableValue * _tally_val_init
A variable containing the initial value of the tally. Used for the AMR FoM.
Definition FoMAux.h:46
static InputParameters validParams()
enum FoMAux::FoMType _fom_type
FoMType
The type of FoM to compute.
Definition FoMAux.h:55
FoMAux(const InputParameters &parameters)
const VariableValue * _tally_val
The variable containing the tally. Used for the AMR FoM.
Definition FoMAux.h:43
virtual Real computeValue() override
Definition OpenMCAuxKernel.h:39