PolycrystalElasticDrivingForceAction

under construction:Undocumented Class

The PolycrystalElasticDrivingForceAction has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical 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 addes the elastic driving force for each order parameter

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Description:specifies the base name of the variables

  • op_numspecifies the number of grains to create

    C++ Type:unsigned int

    Description:specifies the number of grains to create

Required 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

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

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

  • 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

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels

    Default:False

    C++ Type:bool

    Description:Whether to use displaced mesh in the kernels

Optional Parameters

References