Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

PolycrystalVariablesAction

under construction:Undocumented Action Class

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


# PolycrystalVariablesAction

!syntax description /Variables/PolycrystalVariables/PolycrystalVariablesAction

## Overview

!! Replace these lines with information regarding the PolycrystalVariablesAction action.

## Example Input File Syntax

!! Describe and include an example of how to use the PolycrystalVariablesAction action.

!syntax parameters /Variables/PolycrystalVariables/PolycrystalVariablesAction

Set up order parameter variables for a polycrystal simulation

Input Parameters

  • op_numspecifies the number of order parameters to create

    C++ Type:unsigned int

    Options:

    Description:specifies the number of order parameters to create

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    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

    Options:

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

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

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

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • 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

  • 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

  • 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

Optional Parameters