ComputeExternalGrainForceAndTorque

under construction:Undocumented Class

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


# ComputeExternalGrainForceAndTorque

!syntax description /UserObjects/ComputeExternalGrainForceAndTorque

## Overview

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

## Example Input File Syntax

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

!syntax parameters /UserObjects/ComputeExternalGrainForceAndTorque

!syntax inputs /UserObjects/ComputeExternalGrainForceAndTorque

!syntax children /UserObjects/ComputeExternalGrainForceAndTorque

Userobject for calculating force and torque acting on a grain

Input Parameters

  • 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

  • cConcentration field

    C++ Type:std::vector

    Options:

    Description:Concentration field

  • etasArray of coupled order parameters

    C++ Type:std::vector

    Options:

    Description:Array of coupled order parameters

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • force_densityforce_densityForce density material

    Default:force_density

    C++ Type:MaterialPropertyName

    Options:

    Description:Force density material

  • grain_datacenter of mass of grains

    C++ Type:UserObjectName

    Options:

    Description:center of mass of grains

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • compute_jacobiansTrueCompute Jacobians for coupled variables

    Default:True

    C++ Type:bool

    Options:

    Description:Compute Jacobians for coupled variables

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

  • 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

  • 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

Input Files