SingleGrainRigidBodyMotion

under construction:Undocumented Class

The SingleGrainRigidBodyMotion 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 a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Adds rigid mody motion to a single grain

Input Parameters

  • cConcentration

    C++ Type:std::vector

    Description:Concentration

  • grain_forceUserObject for getting force and torque acting on grains

    C++ Type:UserObjectName

    Description:UserObject for getting force and torque acting on grains

  • grain_tracker_objectThe FeatureFloodCount UserObject to get values from.

    C++ Type:UserObjectName

    Description:The FeatureFloodCount UserObject to get values from.

  • variableThe name of the variable that this Kernel operates on

    C++ Type:NonlinearVariableName

    Description:The name of the variable that this Kernel operates on

  • vArray of coupled variable names

    C++ Type:std::vector

    Description:Array of coupled variable names

  • grain_volumesThe feature volume VectorPostprocessorValue.

    C++ Type:VectorPostprocessorName

    Description:The feature volume VectorPostprocessorValue.

Required Parameters

  • var_name_baseArray of coupled variable names (base_name)

    C++ Type:std::string

    Description:Array of coupled variable names (base_name)

  • rotation_constant1constant value characterizing grain rotation

    Default:1

    C++ Type:double

    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

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

  • op_numArray of coupled variable names (num_name)

    C++ Type:unsigned int

    Description:Array of coupled variable names (num_name)

  • translation_constant500constant value characterizing grain translation

    Default:500

    C++ Type:double

    Description:constant value characterizing grain translation

  • op_index0Grain number for the kernel to be applied

    Default:0

    C++ Type:unsigned int

    Description:Grain number for the kernel to be applied

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Description:The seed for the master random number generator

  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Description:The tag for the vectors this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Description:The tag for the matrices this Kernel should fill

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Description:The extra tags for the matrices this Kernel should fill

Tagging Parameters

References