AddPrimarySpeciesAction

buildconstruction:Undocumented Action Class

The AddPrimarySpeciesAction 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.

Adds Variables for all primary species

Overview

Example Input File Syntax

Adds Variables for all primary species

Input Parameters

  • primary_speciesThe list of primary variables to add

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

    Controllable:No

    Description:The list of primary variables to add

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

  • 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.

  • 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.

  • initial_conditionSpecifies a constant initial condition for this variable

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

    Controllable:No

    Description:Specifies a constant initial condition for this variable

  • 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)

  • scalingSpecifies a scaling factor to apply to this variable

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

    Controllable:No

    Description:Specifies a scaling factor to apply to this variable

Optional Parameters

  • isObjectActionTrueIndicates that this is a MooseObjectAction.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Indicates that this is a MooseObjectAction.

Advanced Parameters