SmoothCircleIC

Circle with a smooth interface

Insert a single disk or sphere with radius (radius) and a smooth interface of width (int_width) with a user specified value range and functional dependence of the interface (profile). (outvalue) is the variable value outside of the disk/sphere and (invalue) is the value on the interior.

Cosine profile (COS)

Hyperbolic tangent profile (TANH)

(1)

In both cases is the initial condition value at , where is the center point (x1, y1, z1) of the circle (making a radius vector).

The hyperbolic tangent interface is scaled to have the same slope at its midpoint as the cosine interface.

For the COS interface, which is strictly zero outside the particle and strictly inside the particle the interface width int_width denotes exactly the width of the transition region where the order parameter values are in the open interval . The TANH interface function is asymptotic and requires a different definition for the interface width. Here we chose to have the slope at the midpoint match up with the midpoint slope of the COS interface (giving rise to the factor of in eq. Eq. (1)).

Input Parameters

  • invalueThe variable value inside the circle

    C++ Type:double

    Controllable:No

    Description:The variable value inside the circle

  • outvalueThe variable value outside the circle

    C++ Type:double

    Controllable:No

    Description:The variable value outside the circle

  • radiusThe radius of a circle

    C++ Type:double

    Controllable:No

    Description:The radius of a circle

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

    C++ Type:VariableName

    Controllable:No

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

  • x1The x coordinate of the circle center

    C++ Type:double

    Controllable:No

    Description:The x coordinate of the circle center

  • y1The y coordinate of the circle center

    C++ Type:double

    Controllable:No

    Description:The y coordinate of the circle center

Required Parameters

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

    Default:True

    C++ Type:bool

    Controllable:No

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

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

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

    Default:0

    C++ Type:double

    Controllable:No

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

  • profileCOSFunctional dependence for the interface profile

    Default:COS

    C++ Type:MooseEnum

    Options:COS, TANH

    Controllable:No

    Description:Functional dependence for the interface profile

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • rand_seed12345Seed value for the random number generator

    Default:12345

    C++ Type:unsigned int

    Controllable:No

    Description:Seed value for the random number generator

  • z10The z coordinate of the circle center

    Default:0

    C++ Type:double

    Controllable:No

    Description:The z coordinate of the circle center

  • 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

    Controllable:No

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

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • 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

    Controllable:No

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

Advanced Parameters

References

No citations exist within this document.