MultiAuxVariablesAction

under construction:Undocumented Class

The MultiAuxVariablesAction has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with an action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Set up auxvariables for components of MaterialProperty > for polycrystal sample.

Input Parameters

  • grain_numSpecifies the number of grains to create the aux varaivles for.

    C++ Type:unsigned int

    Options:

    Description:Specifies the number of grains to create the aux varaivles for.

  • data_typeRealSpecifying data type of the materials property, variables are created accordingly

    Default:Real

    C++ Type:MultiMooseEnum

    Options:Real RealGradient

    Description:Specifying data type of the materials property, variables are created accordingly

  • variable_baseVector that specifies the base name of the variables.

    C++ Type:std::vector

    Options:

    Description:Vector that specifies the base name of the variables.

Required Parameters

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

    Default:LAGRANGE

    C++ Type:MooseEnum

    Options:LAGRANGE MONOMIAL SCALAR

    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 FIFTH SIXTH SEVENTH EIGHTH NINTH

    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

  • 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

Advanced Parameters

References