GrainAdvectionVelocity

under construction:Undocumented Class

The GrainAdvectionVelocity 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.

Calculation the advection velocity of grain due to rigid vody translation and rotation

Input Parameters

  • etasArray of other coupled order parameters

    C++ Type:std::vector

    Options:

    Description:Array of other coupled order parameters

Required Parameters

  • var_name_baseArray of other coupled order parameters (base_name)

    C++ Type:std::string

    Options:

    Description:Array of other coupled order parameters (base_name)

  • cConcentration field

    C++ Type:std::vector

    Options:

    Description:Concentration field

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Options:

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.

  • grain_forceuserobject for getting force and torque acting on grains

    C++ Type:UserObjectName

    Options:

    Description:userobject for getting force and torque acting on grains

  • 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

  • grain_dataUserObject for getting the center of mass of grains

    C++ Type:UserObjectName

    Options:

    Description:UserObject for getting the center of mass of grains

  • translation_constant500constant value characterizing grain translation

    Default:500

    C++ Type:double

    Options:

    Description:constant value characterizing grain translation

  • op_numArray of other coupled order parameters (num_name)

    C++ Type:unsigned int

    Options:

    Description:Array of other coupled order parameters (num_name)

  • grain_volumesThe feature volume VectorPostprocessorValue.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The feature volume VectorPostprocessorValue.

  • rotation_constant1constant value characterizing grain rotation

    Default:1

    C++ Type:double

    Options:

    Description:constant value characterizing grain rotation

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • 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

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

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

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

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • 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

  • 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

    Options:NONE ELEMENT SUBDOMAIN

    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

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

    Options:

    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

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

References