AddVariableAction

under construction:Undocumented Class

The AddVariableAction has not been documented. The content contained on this page 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.

!syntax description /Variables/AddVariableAction

Input Parameters

  • 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

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

  • initial_conditionSpecifies the initial condition for this variable

    C++ Type:double

    Options:

    Description:Specifies the initial condition for this variable

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

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

    Default:__all__

    C++ Type:std::vector

    Options:

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

  • 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

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

  • blockThe block id where this variable lives

    C++ Type:std::vector

    Options:

    Description:The block id where this variable lives

Optional Parameters

  • scaling1Specifies a scaling factor to apply to this variable

    Default:1

    C++ Type:double

    Options:

    Description:Specifies a scaling factor to apply to this variable

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • eigenFalseTrue to make this variable an eigen variable

    Default:False

    C++ Type:bool

    Options:

    Description:True to make this variable an eigen variable

Advanced Parameters

References