TricrystalTripleJunctionIC

under construction:Undocumented Class

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

Tricrystal with a triple junction

Input Parameters

  • variableThe variable this initial condition is supposed to provide values for.

    C++ Type:VariableName

    Description:The variable this initial condition is supposed to provide values for.

  • op_indexIndex for the current grain order parameter

    C++ Type:unsigned int

    Description:Index for the current grain order parameter

  • op_numNumber of grain order parameters

    C++ Type:unsigned int

    Description:Number of grain order parameters

Required Parameters

  • theta2135Angle of second grain at triple junction in degrees

    Default:135

    C++ Type:double

    Description:Angle of second grain at triple junction in degrees

  • 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

  • theta1135Angle of first grain at triple junction in degrees

    Default:135

    C++ Type:double

    Description:Angle of first grain at triple junction in degrees

  • junctionThe point where the triple junction is located. Default is the center of the mesh

    C++ Type:libMesh::Point

    Description:The point where the triple junction is located. Default is the center of the mesh

  • 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

  • ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC

    Default:False

    C++ Type:bool

    Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

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

Advanced Parameters

References