SmoothSuperellipsoidIC

under construction:Undocumented Class

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

Superellipsoid with a smooth interface

Input Parameters

  • aSemiaxis a of the superellipsoid

    C++ Type:double

    Description:Semiaxis a of the superellipsoid

  • bSemiaxis b of the superellipsoid

    C++ Type:double

    Description:Semiaxis b of the superellipsoid

  • x1The x coordinate of the superellipsoid center

    C++ Type:double

    Description:The x coordinate of the superellipsoid center

  • nExponent n of the superellipsoid

    C++ Type:double

    Description:Exponent n of the superellipsoid

  • y1The y coordinate of the superellipsoid center

    C++ Type:double

    Description:The y coordinate of the superellipsoid center

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Description:The variable value outside the superellipsoid

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

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Description:The variable value inside the superellipsoid

Required Parameters

  • c1Semiaxis c of the superellipsoid

    Default:1

    C++ Type:double

    Description:Semiaxis c of the superellipsoid

  • nestedvalueThe variable value for nested particles inside the superellipsoid in inverse configuration

    C++ Type:double

    Description:The variable value for nested particles inside the superellipsoid in inverse configuration

  • rand_seed12345Seed value for the random number generator

    Default:12345

    C++ Type:unsigned int

    Description:Seed value for the random number generator

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

    Default:False

    C++ Type:bool

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

  • 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 superellipsoid center

    Default:0

    C++ Type:double

    Description:The z coordinate of the superellipsoid 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