DiscreteNucleationAux Class Reference

Project the DiscreteNucleationMap onto an AuxVariable field. More...

#include <DiscreteNucleationAux.h>

Inheritance diagram for DiscreteNucleationAux:

Public Member Functions
	DiscreteNucleationAux (const InputParameters &params)

Protected Member Functions
void	precalculateValue () override
Real	computeValue () override

Protected Attributes
const DiscreteNucleationMap &	_map
	UserObject providing a map of currently active nuclei. More...
const std::vector< Real > *	_nucleus
	nucleus data for the current element More...
const Real	_v0
	Bounds for the returned values. More...
const Real	_v1

Detailed Description

Project the DiscreteNucleationMap onto an AuxVariable field.

Definition at line 24 of file DiscreteNucleationAux.h.

Constructor & Destructor Documentation

DiscreteNucleationAux()

DiscreteNucleationAux::DiscreteNucleationAux

(

const InputParameters &

params

)

Definition at line 28 of file DiscreteNucleationAux.C.

  : AuxKernel(params),
    _map(getUserObject<DiscreteNucleationMap>("map")),
    _v0(getParam<Real>("no_nucleus_value")),
    _v1(getParam<Real>("nucleus_value"))
{
  if (isNodal())
    paramError("variable", "This kernel must operate on an elemental AuxVariable.");
}

Member Function Documentation

computeValue()

Real DiscreteNucleationAux::computeValue ( )

overrideprotected

Definition at line 46 of file DiscreteNucleationAux.C.

{
  return (*_nucleus)[_qp] * (_v1 - _v0) + _v0;
}

precalculateValue()

void DiscreteNucleationAux::precalculateValue ( )

overrideprotected

Definition at line 39 of file DiscreteNucleationAux.C.

{
  // check if a nucleation event list is available for the current element
  _nucleus = &_map.nuclei(_current_elem);
}

Member Data Documentation

_map

const DiscreteNucleationMap& DiscreteNucleationAux::_map

protected

UserObject providing a map of currently active nuclei.

Definition at line 34 of file DiscreteNucleationAux.h.

Referenced by precalculateValue().

_nucleus

const std::vector<Real>* DiscreteNucleationAux::_nucleus

protected

nucleus data for the current element

Definition at line 37 of file DiscreteNucleationAux.h.

Referenced by computeValue(), and precalculateValue().

_v0

const Real DiscreteNucleationAux::_v0

protected

Bounds for the returned values.

Definition at line 40 of file DiscreteNucleationAux.h.

Referenced by computeValue().

_v1

const Real DiscreteNucleationAux::_v1

protected

Definition at line 41 of file DiscreteNucleationAux.h.

Referenced by computeValue().

---

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

• phase_field/include/auxkernels/DiscreteNucleationAux.h
• phase_field/src/auxkernels/DiscreteNucleationAux.C