DiscreteNucleationForce Class Reference

Free energy penalty contribution to force the nucleation of subresolution particles. More...

#include <DiscreteNucleationForce.h>

Inheritance diagram for DiscreteNucleationForce:

Public Member Functions
	DiscreteNucleationForce (const InputParameters &params)
void	precalculateResidual () override
Real	computeQpResidual () 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

Free energy penalty contribution to force the nucleation of subresolution particles.

Definition at line 24 of file DiscreteNucleationForce.h.

Constructor & Destructor Documentation

DiscreteNucleationForce()

DiscreteNucleationForce::DiscreteNucleationForce

(

const InputParameters &

params

)

Definition at line 29 of file DiscreteNucleationForce.C.

  : Kernel(params),
    _map(getUserObject<DiscreteNucleationMap>("map")),
    _v0(getParam<Real>("no_nucleus_value")),
    _v1(getParam<Real>("nucleus_value"))
{
}

Member Function Documentation

computeQpResidual()

Real DiscreteNucleationForce::computeQpResidual ( )

override

Definition at line 45 of file DiscreteNucleationForce.C.

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

precalculateResidual()

void DiscreteNucleationForce::precalculateResidual ( )

override

Definition at line 38 of file DiscreteNucleationForce.C.

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

Member Data Documentation

_map

const DiscreteNucleationMap& DiscreteNucleationForce::_map

protected

UserObject providing a map of currently active nuclei.

Definition at line 34 of file DiscreteNucleationForce.h.

Referenced by precalculateResidual().

_nucleus

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

protected

nucleus data for the current element

Definition at line 37 of file DiscreteNucleationForce.h.

Referenced by precalculateResidual().

_v0

const Real DiscreteNucleationForce::_v0

protected

Bounds for the returned values.

Definition at line 40 of file DiscreteNucleationForce.h.

Referenced by computeQpResidual().

_v1

const Real DiscreteNucleationForce::_v1

protected

Definition at line 41 of file DiscreteNucleationForce.h.

Referenced by computeQpResidual().

---

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

• phase_field/include/kernels/DiscreteNucleationForce.h
• phase_field/src/kernels/DiscreteNucleationForce.C