Loading [MathJax]/extensions/tex2jax.js
Cardinal
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SetupMGXSAction Class Reference

#include <SetupMGXSAction.h>

Inheritance diagram for SetupMGXSAction:
[legend]

Public Member Functions

 SetupMGXSAction (const InputParameters &parameters)
 
virtual void act () override
 
bool addingCellTallies () const
 
std::vector< double > getGroupBoundaries (energyfilter::GroupStructureEnum group_structure)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

OpenMCCellAverageProblemopenmcProblem ()
 
void addFilters ()
 A function to add the filters necessary for MGXS generation. More...
 
void addTallies ()
 A function to add the tallies necessary for MGXS generation. More...
 
void addAuxVars ()
 A function which adds auxvariables that store the computed MGXS. More...
 
void addAuxKernels ()
 A function which adds auxkernels that compute the MGXS. More...
 
void modifyOutputs ()
 Modify outputs to hide tally variables used to generate MGXS in outputs. More...
 
virtual void setObjectBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks)
 

Protected Attributes

const tally::TallyTypeEnum _t_type
 The tally type to add. More...
 
const MooseEnum _particle
 The particle to filter for when generating cross sections. More...
 
MooseEnum _estimator
 The estimator to use when generating multi-group cross sections. More...
 
const bool _add_scattering
 
const unsigned int _l_order
 The Legendre order. More...
 
bool _transport_correction
 Whether a P0 transport correction should be applied to isotropic scattering cross sections. More...
 
const bool _add_fission
 Whether or not group-wise nu-fission MGXS should be computed. More...
 
const bool _add_kappa_fission
 Whether or not group-wise kappa-fission values should be computed. More...
 
const bool _add_inv_vel
 Whether or not group-wise inverse velocity values should be computed. More...
 
const bool _add_diffusion
 Whether or not group-wise diffusion coefficients should be computed. More...
 
const bool _add_absorption
 Whether or not group-wise absorption MGXS should be computed. More...
 
const bool _hide_tally_vars
 Whether tally variables should be hidden. More...
 
std::vector< const TallyBase * > _mgxs_tallies
 A list of tallies added by this action. More...
 
bool _need_p1_scatter
 Whether or not scattering reaction rates need to be at least order P1. More...
 
std::vector< SubdomainName > _blocks
 subdomains to which this action applies More...
 
std::vector< Real > _energy_bnds
 The energy bounds used to build bins. More...
 
const bool _reverse_bins
 Whether or not to reverse the ordering of energy bins during output. More...
 

Constructor & Destructor Documentation

◆ SetupMGXSAction()

SetupMGXSAction::SetupMGXSAction ( const InputParameters &  parameters)

Member Function Documentation

◆ act()

virtual void SetupMGXSAction::act ( )
overridevirtual

◆ addAuxKernels()

void SetupMGXSAction::addAuxKernels ( )
protected

A function which adds auxkernels that compute the MGXS.

◆ addAuxVars()

void SetupMGXSAction::addAuxVars ( )
protected

A function which adds auxvariables that store the computed MGXS.

◆ addFilters()

void SetupMGXSAction::addFilters ( )
protected

A function to add the filters necessary for MGXS generation.

◆ addingCellTallies()

bool SetupMGXSAction::addingCellTallies ( ) const
inline

◆ addTallies()

void SetupMGXSAction::addTallies ( )
protected

A function to add the tallies necessary for MGXS generation.

◆ getGroupBoundaries()

std::vector<double> EnergyBinBase::getGroupBoundaries ( energyfilter::GroupStructureEnum  group_structure)
inherited

A function which converts a GroupStructureEnum into the vector representation of the group structure.

Parameters
[in]structurethe requested group structure
Returns
the energy gruop boundaries

◆ modifyOutputs()

void SetupMGXSAction::modifyOutputs ( )
protected

Modify outputs to hide tally variables used to generate MGXS in outputs.

◆ openmcProblem()

OpenMCCellAverageProblem* SetupMGXSAction::openmcProblem ( )
protected

A function to cast the FEProblem to an OpenMCCellAverageProblem

Returns
a pointer to the OpenMCCellAverageProblem

◆ setObjectBlocks()

void CardinalAction::setObjectBlocks ( InputParameters &  params,
const std::vector< SubdomainName > &  blocks 
)
protectedvirtualinherited

Set the blocks to which an object created by this action applies

Parameters
[in]paramsinput parameters
[in]blocksblock that the object applies to

◆ validParams()

static InputParameters SetupMGXSAction::validParams ( )
static

Member Data Documentation

◆ _add_absorption

const bool SetupMGXSAction::_add_absorption
protected

Whether or not group-wise absorption MGXS should be computed.

◆ _add_diffusion

const bool SetupMGXSAction::_add_diffusion
protected

Whether or not group-wise diffusion coefficients should be computed.

◆ _add_fission

const bool SetupMGXSAction::_add_fission
protected

Whether or not group-wise nu-fission MGXS should be computed.

◆ _add_inv_vel

const bool SetupMGXSAction::_add_inv_vel
protected

Whether or not group-wise inverse velocity values should be computed.

◆ _add_kappa_fission

const bool SetupMGXSAction::_add_kappa_fission
protected

Whether or not group-wise kappa-fission values should be computed.

◆ _add_scattering

const bool SetupMGXSAction::_add_scattering
protected

Whether or not group-wise scattering cross sections for the scattering matrix should be computed.

◆ _blocks

std::vector<SubdomainName> CardinalAction::_blocks
protectedinherited

subdomains to which this action applies

◆ _energy_bnds

std::vector<Real> EnergyBinBase::_energy_bnds
protectedinherited

The energy bounds used to build bins.

◆ _estimator

MooseEnum SetupMGXSAction::_estimator
protected

The estimator to use when generating multi-group cross sections.

◆ _hide_tally_vars

const bool SetupMGXSAction::_hide_tally_vars
protected

Whether tally variables should be hidden.

◆ _l_order

const unsigned int SetupMGXSAction::_l_order
protected

The Legendre order.

◆ _mgxs_tallies

std::vector<const TallyBase *> SetupMGXSAction::_mgxs_tallies
protected

A list of tallies added by this action.

◆ _need_p1_scatter

bool SetupMGXSAction::_need_p1_scatter
protected

Whether or not scattering reaction rates need to be at least order P1.

◆ _particle

const MooseEnum SetupMGXSAction::_particle
protected

The particle to filter for when generating cross sections.

◆ _reverse_bins

const bool EnergyBinBase::_reverse_bins
protectedinherited

Whether or not to reverse the ordering of energy bins during output.

◆ _t_type

const tally::TallyTypeEnum SetupMGXSAction::_t_type
protected

The tally type to add.

◆ _transport_correction

bool SetupMGXSAction::_transport_correction
protected

Whether a P0 transport correction should be applied to isotropic scattering cross sections.


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