PolycrystalRandomIC Class Reference

Random initial condition for a polycrystalline material. More...

#include <PolycrystalRandomIC.h>

Inheritance diagram for PolycrystalRandomIC:

Public Member Functions
	PolycrystalRandomIC (const InputParameters &parameters)
virtual Real	value (const Point &p)

Private Attributes
const unsigned int	_op_num
const unsigned int	_op_index
const unsigned int	_random_type

Detailed Description

Random initial condition for a polycrystalline material.

Definition at line 23 of file PolycrystalRandomIC.h.

Constructor & Destructor Documentation

PolycrystalRandomIC()

PolycrystalRandomIC::PolycrystalRandomIC

(

const InputParameters &

parameters

)

Definition at line 27 of file PolycrystalRandomIC.C.

  : RandomICBase(parameters),
    _op_num(getParam<unsigned int>("op_num")),
    _op_index(getParam<unsigned int>("op_index")),
    _random_type(getParam<unsigned int>("random_type"))
{
}

Member Function Documentation

value()

Real PolycrystalRandomIC::value ( const Point &  p )

virtual

Definition at line 36 of file PolycrystalRandomIC.C.

{
  Point cur_pos = p;
  Real val = generateRandom();
 
  switch (_random_type)
  {
    case 0: // Continuously random
      return val;
 
    case 1: // Discretely random
    {
      unsigned int rndind = _op_num * val;
 
      if (rndind == _op_index)
        return 1.0;
      else
        return 0.0;
    }
  }
 
  paramError("random_type", "Bad type passed in PolycrystalRandomIC");
}

Member Data Documentation

_op_index

const unsigned int PolycrystalRandomIC::_op_index

private

Definition at line 32 of file PolycrystalRandomIC.h.

Referenced by value().

_op_num

const unsigned int PolycrystalRandomIC::_op_num

private

Definition at line 31 of file PolycrystalRandomIC.h.

Referenced by value().

_random_type

const unsigned int PolycrystalRandomIC::_random_type

private

Definition at line 33 of file PolycrystalRandomIC.h.

Referenced by value().

---

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

• phase_field/include/ics/PolycrystalRandomIC.h
• phase_field/src/ics/PolycrystalRandomIC.C