PolycrystalKernelAction

buildconstruction:Undocumented Action Class

The PolycrystalKernelAction 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 ACGrGrPoly, ACInterface, TimeDerivative, and ACGBPoly kernels

Overview

Example Input File Syntax

Set up ACGrGrPoly, ACInterface, TimeDerivative, and ACGBPoly kernels

Input Parameters

  • op_numspecifies the total number of grains (deformed + recrystallized) to create

    C++ Type:unsigned int

    Options:

    Description:specifies the total number of grains (deformed + recrystallized) 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<std::string>

    Options:

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

  • argsVector of variable arguments L depends on

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

    Options:

    Description:Vector of variable arguments L depends on

  • cName of coupled concentration variable

    C++ Type:VariableName

    Options:

    Description:Name of coupled concentration variable

  • en_ratio1Ratio of surface to GB energy

    Default:1

    C++ Type:double

    Options:

    Description:Ratio of surface to GB energy

  • implicitTrueWhether kernels are implicit or not

    Default:True

    C++ Type:bool

    Options:

    Description:Whether kernels are implicit or not

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Options:

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

  • ndef0specifies the number of deformed grains to create

    Default:0

    C++ Type:unsigned int

    Options:

    Description:specifies the number of deformed grains to create

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels

    Default:False

    C++ Type:bool

    Options:

    Description:Whether to use displaced mesh in the kernels

  • 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

    Options:

    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