SpecifiedSmoothSuperellipsoidIC

buildconstruction:Undocumented Class

The SpecifiedSmoothSuperellipsoidIC 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 superellipsoids with manually specified center points; semiaxes a,b,c; and exponents n

Overview

Example Input File Syntax

Input Parameters

  • asSemiaxis a for each superellipsoid

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis a for each superellipsoid

  • bsSemiaxis b for each superellipsoid

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis b for each superellipsoid

  • csSemiaxis c for each superellipsoid

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis c for each superellipsoid

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable value inside the superellipsoid

  • nsExponent n for each superellipsoid

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Exponent n for each superellipsoid

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable value outside the superellipsoid

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

    C++ Type:VariableName

    Unit:(no unit assumed)

    Controllable:No

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

  • x_positionsThe x-coordinate for each superellipsoid center

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The x-coordinate for each superellipsoid center

  • y_positionsThe y-coordinate for each superellipsoid center

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The y-coordinate for each superellipsoid center

  • z_positionsThe z-coordinate for each superellipsoid center

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The z-coordinate for each superellipsoid center

Required Parameters

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

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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

  • 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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

    Description:Seed value for the random number generator

  • stateCURRENTThis parameter is used to set old state solutions at the start of simulation. If specifying multiple states at the start of simulation, use one IC object for each state being specified. The states are CURRENT=0 OLD=1 OLDER=2. States older than 2 are not currently supported. When the user only specifies current state, the solution is copied to the old and older states, as expected. This functionality is mainly used for dynamic simulations with explicit time integration schemes, where old solution states are used in the velocity and acceleration approximations.

    Default:CURRENT

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:CURRENT, OLD, OLDER

    Controllable:No

    Description:This parameter is used to set old state solutions at the start of simulation. If specifying multiple states at the start of simulation, use one IC object for each state being specified. The states are CURRENT=0 OLD=1 OLDER=2. States older than 2 are not currently supported. When the user only specifies current state, the solution is copied to the old and older states, as expected. This functionality is mainly used for dynamic simulations with explicit time integration schemes, where old solution states are used in the velocity and acceleration approximations.

  • 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

    Unit:(no unit assumed)

    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.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

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

Optional Parameters

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

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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

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

Advanced Parameters