GrainGrowthAction

buildconstruction:Undocumented Action Class

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

Set up the variable and the kernels needed for a grain growth simulation

Overview

Example Input File Syntax

Set up the variable and the kernels needed for a grain growth simulation

Input Parameters

  • op_numspecifies the number of order parameters to create

    C++ Type:unsigned int

    Controllable:No

    Description:specifies the number of order parameters to create

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Controllable:No

    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<std::string>

    Controllable:No

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

  • argsVector of nonlinear variable arguments that L depends on

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

    Controllable:No

    Description:Vector of nonlinear variable arguments that L depends on

  • 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, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

    Controllable:No

    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<std::string>

    Controllable:No

    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

    Controllable:No

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

  • kappakappa_opThe kappa used with the kernels

    Default:kappa_op

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:The kappa used with the kernels

  • mobilityLThe isotropic mobility used with the kernels

    Default:L

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:The isotropic mobility used with the kernels

  • 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

    Controllable:No

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

  • use_automatic_differentiationFalseFlag to use automatic differentiation (AD) objects when possible

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Flag to use automatic differentiation (AD) objects when possible

  • variable_mobilityTrueThe mobility is a function of any MOOSE variable (if this is set to false, L must be constant over the entire domain!)

    Default:True

    C++ Type:bool

    Controllable:No

    Description:The mobility is a function of any MOOSE variable (if this is set to false, L must be constant over the entire domain!)

Optional Parameters

  • cName of coupled concentration variable

    C++ Type:VariableName

    Controllable:No

    Description:Name of coupled concentration variable

  • en_ratio1Ratio of surface to GB energy

    Default:1

    C++ Type:double

    Controllable:No

    Description:Ratio of surface to GB energy

  • ndef0Specifies the number of deformed grains to create

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:Specifies the number of deformed grains to create

Multiphysics Parameters

  • implicitTrueWhether kernels are implicit or not

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether kernels are implicit or not

  • scaling1Specifies a scaling factor to apply to the order parameters

    Default:1

    C++ Type:double

    Controllable:No

    Description:Specifies a scaling factor to apply to the order parameters

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to use displaced mesh in the kernels

Advanced Parameters