RigidBodyMultiKernelAction

under construction:Undocumented Class

The RigidBodyMultiKernelAction has not been documented. The content contained on this page includes the basic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Action for applying AllenCahn equations and SingleGrainRigidBodyMotion to grains

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • grain_volumesThe feature volume VectorPostprocessorValue.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The feature volume VectorPostprocessorValue.

  • grain_tracker_objectThe FeatureFloodCount UserObject to get values from.

    C++ Type:UserObjectName

    Options:

    Description:The FeatureFloodCount UserObject to get values from.

  • op_numspecifies the number of grains to create

    C++ Type:unsigned int

    Options:

    Description:specifies the number of grains to create

  • grain_forceuserobject for getting force and torque acting on grains

    C++ Type:UserObjectName

    Options:

    Description:userobject for getting force and torque acting on grains

Required Parameters

  • mob_nameLThe mobility used with the kernel

    Default:L

    C++ Type:MaterialPropertyName

    Options:

    Description:The mobility used with the kernel

  • cName of coupled concentration variable

    C++ Type:VariableName

    Options:

    Description:Name of coupled concentration variable

  • rotation_constant1constant value characterizing grain rotation

    Default:1

    C++ Type:double

    Options:

    Description:constant value characterizing grain rotation

  • base_nameOptional parameter that allows the user to define type of force density under consideration

    C++ Type:std::string

    Options:

    Description:Optional parameter that allows the user to define type of force density under consideration

  • 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

  • f_nameBase name of the free energy function F defined in a DerivativeParsedMaterial

    C++ Type:MaterialPropertyName

    Options:

    Description:Base name of the free energy function F defined in a DerivativeParsedMaterial

  • kappa_namekappa_opThe kappa used with the kernel

    Default:kappa_op

    C++ Type:MaterialPropertyName

    Options:

    Description:The kappa used with the kernel

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • translation_constant500constant value characterizing grain translation

    Default:500

    C++ Type:double

    Options:

    Description:constant value characterizing grain translation

  • 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

  • implicitTrueWhether kernels are implicit or not

    Default:True

    C++ Type:bool

    Options:

    Description:Whether kernels are implicit or not

Optional Parameters

References