PolycrystalHex.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalHex
	PolycrystalHex creates a hexagonal polycrystal initial condition. More...

Functions
template<>
InputParameters	validParams< PolycrystalHex > ()

Function Documentation

validParams< PolycrystalHex >()

template<>

InputParameters validParams< PolycrystalHex >

(

)

Definition at line 19 of file PolycrystalHex.C.

{
  InputParameters params = validParams<PolycrystalVoronoi>();
  params.addClassDescription("Perturbed hexagonal polycrystal");
  params.addParam<Real>("x_offset", 0.5, "Specifies offset of hexagon grid in x-direction");
  params.addRangeCheckedParam<Real>(
      "perturbation_percent",
      0.0,
      "perturbation_percent >= 0.0 & perturbation_percent <= 1.0",
      "The percent to randomly perturb centers of grains relative to the size of the grain");
  return params;
}