PolycrystalElasticDrivingForceAction

construction:Undocumented Action Class

The PolycrystalElasticDrivingForceAction 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 elastic driving force for each order parameter

Overview

Example Input File Syntax

Action that adds the elastic driving force for each order parameter

Input Parameters

op_numspecifies the number of grains to create
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:specifies the number of grains 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

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
base_nameOptional parameter that allows the user to define multiple mechanics material systems on the same block, i.e. for multiple phases
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Optional parameter that allows the user to define multiple mechanics material systems on the same block, i.e. for multiple phases
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