MultiSmoothSuperellipsoidIC

under construction:Undocumented Class

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

Random distribution of smooth ellipse with given minimum spacing

Input Parameters

  • semiaxis_aVector of mean semiaxis values in the x direction for the ellipse

    C++ Type:std::vector

    Options:

    Description:Vector of mean semiaxis values in the x direction for the ellipse

  • bubspacVector of the minimum spacing of bubbles of one type, measured from center to center

    C++ Type:std::vector

    Options:

    Description:Vector of the minimum spacing of bubbles of one type, measured from center to center

  • numbubVector of the number of bubbles to place

    C++ Type:std::vector

    Options:

    Description:Vector of the number of bubbles to place

  • semiaxis_bVector of mean semiaxis values in the y direction for the ellipse

    C++ Type:std::vector

    Options:

    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

    Options:

    Description:Vector of mean semiaxis values in the z direction for the ellipse, must be greater than 0 even if 2D.

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Options:

    Description:The variable value outside the 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.

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Options:

    Description:The variable value inside the superellipsoid

Required Parameters

  • 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

    Options:

    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_variation_typenoneType of distribution that random superellipsoid semiaxes will follow

    Default:none

    C++ Type:MooseEnum

    Options:uniform normal none

    Description:Type of distribution that random superellipsoid semiaxes will follow

  • 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

  • exponentVector of exponents for each superellipsoid, n=2 is a normal ellipse

    C++ Type:std::vector

    Options:

    Description:Vector of exponents for each superellipsoid, n=2 is a normal ellipse

  • prevent_overlapFalseCheck all Superellipsoid centers for overlap with other Superellipsoids.

    Default:False

    C++ Type:bool

    Options:

    Description:Check all Superellipsoid centers for overlap with other Superellipsoids.

  • check_extremesFalseCheck all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.

    Default:False

    C++ Type:bool

    Options:

    Description:Check all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.

  • 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

    Options:

    Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the x direction for uniform, standard deviation for normal

  • rand_seed12345Seed value for the random number generator

    Default:12345

    C++ Type:unsigned int

    Options:

    Description:Seed value for the random number generator

  • 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

    Options:

    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.

  • 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

  • max_num_tries1000The number of tries

    Default:1000

    C++ Type:unsigned int

    Options:

    Description:The number of tries

  • 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

  • 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

    Options:

    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.

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

References