- etasArray of other coupled order parameters
C++ Type:std::vector
Description:Array of other coupled order parameters
GrainAdvectionVelocity
under construction:Undocumented Class
The GrainAdvectionVelocity 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.
# GrainAdvectionVelocity
!syntax description /Materials/GrainAdvectionVelocity
## Overview
!! Replace these lines with information regarding the GrainAdvectionVelocity object.
## Example Input File Syntax
!! Describe and include an example of how to use the GrainAdvectionVelocity object.
!syntax parameters /Materials/GrainAdvectionVelocity
!syntax inputs /Materials/GrainAdvectionVelocity
!syntax children /Materials/GrainAdvectionVelocity
Calculation the advection velocity of grain due to rigid body translation and rotation
Input Parameters
- 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
- 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
- boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Description:The list of boundary IDs from the mesh where this boundary condition applies
- cConcentration field
C++ Type:std::vector
Description:Concentration field
- computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
- constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
- grain_dataUserObject for getting the center of mass of grains
C++ Type:UserObjectName
Description:UserObject for getting the center of mass of grains
- grain_forceuserobject for getting force and torque acting on grains
C++ Type:UserObjectName
Description:userobject for getting force and torque acting on grains
- grain_volumesThe feature volume VectorPostprocessorValue.
C++ Type:VectorPostprocessorName
Description:The feature volume VectorPostprocessorValue.
- op_numArray of other coupled order parameters (num_name)
C++ Type:unsigned int
Description:Array of other coupled order parameters (num_name)
- rotation_constant1constant value characterizing grain rotation
Default:1
C++ Type:double
Description:constant value characterizing grain rotation
- translation_constant500constant value characterizing grain translation
Default:500
C++ Type:double
Description:constant value characterizing grain translation
- var_name_baseArray of other coupled order parameters (base_name)
C++ Type:std::string
Description:Array of other coupled order parameters (base_name)
Optional Parameters
- 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.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
Description:Determines whether this object is calculated using an implicit or explicit form
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
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
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
- output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
- outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object