Classes | Functions
PolycrystalCircles.h File Reference

Go to the source code of this file.


class  PolycrystalCircles
 PolycrystalCircles creates a polycrystal made up of circles. More...


InputParameters validParams< PolycrystalCircles > ()

Function Documentation

InputParameters validParams< PolycrystalCircles > ( )

Definition at line 16 of file PolycrystalCircles.C.

17 {
18  InputParameters params = validParams<PolycrystalUserObjectBase>();
19  params.addClassDescription(
20  "Polycrystal circles generated from a vector input or read from a file");
21  params.addParam<bool>("read_from_file",
22  false,
23  "Set to true to read the position and radius "
24  "vectors from a file rather than inputing them "
25  "manually");
26  params.addParam<bool>(
27  "columnar_3D", false, "3D microstructure will be columnar in the z-direction?");
28  params.addParam<std::vector<Real>>("x_positions", "x coordinate for each circle center");
29  params.addParam<std::vector<Real>>("y_positions", "y coordinate for each circle center");
30  params.addParam<std::vector<Real>>("z_positions", "z coordinate for each circle center");
31  params.addParam<std::vector<Real>>("radii", "The radius for each circle");
32  params.addParam<FileName>("file_name", "File containing circle centers and radii");
34  return params;
35 }
InputParameters validParams< PolycrystalUserObjectBase >()