EulerAngleFileReader Class Reference

Read a set of Euler angles from a file. More...

#include <EulerAngleFileReader.h>

Inheritance diagram for EulerAngleFileReader:

Public Member Functions
	EulerAngleFileReader (const InputParameters &parameters)
virtual const EulerAngles &	getEulerAngles (unsigned int) const
virtual unsigned int	getGrainNum () const
virtual void	initialize ()
virtual void	execute ()
virtual void	finalize ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	readFile ()

Protected Attributes
FileName	_file_name
std::vector< EulerAngles >	_angles

Detailed Description

Read a set of Euler angles from a file.

Definition at line 24 of file EulerAngleFileReader.h.

Constructor & Destructor Documentation

EulerAngleFileReader()

EulerAngleFileReader::EulerAngleFileReader

(

const InputParameters &

parameters

)

Definition at line 27 of file EulerAngleFileReader.C.

  : EulerAngleProvider(params), _file_name(getParam<FileName>("file_name"))
{
  readFile();
}

Member Function Documentation

execute()

virtual void EulerAngleFileReader::execute ( )

inlinevirtual

Definition at line 35 of file EulerAngleFileReader.h.

{}

finalize()

virtual void EulerAngleFileReader::finalize ( )

inlinevirtual

Definition at line 36 of file EulerAngleFileReader.h.

{}

getEulerAngles()

const EulerAngles & EulerAngleFileReader::getEulerAngles ( unsigned int  i ) const

virtual

Implements EulerAngleProvider.

Definition at line 40 of file EulerAngleFileReader.C.

{
  mooseAssert(i < getGrainNum(), "Requesting Euler angles for an invalid grain id");
  return _angles[i];
}

getGrainNum()

unsigned int EulerAngleFileReader::getGrainNum ( ) const

virtual

Implements EulerAngleProvider.

Definition at line 34 of file EulerAngleFileReader.C.

{
  return _angles.size();
}

Referenced by getEulerAngles().

initialize()

virtual void EulerAngleFileReader::initialize ( )

inlinevirtual

Definition at line 34 of file EulerAngleFileReader.h.

{}

readFile()

void EulerAngleFileReader::readFile ( )

protected

Definition at line 47 of file EulerAngleFileReader.C.

{
  // Read in Euler angles from _file_name
  std::ifstream inFile(_file_name.c_str());
  if (!inFile)
    mooseError("Can't open ", _file_name);
 
  // Skip first 4 lines
  for (unsigned int i = 0; i < 4; ++i)
    inFile.ignore(std::numeric_limits<std::streamsize>::max(), '\n');
 
  // The angle files contain a fourth column with weights that we ignore in this version
  Real weight;
 
  // Loop over grains
  EulerAngles a;
  while (inFile >> a.phi1 >> a.Phi >> a.phi2 >> weight)
    _angles.push_back(EulerAngles(a));
}

Referenced by EulerAngleFileReader().

validParams()

InputParameters EulerAngleFileReader::validParams ( )

static

Definition at line 19 of file EulerAngleFileReader.C.

{
  InputParameters params = EulerAngleProvider::validParams();
  params.addClassDescription("Read Euler angle data from a file and provide it to other objects.");
  params.addRequiredParam<FileName>("file_name", "Euler angle data file name");
  return params;
}

Member Data Documentation

_angles

std::vector<EulerAngles> EulerAngleFileReader::_angles

protected

Definition at line 42 of file EulerAngleFileReader.h.

Referenced by getEulerAngles(), getGrainNum(), and readFile().

_file_name

FileName EulerAngleFileReader::_file_name

protected

Definition at line 41 of file EulerAngleFileReader.h.

Referenced by readFile().

---

The documentation for this class was generated from the following files:

• tensor_mechanics/include/userobjects/EulerAngleFileReader.h
• tensor_mechanics/src/userobjects/EulerAngleFileReader.C