DiscreteNucleationMap Class Reference

This UserObject maintains a per QP map that indicates if a nucleus is present or not. More...

#include <DiscreteNucleationMap.h>

Inheritance diagram for DiscreteNucleationMap:

Public Member Functions
	DiscreteNucleationMap (const InputParameters &parameters)
virtual void	initialize ()
virtual void	execute ()
virtual void	threadJoin (const UserObject &y)
virtual void	finalize ()
virtual void	meshChanged ()
const std::vector< Real > &	nuclei (const Elem *) const
const DiscreteNucleationInserterBase &	getInserter () const
std::pair< Real, Real >	getRadiusAndWidth () const
Real	getPeriodic () const

Protected Attributes
bool	_mesh_changed
	Did the mesh change since the last execution of this PP? More...
bool	_rebuild_map
	Do we need to rebuild the map during this timestep? More...
std::vector< Real >	_elem_map
	Buffer for building the per QP map. More...
std::vector< Real >	_zero_map
	Dummy map for elements without nuclei. More...
const DiscreteNucleationInserterBase &	_inserter
	UserObject that manages nucleus insertin and deletion. More...
int	_periodic
	variable number to use for minPeriodicDistance calls (i.e. use the periodicity of this variable) More...
const Real	_radius
	Nucleus radius. More...
const Real	_int_width
	Nucleus interface width. More...
const DiscreteNucleationInserterBase::NucleusList &	_nucleus_list
	list of nuclei maintained bu the inserter object More...
using	NucleusMap = std::unordered_map< dof_id_type, std::vector< Real > >
	Per element list with 0/1 flags indicating the presence of a nucleus. More...
NucleusMap	_nucleus_map

Detailed Description

This UserObject maintains a per QP map that indicates if a nucleus is present or not.

It effectively performs a spatial hashing of the list maintained by the DiscreteNucleationInserter (and allows for spatially extended nuclei)

Definition at line 26 of file DiscreteNucleationMap.h.

Member Typedef Documentation

NucleusMap

using DiscreteNucleationMap::NucleusMap = std::unordered_map<dof_id_type, std::vector<Real> >

protected

Per element list with 0/1 flags indicating the presence of a nucleus.

Definition at line 73 of file DiscreteNucleationMap.h.

Constructor & Destructor Documentation

DiscreteNucleationMap()

DiscreteNucleationMap::DiscreteNucleationMap

(

const InputParameters &

parameters

)

Definition at line 36 of file DiscreteNucleationMap.C.

  : ElementUserObject(parameters),
    _mesh_changed(false),
    _inserter(getUserObject<DiscreteNucleationInserterBase>("inserter")),
    _periodic(isCoupled("periodic") ? coupled("periodic") : -1),
    _radius(getParam<Real>("radius")),
    _int_width(getParam<Real>("int_width")),
    _nucleus_list(_inserter.getNucleusList())
{
  _zero_map.assign(_fe_problem.getMaxQps(), 0.0);
}

Member Function Documentation

execute()

void DiscreteNucleationMap::execute ( )

virtual

Definition at line 63 of file DiscreteNucleationMap.C.

{
  if (_rebuild_map)
  {
    // reserve space for each quadrature point in the element
    _elem_map.assign(_qrule->n_points(), 0);

    // store a random number for each quadrature point
    unsigned int active_nuclei = 0;
    for (unsigned int qp = 0; qp < _qrule->n_points(); ++qp)
    {
      Real r, rmin = std::numeric_limits<Real>::max();

      // find the distance to the closest nucleus
      for (unsigned i = 0; i < _nucleus_list.size(); ++i)
      {
        // use a non-periodic or periodic distance
        r = _periodic < 0
                ? (_q_point[qp] - _nucleus_list[i].second).norm()
                : _mesh.minPeriodicDistance(_periodic, _q_point[qp], _nucleus_list[i].second);
        if (r < rmin)
          rmin = r;
      }

      // compute intensity value with smooth interface
      Real value = 0.0;
      if (rmin <= _radius - _int_width / 2.0) // Inside circle
      {
        active_nuclei++;
        value = 1.0;
      }
      else if (rmin < _radius + _int_width / 2.0) // Smooth interface
      {
        Real int_pos = (rmin - _radius + _int_width / 2.0) / _int_width;
        active_nuclei++;
        value = (1.0 + std::cos(int_pos * libMesh::pi)) / 2.0;
      }
      _elem_map[qp] = value;
    }

    // if the map is not empty insert it
    if (active_nuclei > 0)
      _nucleus_map.insert(
          std::pair<dof_id_type, std::vector<Real>>(_current_elem->id(), _elem_map));
  }
}

finalize()

virtual void DiscreteNucleationMap::finalize ( )

