PolycrystalCircles.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		PolycrystalCircles
	)

validParams< PolycrystalCircles >()

template<>

InputParameters validParams< PolycrystalCircles >

(

)

Definition at line 21 of file PolycrystalCircles.C.

{
  InputParameters params = validParams<PolycrystalUserObjectBase>();
  params.addClassDescription(
      "Polycrystal circles generated from a vector input or read from a file");
  params.addParam<bool>("read_from_file",
                        false,
                        "Set to true to read the position and radius "
                        "vectors from a file rather than inputing them "
                        "manually");
  params.addParam<bool>(
      "columnar_3D", false, "3D microstructure will be columnar in the z-direction?");
  params.addParam<std::vector<Real>>("x_positions", "x coordinate for each circle center");
  params.addParam<std::vector<Real>>("y_positions", "y coordinate for each circle center");
  params.addParam<std::vector<Real>>("z_positions", "z coordinate for each circle center");
  params.addParam<std::vector<Real>>("radii", "The radius for each circle");
  params.addParam<FileName>("file_name", "File containing circle centers and radii");
  params.addParam<Real>("int_width", 0.0, "Width of diffuse interface");
 
  return params;
}