SpecifiedSmoothSuperellipsoidIC

under construction:Undocumented Class

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

Multiple smooth superellipsoids with manually specified center points; semiaxes a,b,c; and exponents n

Input Parameters

  • x_positionsThe x-coordinate for each superellipsoid center

    C++ Type:std::vector

    Options:

    Description:The x-coordinate for each superellipsoid center

  • nsExponent n for each superellipsoid

    C++ Type:std::vector

    Options:

    Description:Exponent n for each superellipsoid

  • z_positionsThe z-coordinate for each superellipsoid center

    C++ Type:std::vector

    Options:

    Description:The z-coordinate for each superellipsoid center

  • bsSemiaxis b for each superellipsoid

    C++ Type:std::vector

    Options:

    Description:Semiaxis b for each superellipsoid

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

  • asSemiaxis a for each superellipsoid

    C++ Type:std::vector

    Options:

    Description:Semiaxis a for each superellipsoid

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Options:

    Description:The variable value outside the superellipsoid

  • csSemiaxis c for each superellipsoid

    C++ Type:std::vector

    Options:

    Description:Semiaxis c for each superellipsoid

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Options:

    Description:The variable value inside the superellipsoid

  • y_positionsThe y-coordinate for each superellipsoid center

    C++ Type:std::vector

    Options:

    Description:The y-coordinate for each superellipsoid center

Required Parameters

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

    C++ Type:double

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

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

  • 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

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

Child Objects

References