LatticeSmoothCircleIC.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", LatticeSmoothCircleIC)
template<>
InputParameters	validParams< LatticeSmoothCircleIC > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		LatticeSmoothCircleIC
	)

validParams< LatticeSmoothCircleIC >()

template<>

InputParameters validParams< LatticeSmoothCircleIC >

(

)

Definition at line 17 of file LatticeSmoothCircleIC.C.

{
  InputParameters params = validParams<SmoothCircleBaseIC>();
  params.addClassDescription("Perturbed square lattice of smooth circles");
  params.addDeprecatedParam<Real>("Rnd_variation",
                                  "Variation from central lattice position",
                                  "use the new parameter name pos_variation");
  params.addParam<Real>("pos_variation", 0.0, "Variation from central lattice position");
  params.addRequiredParam<std::vector<unsigned int>>(
      "circles_per_side", "Vector containing the number of bubbles along each side");
  params.addParam<unsigned int>("rand_seed", 2000, "random seed");
  params.addRequiredParam<Real>("radius", "Mean radius value for the circles");
  params.addParam<Real>(
      "radius_variation", 0.0, "Plus or minus fraction of random variation in the bubble radius");
  MooseEnum rand_options("uniform normal none", "none");
  params.addParam<MooseEnum>("radius_variation_type",
                             rand_options,
                             "Type of distribution that random circle radii will follow");
  params.addParam<bool>(
      "avoid_bounds", true, "Don't place any bubbles on the simulation cell boundaries");
  return params;
}