PolycrystalColoringIC Class Reference

PolycrystalColoringIC creates a polycrystal initial condition. More...

#include <PolycrystalColoringIC.h>

Inheritance diagram for PolycrystalColoringIC:

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

Protected Attributes
unsigned int	_op_index
unsigned int	_phase
const PolycrystalUserObjectBase &	_poly_ic_uo

Detailed Description

PolycrystalColoringIC creates a polycrystal initial condition.

With 2 Grains, _typ = 0 results in a circular inclusion grain and _type = 1 gives a bicrystal. With more than 2 grains, _typ = 0 gives set positions for 6 grains, _type = 1 gives hexagonal grains for 4 grains. _typ = 2 Gives a random voronoi structure

Definition at line 30 of file PolycrystalColoringIC.h.

Constructor & Destructor Documentation

PolycrystalColoringIC()

PolycrystalColoringIC::PolycrystalColoringIC

(

const InputParameters &

parameters

)

Definition at line 34 of file PolycrystalColoringIC.C.

  : InitialCondition(parameters),
    _op_index(getParam<unsigned int>("op_index")),
    _poly_ic_uo(getUserObject<PolycrystalUserObjectBase>("polycrystal_ic_uo"))
{
}

Member Function Documentation

value()

Real PolycrystalColoringIC::value ( const Point &  p )

overridevirtual

Definition at line 42 of file PolycrystalColoringIC.C.

{
  if (_current_node)
    return _poly_ic_uo.getNodalVariableValue(_op_index, *_current_node);
  else
    return _poly_ic_uo.getVariableValue(_op_index, p);
}

Member Data Documentation

_op_index

unsigned int PolycrystalColoringIC::_op_index

protected

Definition at line 38 of file PolycrystalColoringIC.h.

Referenced by value().

_phase

unsigned int PolycrystalColoringIC::_phase

protected

Definition at line 39 of file PolycrystalColoringIC.h.

_poly_ic_uo

const PolycrystalUserObjectBase& PolycrystalColoringIC::_poly_ic_uo

protected

Definition at line 40 of file PolycrystalColoringIC.h.

Referenced by value().

---

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

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