www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
PolycrystalColoringIC Class Reference

PolycrystalColoringIC creates a polycrystal initial condition. More...

#include <PolycrystalColoringIC.h>

Inheritance diagram for PolycrystalColoringIC:
[legend]

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 28 of file PolycrystalColoringIC.h.

Constructor & Destructor Documentation

PolycrystalColoringIC::PolycrystalColoringIC ( const InputParameters &  parameters)

Definition at line 29 of file PolycrystalColoringIC.C.

30  : InitialCondition(parameters),
31  _op_index(getParam<unsigned int>("op_index")),
32  _poly_ic_uo(getUserObject<PolycrystalUserObjectBase>("polycrystal_ic_uo"))
33 {
34 }
const PolycrystalUserObjectBase & _poly_ic_uo

Member Function Documentation

Real PolycrystalColoringIC::value ( const Point &  p)
overridevirtual

Definition at line 37 of file PolycrystalColoringIC.C.

38 {
39  if (_current_node)
40  return _poly_ic_uo.getNodalVariableValue(_op_index, *_current_node);
41  else
43 }
virtual Real getNodalVariableValue(unsigned int op_index, const Node &n) const
Similarly to the getVariableValue method, this method also returns values but may be optimized for re...
virtual Real getVariableValue(unsigned int op_index, const Point &p) const =0
Returns the variable value for a given op_index and mesh point.
const PolycrystalUserObjectBase & _poly_ic_uo

Member Data Documentation

unsigned int PolycrystalColoringIC::_op_index
protected

Definition at line 36 of file PolycrystalColoringIC.h.

Referenced by value().

unsigned int PolycrystalColoringIC::_phase
protected

Definition at line 37 of file PolycrystalColoringIC.h.

const PolycrystalUserObjectBase& PolycrystalColoringIC::_poly_ic_uo
protected

Definition at line 38 of file PolycrystalColoringIC.h.

Referenced by value().


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