MultiSmoothSuperellipsoidIC.h File Reference

Go to the source code of this file.

Classes
class	MultiSmoothSuperellipsoidIC
	MultismoothSuperellipsoidIC creates multiple SmoothSuperellipsoid (number = numbub) that are randomly positioned around the domain, with a minimum spacing equal to bubspac. More...

Functions
template<>
InputParameters	validParams< MultiSmoothSuperellipsoidIC > ()

Function Documentation

validParams< MultiSmoothSuperellipsoidIC >()

template<>

InputParameters validParams< MultiSmoothSuperellipsoidIC >

(

)

Definition at line 24 of file MultiSmoothSuperellipsoidIC.C.

{
  InputParameters params = validParams<SmoothSuperellipsoidBaseIC>();
  params.addClassDescription("Random distribution of smooth ellipse with given minimum spacing");
  params.addRequiredParam<std::vector<unsigned int>>("numbub",
                                                     "Vector of the number of bubbles to place");
  params.addRequiredParam<std::vector<Real>>(
      "bubspac",
      "Vector of the minimum spacing of bubbles of one type, measured from center to center");
  params.addParam<unsigned int>("max_num_tries", 1000, "The number of tries");
  params.addRequiredParam<std::vector<Real>>(
      "semiaxis_a", "Vector of mean semiaxis values in the x direction for the ellipse");
  params.addRequiredParam<std::vector<Real>>(
      "semiaxis_b", "Vector of mean semiaxis values in the y direction for the ellipse");
  params.addRequiredParam<std::vector<Real>>("semiaxis_c",
                                             "Vector of mean semiaxis values in the z direction "
                                             "for the ellipse, must be greater than 0 even if 2D.");
  params.addParam<std::vector<Real>>(
      "exponent",
      std::vector<Real>(),
      "Vector of exponents for each superellipsoid, n=2 is a normal ellipse");
  params.addParam<std::vector<Real>>("semiaxis_a_variation",
                                     std::vector<Real>(),
                                     "Vector of plus or minus fractions of random variation in the "
                                     "bubble semiaxis in the x direction for uniform, standard "
                                     "deviation for normal");
  params.addParam<std::vector<Real>>("semiaxis_b_variation",
                                     std::vector<Real>(),
                                     "Vector of plus or minus fractions of random variation in the "
                                     "bubble semiaxis in the y direction for uniform, standard "
                                     "deviation for normal");
  params.addParam<std::vector<Real>>("semiaxis_c_variation",
                                     std::vector<Real>(),
                                     "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.");
  params.addParam<bool>("check_extremes",
                        false,
                        "Check all Superellipsoid extremes (center +- "
                        "each semiaxis) for overlap, must have "
                        "prevent_overlap set to True.");
  params.addParam<bool>("prevent_overlap",
                        false,
                        "Check all Superellipsoid centers for overlap with other superellipsoids.");
  params.addParam<bool>("vary_axes_independently",
                        true,
                        "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.");
  MooseEnum rand_options("uniform normal none", "none");
  params.addParam<MooseEnum>(
      "semiaxis_variation_type",
      rand_options,
      "Type of distribution that random superellipsoid semiaxes will follow");
  return params;
}