PolycrystalStoredEnergyAction

buildconstruction:Undocumented Action Class

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

Action that adds the contribution of stored energy associated with dislocations to grain growth models

Overview

Example Input File Syntax

Action that adds the contribution of stored energy associated with dislocations to grain growth models

Input Parameters

  • deformed_grain_numspecifies the number of deformed grains to create

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:specifies the number of deformed grains to create

  • grain_trackerThe GrainTracker UserObject to get values from.

    C++ Type:UserObjectName

    Unit:(no unit assumed)

    Controllable:No

    Description:The GrainTracker UserObject to get values from.

  • op_numspecifies the total number of OPs representing all grains (deformed + undeformed (recrystallized)) to create

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:specifies the total number of OPs representing all grains (deformed + undeformed (recrystallized)) to create

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:specifies the base name of the variables

Required Parameters

  • TName of temperature variable

    C++ Type:VariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of temperature variable

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

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

    Unit:(no unit assumed)

    Controllable:No

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

  • cName of coupled concentration variable

    C++ Type:VariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of coupled concentration variable

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Unit:(no unit assumed)

    Controllable:No

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

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether to use displaced mesh in the kernels

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters