Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ComputeDiffusionCoeffMGAux Class Reference

#include <ComputeDiffusionCoeffMGAux.h>

Inheritance diagram for ComputeDiffusionCoeffMGAux:
[legend]

Public Member Functions

 ComputeDiffusionCoeffMGAux (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeValue () override
 
bool mappedElement ()
 
std::string getScore (const std::string &score_param)
 
std::string tallyByScore (const std::string &score, const std::string &tally_param)
 
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 Real & _void_diff
 The value the diffusion coefficient should take in a void region. More...
 
const VariableValue & _total_rxn_rate
 The group-wise total reaction rate for computing the MG diffusion coefficient. More...
 
std::vector< const VariableValue * > _p1_scattering_rates
 The group-wise P1 scattering reaction rates for computing the MG diffusion coefficient. More...
 
const VariableValue & _scalar_flux
 The group-wise scalar flux for computing the MG diffusion coefficient. More...
 
OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...
 

Detailed Description

This auxkernel computes multi-group particle diffusion coefficients given a group-wise total reaction rate, the outgoing sum of group-wise P1 scattering reaction rates, and the group-wise scalar flux.

Constructor & Destructor Documentation

◆ ComputeDiffusionCoeffMGAux()

ComputeDiffusionCoeffMGAux::ComputeDiffusionCoeffMGAux ( const InputParameters &  parameters)

Member Function Documentation

◆ computeValue()

virtual Real ComputeDiffusionCoeffMGAux::computeValue ( )
overrideprotectedvirtual

◆ getScore()

std::string TallyInterface::getScore ( const std::string &  score_param)
protectedinherited

Get the score given a parameter name which points to a MooseEnum parameter. This checks to ensure that the score is valid (at least one tally is accumulating it).

Parameters
[in]score_paramthe name of the input parameter holding the score
Returns
the valid score

◆ kMean()

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

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

Parameters
[in]estimatortype 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]estimatortype of estimator
Returns
the standard deviation of the k-eigenvalue

◆ mappedElement()

template<typename ComputeValueType >
bool OpenMCAuxKernelTempl< ComputeValueType >::mappedElement ( )
protectedinherited

Determine whether the MOOSE element maps to an OpenMC cell to make sure we don't call accessor methods that rely on valid values for the cell instance and index

Returns
whether element maps to OpenMC

◆ stdev()

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

Compute standard deviation of a variable

Parameters
[in]meanmean
[in]sum_sqsum squared
[in]realizationsthe number of realizations of the variable
Returns
standard deviation

◆ tallyByScore()

std::string TallyInterface::tallyByScore ( const std::string &  score,
const std::string &  tally_param 
)
protectedinherited

Fetch a tally name by the score and the tally param in the input parameters. This checks the tally to ensure it is valid for the given score. If the parameter 'tally_param' is not valid and only one tally object accumulates 'score', this function returns the name of that tally.

Parameters
[in]scorethe score which the tally should be accumulating
[in]tally_paramthe parameter name in the input parameters for '_object' which contains the name of a tally.
Returns
the name of the tally which can be used to fetch score variables

◆ validParams()

static InputParameters ComputeDiffusionCoeffMGAux::validParams ( )
static

Member Data Documentation

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _p1_scattering_rates

std::vector<const VariableValue *> ComputeDiffusionCoeffMGAux::_p1_scattering_rates
protected

The group-wise P1 scattering reaction rates for computing the MG diffusion coefficient.

◆ _scalar_flux

const VariableValue& ComputeDiffusionCoeffMGAux::_scalar_flux
protected

The group-wise scalar flux for computing the MG diffusion coefficient.

◆ _total_rxn_rate

const VariableValue& ComputeDiffusionCoeffMGAux::_total_rxn_rate
protected

The group-wise total reaction rate for computing the MG diffusion coefficient.

◆ _void_diff

const Real& ComputeDiffusionCoeffMGAux::_void_diff
protected

The value the diffusion coefficient should take in a void region.


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