LatticeSmoothCircleIC

under construction:Undocumented Class

The LatticeSmoothCircleIC has not been documented. The content contained on this page includes the basic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Perturbed square lattice of smooth circles

Input Parameters

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

    C++ Type:VariableName

    Options:

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

  • outvalueThe variable value outside the circle

    C++ Type:double

    Options:

    Description:The variable value outside the circle

  • radiusMean radius value for the circels

    C++ Type:double

    Options:

    Description:Mean radius value for the circels

  • invalueThe variable value inside the circle

    C++ Type:double

    Options:

    Description:The variable value inside the circle

  • circles_per_sideVector containing the number of bubbles along each side

    C++ Type:std::vector

    Options:

    Description:Vector containing the number of bubbles along each side

Required Parameters

  • profileCOSFunctional dependence for the interface profile

    Default:COS

    C++ Type:MooseEnum

    Options:COS TANH

    Description:Functional dependence for the interface profile

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

    Default:0

    C++ Type:double

    Options:

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

  • pos_variation0Variation from central lattice position

    Default:0

    C++ Type:double

    Options:

    Description:Variation from central lattice position

  • rand_seed2000random seed

    Default:2000

    C++ Type:unsigned int

    Options:

    Description:random seed

  • radius_variation0Plus or minus fraction of random variation in the bubble radius

    Default:0

    C++ Type:double

    Options:

    Description:Plus or minus fraction of random variation in the bubble radius

  • avoid_boundsTrueDon't place any bubbles on the simulation cell boundaries

    Default:True

    C++ Type:bool

    Options:

    Description:Don't place any bubbles on the simulation cell boundaries

  • radius_variation_typenoneType of distribution that random circle radii will follow

    Default:none

    C++ Type:MooseEnum

    Options:uniform normal none

    Description:Type of distribution that random circle radii will follow

  • 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

    Options:

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

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

  • 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

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

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

Advanced Parameters

Input Files

References