PrecursorAction

buildconstruction:Undocumented Action Class

The PrecursorAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Overview

Example Input File Syntax

Input Parameters

  • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

  • loop_precursorsFalseWhether precursors are circulated in coolant loop.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether precursors are circulated in coolant loop.

  • num_groupsThe total number of energy groups.

    C++ Type:unsigned int

    Controllable:No

    Description:The total number of energy groups.

  • num_precursor_groupsspecifies the total number of precursors to create

    C++ Type:unsigned int

    Controllable:No

    Description:specifies the total number of precursors to create

  • outlet_boundariesOutflow boundaries.

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:Outflow boundaries.

  • temperatureName of temperature variable

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Name of temperature variable

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Controllable:No

    Description:specifies the base name of the variables

Required Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:If specified only the blocks named will be visited and made active

  • blockThe block id where this variable lives

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The block id where this variable lives

  • constant_velocity_valuesTrueWhether the velocity components are constant with respect to space

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether the velocity components are constant with respect to space

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • create_varsTrueWhether this action should create the variables.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether this action should create the variables.

  • eigenFalsewhether neutronics is in eigenvalue calculation mode

    Default:False

    C++ Type:bool

    Controllable:No

    Description:whether neutronics is in eigenvalue calculation mode

  • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

    Default:1

    C++ Type:double

    Controllable:No

    Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

  • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

    Default:LAGRANGE

    C++ Type:MooseEnum

    Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

    Controllable:No

    Description:Specifies the family of FE shape functions to use for this variable

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • init_from_fileFalseWhether to initialize the precursors from a file.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to initialize the precursors from a file.

  • inlet_boundariesInflow boundaries.

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:Inflow boundaries.

  • is_loopappFalseif circulating precursors, whether this is loop app

    Default:False

    C++ Type:bool

    Controllable:No

    Description:if circulating precursors, whether this is loop app

  • jac_testFalseWhether we're testing the Jacobian and should use some random initial conditions for the precursors.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether we're testing the Jacobian and should use some random initial conditions for the precursors.

  • kernel_blockOptional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:Optional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

  • multi_appMultiapp name for looping precursors.

    C++ Type:MultiAppName

    Controllable:No

    Description:Multiapp name for looping precursors.

  • nt_exp_formFalseWhether concentrations should be in an expotential/logarithmic format.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether concentrations should be in an expotential/logarithmic format.

  • object_suffixAn optional suffix string that can be helpful to avoid object name crashing.

    C++ Type:std::string

    Controllable:No

    Description:An optional suffix string that can be helpful to avoid object name crashing.

  • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

    Default:FIRST

    C++ Type:MooseEnum

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

    Controllable:No

    Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

  • outlet_velName of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:Name of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

  • scaling1Specifies a scaling factor to apply to this variable

    Default:1

    C++ Type:double

    Controllable:No

    Description:Specifies a scaling factor to apply to this variable

  • transientTrueWhether to run a transient simulation.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to run a transient simulation.

  • u_defAllows user to specify constant value for u component of velocity.

    C++ Type:double

    Controllable:No

    Description:Allows user to specify constant value for u component of velocity.

  • u_funcAllows user to specify function value for u component of velocity.

    C++ Type:FunctionName

    Controllable:No

    Description:Allows user to specify function value for u component of velocity.

  • uvelName of x-component of velocity

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:Name of x-component of velocity

  • v_defAllows user to specify constant value for v component of velocity.

    C++ Type:double

    Controllable:No

    Description:Allows user to specify constant value for v component of velocity.

  • v_funcAllows user to specify function value for v component of velocity.

    C++ Type:FunctionName

    Controllable:No

    Description:Allows user to specify function value for v component of velocity.

  • vvelName of y-component of velocity

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:Name of y-component of velocity

  • w_defAllows user to specify constant value for w component of velocity.

    C++ Type:double

    Controllable:No

    Description:Allows user to specify constant value for w component of velocity.

  • w_funcAllows user to specify function value for w component of velocity.

    C++ Type:FunctionName

    Controllable:No

    Description:Allows user to specify function value for w component of velocity.

  • wvelName of z-component of velocity

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:Name of z-component of velocity

Optional Parameters