- op_numspecifies the number of grains to create
C++ Type:unsigned int
Description:specifies the number of grains to create
- var_name_basespecifies the base name of the variables
C++ Type:std::string
Description:specifies the base name of the variables
PolycrystalElasticDrivingForceAction
under 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.
# PolycrystalElasticDrivingForceAction
!syntax description /Kernels/PolycrystalElasticDrivingForce/PolycrystalElasticDrivingForceAction
## Overview
!! Replace these lines with information regarding the PolycrystalElasticDrivingForceAction action.
## Example Input File Syntax
!! Describe and include an example of how to use the PolycrystalElasticDrivingForceAction action.
!syntax parameters /Kernels/PolycrystalElasticDrivingForce/PolycrystalElasticDrivingForceAction
Action that addes the elastic driving force for each order parameter
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector
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
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
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
Description:Whether to use displaced mesh in the kernels