- bubspacVector of the minimum spacing of bubbles of one type, measured from center to center
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of the minimum spacing of bubbles of one type, measured from center to center
- invalueThe variable value inside the superellipsoid
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The variable value inside the superellipsoid
- numbubVector of the number of bubbles to place
C++ Type:std::vector<unsigned int>
Unit:(no unit assumed)
Controllable:No
Description:Vector of the number of bubbles to place
- outvalueThe variable value outside the superellipsoid
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The variable value outside the superellipsoid
- semiaxis_aVector of mean semiaxis values in the x direction for the ellipse
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of mean semiaxis values in the x direction for the ellipse
- semiaxis_bVector of mean semiaxis values in the y direction for the ellipse
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of mean semiaxis values in the y direction for the ellipse
- semiaxis_cVector of mean semiaxis values in the z direction for the ellipse, must be greater than 0 even if 2D.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of mean semiaxis values in the z direction for the ellipse, must be greater than 0 even if 2D.
- 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.
MultiSmoothSuperellipsoidIC
The MultiSmoothSuperellipsoidIC 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.
Random distribution of smooth ellipse with given minimum spacing
Overview
Example Input File Syntax
Input 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
- check_extremesFalseCheck all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Check all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.
- exponentVector of exponents for each superellipsoid, n=2 is a normal ellipse
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of exponents for each superellipsoid, n=2 is a normal ellipse
- 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
- max_num_tries1000The number of tries
Default:1000
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The number of tries
- 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
- prevent_overlapFalseCheck all Superellipsoid centers for overlap with other superellipsoids.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Check all Superellipsoid centers for overlap with other superellipsoids.
- 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
- semiaxis_a_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the x direction for uniform, standard deviation for normal
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the x direction for uniform, standard deviation for normal
- semiaxis_b_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the y direction for uniform, standard deviation for normal
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the y direction for uniform, standard deviation for normal
- semiaxis_c_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the z direction for uniform, standard deviation for normal. Must be set to 0 if 2D.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the z direction for uniform, standard deviation for normal. Must be set to 0 if 2D.
- semiaxis_variation_typenoneType of distribution that random superellipsoid semiaxes will follow
Default:none
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Type of distribution that random superellipsoid semiaxes will follow
- 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.
- vary_axes_independentlyTrueIf true the length of each semiaxis is randomly chosen within the provided parameters, if false then one random number is generated and applied to all semiaxes.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If true the length of each semiaxis is randomly chosen within the provided parameters, if false then one random number is generated and applied to all semiaxes.
- 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