inlinevirtual

Definition at line 34 of file DiscreteNucleationMap.h.

{}

getInserter()

const DiscreteNucleationInserterBase& DiscreteNucleationMap::getInserter ( ) const

inline

Definition at line 40 of file DiscreteNucleationMap.h.

{ return _inserter; }

getPeriodic()

Real DiscreteNucleationMap::getPeriodic ( ) const

inline

Definition at line 42 of file DiscreteNucleationMap.h.

{ return _periodic; }

getRadiusAndWidth()

std::pair<Real, Real> DiscreteNucleationMap::getRadiusAndWidth ( ) const

inline

Definition at line 41 of file DiscreteNucleationMap.h.

{ return std::make_pair(_radius, _int_width); }

initialize()

void DiscreteNucleationMap::initialize ( )

virtual

Definition at line 49 of file DiscreteNucleationMap.C.

{
  if (_inserter.isMapUpdateRequired() || _mesh_changed)
  {
    _rebuild_map = true;
    _nucleus_map.clear();
  }
  else
    _rebuild_map = false;

  _mesh_changed = false;
}

meshChanged()

void DiscreteNucleationMap::meshChanged ( )

virtual

Definition at line 122 of file DiscreteNucleationMap.C.

{
  _mesh_changed = true;
}

nuclei()

const std::vector< Real > & DiscreteNucleationMap::nuclei

(

const Elem *

elem

)

const

Definition at line 128 of file DiscreteNucleationMap.C.

Referenced by DiscreteNucleation::computeProperties(), DiscreteNucleationForce::precalculateResidual(), and DiscreteNucleationAux::precalculateValue().

{
  NucleusMap::const_iterator i = _nucleus_map.find(elem->id());

  // if no entry in the map was found the element contains no nucleus
  if (i == _nucleus_map.end())
    return _zero_map;

  return i->second;
}

threadJoin()

void DiscreteNucleationMap::threadJoin ( const UserObject &  y )

virtual

Definition at line 111 of file DiscreteNucleationMap.C.

{
  // if the map needs to be updated we merge the maps from all threads
  if (_rebuild_map)
  {
    const DiscreteNucleationMap & uo = static_cast<const DiscreteNucleationMap &>(y);
    _nucleus_map.insert(uo._nucleus_map.begin(), uo._nucleus_map.end());
  }
}

Member Data Documentation

_elem_map

std::vector<Real> DiscreteNucleationMap::_elem_map

protected

Buffer for building the per QP map.

Definition at line 52 of file DiscreteNucleationMap.h.

Referenced by execute().

_inserter

const DiscreteNucleationInserterBase& DiscreteNucleationMap::_inserter

protected

UserObject that manages nucleus insertin and deletion.

Definition at line 58 of file DiscreteNucleationMap.h.

Referenced by getInserter(), and initialize().

_int_width

const Real DiscreteNucleationMap::_int_width

protected

Nucleus interface width.

Definition at line 67 of file DiscreteNucleationMap.h.

Referenced by execute(), and getRadiusAndWidth().

_mesh_changed

bool DiscreteNucleationMap::_mesh_changed

protected

Did the mesh change since the last execution of this PP?

Definition at line 46 of file DiscreteNucleationMap.h.

Referenced by initialize(), and meshChanged().

_nucleus_list

const DiscreteNucleationInserterBase::NucleusList& DiscreteNucleationMap::_nucleus_list

protected

list of nuclei maintained bu the inserter object

Definition at line 70 of file DiscreteNucleationMap.h.

Referenced by execute().

_nucleus_map

NucleusMap DiscreteNucleationMap::_nucleus_map

protected

Definition at line 74 of file DiscreteNucleationMap.h.

Referenced by execute(), initialize(), nuclei(), and threadJoin().

_periodic

int DiscreteNucleationMap::_periodic

protected

variable number to use for minPeriodicDistance calls (i.e. use the periodicity of this variable)

Definition at line 61 of file DiscreteNucleationMap.h.

Referenced by execute(), and getPeriodic().

_radius

const Real DiscreteNucleationMap::_radius

protected

Nucleus radius.

Definition at line 64 of file DiscreteNucleationMap.h.

Referenced by execute(), and getRadiusAndWidth().

_rebuild_map

bool DiscreteNucleationMap::_rebuild_map

protected

Do we need to rebuild the map during this timestep?

Definition at line 49 of file DiscreteNucleationMap.h.

Referenced by execute(), initialize(), and threadJoin().

_zero_map

std::vector<Real> DiscreteNucleationMap::_zero_map

protected

Dummy map for elements without nuclei.

Definition at line 55 of file DiscreteNucleationMap.h.

Referenced by DiscreteNucleationMap(), and nuclei().

---

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

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