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

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

#include <DiscreteNucleationForce.h>

Inheritance diagram for DiscreteNucleationForce:
[legend]

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 25 of file DiscreteNucleationForce.h.

Constructor & Destructor Documentation

◆ DiscreteNucleationForce()

DiscreteNucleationForce::DiscreteNucleationForce ( const InputParameters &  params)

Definition at line 29 of file DiscreteNucleationForce.C.

30  : Kernel(params),
31  _map(getUserObject<DiscreteNucleationMap>("map")),
32  _v0(getParam<Real>("no_nucleus_value")),
33  _v1(getParam<Real>("nucleus_value"))
34 {
35 }
const DiscreteNucleationMap & _map
UserObject providing a map of currently active nuclei.
const Real _v0
Bounds for the returned values.

Member Function Documentation

◆ computeQpResidual()

Real DiscreteNucleationForce::computeQpResidual ( )
override

Definition at line 45 of file DiscreteNucleationForce.C.

46 {
47  return -((*_nucleus)[_qp] * (_v1 - _v0) + _v0) * _test[_i][_qp];
48 }
const Real _v0
Bounds for the returned values.

◆ precalculateResidual()

void DiscreteNucleationForce::precalculateResidual ( )
override

Definition at line 38 of file DiscreteNucleationForce.C.

39 {
40  // check if a nucleation event list is available for the current element
41  _nucleus = &_map.nuclei(_current_elem);
42 }
const std::vector< Real > * _nucleus
nucleus data for the current element
const DiscreteNucleationMap & _map
UserObject providing a map of currently active nuclei.
const std::vector< Real > & nuclei(const Elem *) const

Member Data Documentation

◆ _map

const DiscreteNucleationMap& DiscreteNucleationForce::_map
protected

UserObject providing a map of currently active nuclei.

Definition at line 35 of file DiscreteNucleationForce.h.

Referenced by precalculateResidual().

◆ _nucleus

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

nucleus data for the current element

Definition at line 38 of file DiscreteNucleationForce.h.

Referenced by precalculateResidual().

◆ _v0

const Real DiscreteNucleationForce::_v0
protected

Bounds for the returned values.

Definition at line 41 of file DiscreteNucleationForce.h.

Referenced by computeQpResidual().

◆ _v1

const Real DiscreteNucleationForce::_v1
protected

Definition at line 42 of file DiscreteNucleationForce.h.

Referenced by computeQpResidual().


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