SmoothCircleIC

under construction:Undocumented Class

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

Circle with a smooth interface

Input Parameters

  • invalueThe variable value inside the circle

    C++ Type:double

    Description:The variable value inside the circle

  • y1The y coordinate of the circle center

    C++ Type:double

    Description:The y coordinate of the circle center

  • radiusThe radius of a circle

    C++ Type:double

    Description:The radius of a circle

  • outvalueThe variable value outside the circle

    C++ Type:double

    Description:The variable value outside the circle

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

  • x1The x coordinate of the circle center

    C++ Type:double

    Description:The x coordinate of the circle center

Required Parameters

  • rand_seed12345Seed value for the random number generator

    Default:12345

    C++ Type:unsigned int

    Description:Seed value for the random number generator

  • 3D_spheresTruein 3D, whether the objects are spheres or columns

    Default:True

    C++ Type:bool

    Description:in 3D, whether the objects are spheres or columns

  • zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

    Default:False

    C++ Type:bool

    Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

  • 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

  • int_width0The interfacial width of the void surface. Defaults to sharp interface

    Default:0

    C++ Type:double

    Description:The interfacial width of the void surface. Defaults to sharp interface

  • z10The z coordinate of the circle center

    Default:0

    C++ Type:double

    Description:The z coordinate of the circle center

  • 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