SpecifiedSmoothCircleIC

buildconstruction:Undocumented Class

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

Multiple smooth circles with manually specified radii and center points

Overview

Example Input File Syntax

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

  • radiiThe radius for each circle

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

    Controllable:No

    Description:The radius for each 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.

  • x_positionsThe x-coordinate for each circle center

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

    Controllable:No

    Description:The x-coordinate for each circle center

  • y_positionsThe y-coordinate for each circle center

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

    Controllable:No

    Description:The y-coordinate for each circle center

  • z_positionsThe z-coordinate for each circle center

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

    Controllable:No

    Description:The z-coordinate for each 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

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

  • 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

Input Files