PolycrystalVariablesAction

under construction:Undocumented Class

The PolycrystalVariablesAction 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 order parameter variables for a polycrystal simulation

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • op_numspecifies the number of order parameters to create

    C++ Type:unsigned int

    Options:

    Description:specifies the number of order parameters to create

Required Parameters

  • familyLAGRANGESpecifies the family of FE shape function to use for the order parameters

    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 function to use for the order parameters

  • initial_from_fileFalseTake the initial condition of all polycrystal variables from the mesh file

    Default:False

    C++ Type:bool

    Options:

    Description:Take the initial condition of all polycrystal variables from the mesh file

  • 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

  • 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 the order parameters

    Default:FIRST

    C++ Type:MooseEnum

    Options:CONSTANT FIRST SECOND THIRD FOURTH

    Description:Specifies the order of the FE shape function to use for the order parameters

Optional Parameters

References