ReconPhaseVarIC Class Reference

ReconPhaseVarIC initializes a single order parameter to represent a phase obtained form an EBSDReader object. More...

#include <ReconPhaseVarIC.h>

Inheritance diagram for ReconPhaseVarIC:

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

Private Attributes
MooseMesh &	_mesh
const EBSDReader &	_ebsd_reader
unsigned int	_phase
const std::map< dof_id_type, std::vector< Real > > &	_node_to_phase_weight_map

Detailed Description

ReconPhaseVarIC initializes a single order parameter to represent a phase obtained form an EBSDReader object.

The op will be set to 1 for nodes that are entirely surrounded by the given phase and 0 for nodes that touch no elements with the selected phase (and fractional values for nodes on interfaces)

Definition at line 28 of file ReconPhaseVarIC.h.

Constructor & Destructor Documentation

ReconPhaseVarIC()

ReconPhaseVarIC::ReconPhaseVarIC

(

const InputParameters &

parameters

)

Definition at line 25 of file ReconPhaseVarIC.C.

  : InitialCondition(parameters),
    _mesh(_fe_problem.mesh()),
    _ebsd_reader(getUserObject<EBSDReader>("ebsd_reader")),
    _phase(getParam<unsigned int>("phase")),
    _node_to_phase_weight_map(_ebsd_reader.getNodeToPhaseWeightMap())
{
}

Member Function Documentation

value()

Real ReconPhaseVarIC::value ( const Point &  )

virtual

Definition at line 35 of file ReconPhaseVarIC.C.

{
  // Return error if current node is NULL
  if (_current_node == nullptr)
    mooseError("_current_node is reporting NULL");
 
  // Make sure the _current_node is in the _node_to_phase_weight_map (return error if not in map)
  std::map<dof_id_type, std::vector<Real>>::const_iterator it =
      _node_to_phase_weight_map.find(_current_node->id());
  if (it == _node_to_phase_weight_map.end())
    mooseError("The following node id is not in the node map: ", _current_node->id());
 
  // make sure we have enough ophase weights
  if (_phase >= it->second.size())
    mooseError("Requested an out-of-range phase number");
 
  return it->second[_phase];
}

Member Data Documentation

_ebsd_reader

const EBSDReader& ReconPhaseVarIC::_ebsd_reader

private

Definition at line 38 of file ReconPhaseVarIC.h.

_mesh

MooseMesh& ReconPhaseVarIC::_mesh

private

Definition at line 36 of file ReconPhaseVarIC.h.

_node_to_phase_weight_map

const std::map<dof_id_type, std::vector<Real> >& ReconPhaseVarIC::_node_to_phase_weight_map

private

Definition at line 42 of file ReconPhaseVarIC.h.

Referenced by value().

_phase

unsigned int ReconPhaseVarIC::_phase

private

Definition at line 40 of file ReconPhaseVarIC.h.

Referenced by value().

---

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

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