PolycrystalStoredEnergyAction

under construction: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.


# PolycrystalStoredEnergyAction

!syntax description /Kernels/PolycrystalStoredEnergy/PolycrystalStoredEnergyAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Kernels/PolycrystalStoredEnergy/PolycrystalStoredEnergyAction

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

    Options:

    Description:specifies the number of deformed grains to create

  • grain_trackerThe GrainTracker UserObject to get values from.

    C++ Type:UserObjectName

    Options:

    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

    Options:

    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

    Options:

    Description:specifies the base name of the variables

Required Parameters

  • TName of temperature variable

    C++ Type:VariableName

    Options:

    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

    Options:

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

  • cName of coupled concentration variable

    C++ Type:VariableName

    Options:

    Description:Name of coupled concentration 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.

  • 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

Optional Parameters