RandomEulerAngleProvider Class Reference

Assign random Euler angles to each grains. More...

#include <RandomEulerAngleProvider.h>

Inheritance diagram for RandomEulerAngleProvider:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const GrainTrackerInterface &	_grain_tracker
std::vector< EulerAngles >	_angles
MooseRandom	_random

Detailed Description

Assign random Euler angles to each grains.

Definition at line 25 of file RandomEulerAngleProvider.h.

Constructor & Destructor Documentation

RandomEulerAngleProvider()

RandomEulerAngleProvider::RandomEulerAngleProvider

(

const InputParameters &

parameters

)

Definition at line 27 of file RandomEulerAngleProvider.C.

  : EulerAngleProvider(params),
    _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker_object")),
    _angles(0)
{
  _random.seed(0, getParam<unsigned int>("seed"));
}

Member Function Documentation

execute()

virtual void RandomEulerAngleProvider::execute ( )

inlineoverridevirtual

Definition at line 31 of file RandomEulerAngleProvider.h.

{}

finalize()

virtual void RandomEulerAngleProvider::finalize ( )

inlineoverridevirtual

Definition at line 32 of file RandomEulerAngleProvider.h.

{}

getEulerAngles()

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

overridevirtual

Implements EulerAngleProvider.

Definition at line 54 of file RandomEulerAngleProvider.C.

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

getGrainNum()

unsigned int RandomEulerAngleProvider::getGrainNum ( ) const

overridevirtual

Implements EulerAngleProvider.

Definition at line 48 of file RandomEulerAngleProvider.C.

{
  return _angles.size();
}

Referenced by getEulerAngles().

initialize()

void RandomEulerAngleProvider::initialize ( )

overridevirtual

Definition at line 36 of file RandomEulerAngleProvider.C.

{
  EulerAngles angle;
  auto grain_num = _grain_tracker.getTotalFeatureCount();
  for (auto i = _angles.size(); i < grain_num; ++i)
  {
    angle.random(_random);
    _angles.push_back(angle);
  }
}

validParams()

InputParameters EulerAngleProvider::validParams ( )

staticinherited

Definition at line 15 of file EulerAngleProvider.C.

{
  return GeneralUserObject::validParams();
}

Referenced by EulerAngleFileReader::validParams().

Member Data Documentation

_angles

std::vector<EulerAngles> RandomEulerAngleProvider::_angles

protected

Definition at line 39 of file RandomEulerAngleProvider.h.

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

_grain_tracker

const GrainTrackerInterface& RandomEulerAngleProvider::_grain_tracker

protected

Definition at line 38 of file RandomEulerAngleProvider.h.

Referenced by initialize().

_random

MooseRandom RandomEulerAngleProvider::_random

protected

Definition at line 41 of file RandomEulerAngleProvider.h.

Referenced by initialize(), and RandomEulerAngleProvider().

---

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

• phase_field/include/userobjects/RandomEulerAngleProvider.h
• phase_field/src/userobjects/RandomEulerAngleProvider.C