MultiGrainRigidBodyMotion

under construction:Undocumented Class

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


# MultiGrainRigidBodyMotion

!syntax description /Kernels/MultiGrainRigidBodyMotion

## Overview

!! Replace these lines with information regarding the MultiGrainRigidBodyMotion object.

## Example Input File Syntax

!! Describe and include an example of how to use the MultiGrainRigidBodyMotion object.

!syntax parameters /Kernels/MultiGrainRigidBodyMotion

!syntax inputs /Kernels/MultiGrainRigidBodyMotion

!syntax children /Kernels/MultiGrainRigidBodyMotion

Adds rigid body motion to grains

Input Parameters

  • cConcentration

    C++ Type:std::vector

    Options:

    Description:Concentration

  • grain_forceUserObject for getting force and torque acting on grains

    C++ Type:UserObjectName

    Options:

    Description:UserObject for getting force and torque acting on grains

  • grain_tracker_objectThe FeatureFloodCount UserObject to get values from.

    C++ Type:UserObjectName

    Options:

    Description:The FeatureFloodCount UserObject to get values from.

  • grain_volumesThe feature volume VectorPostprocessorValue.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The feature volume VectorPostprocessorValue.

  • vArray of coupled variable names

    C++ Type:std::vector

    Options:

    Description:Array of coupled variable names

  • variableThe name of the variable that this Kernel operates on

    C++ Type:NonlinearVariableName

    Options:

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

Required Parameters

  • 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

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

    C++ Type:std::vector

    Options:

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

  • displacementsThe displacements

    C++ Type:std::vector

    Options:

    Description:The displacements

  • op_numArray of coupled variable names (num_name)

    C++ Type:unsigned int

    Options:

    Description:Array of coupled variable names (num_name)

  • rotation_constant1constant value characterizing grain rotation

    Default:1

    C++ Type:double

    Options:

    Description:constant value characterizing grain rotation

  • translation_constant500constant value characterizing grain translation

    Default:500

    C++ Type:double

    Options:

    Description:constant value characterizing grain translation

  • var_name_baseArray of coupled variable names (base_name)

    C++ Type:std::string

    Options:

    Description:Array of coupled variable names (base_name)

Optional Parameters

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

    C++ Type:std::vector

    Options:

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

  • 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

    Options:

    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.)

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

    Options:

    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.)

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • 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

    Options:

    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.

Advanced Parameters

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

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

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    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

    Options:nontime system

    Description:The tag for the matrices this Kernel should fill

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime time

    Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files