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

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

#include <DiscreteNucleationAux.h>

Inheritance diagram for DiscreteNucleationAux:
[legend]

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

Constructor & Destructor Documentation

◆ DiscreteNucleationAux()

DiscreteNucleationAux::DiscreteNucleationAux ( const InputParameters &  params)

Definition at line 28 of file DiscreteNucleationAux.C.

29  : AuxKernel(params),
30  _map(getUserObject<DiscreteNucleationMap>("map")),
31  _v0(getParam<Real>("no_nucleus_value")),
32  _v1(getParam<Real>("nucleus_value"))
33 {
34  if (isNodal())
35  paramError("variable", "This kernel must operate on an elemental AuxVariable.");
36 }
const DiscreteNucleationMap & _map
UserObject providing a map of currently active nuclei.
const Real _v0
Bounds for the returned values.

Member Function Documentation

◆ computeValue()

Real DiscreteNucleationAux::computeValue ( )
overrideprotected

Definition at line 46 of file DiscreteNucleationAux.C.

47 {
48  return (*_nucleus)[_qp] * (_v1 - _v0) + _v0;
49 }
const std::vector< Real > * _nucleus
nucleus data for the current element
const Real _v0
Bounds for the returned values.

◆ precalculateValue()

void DiscreteNucleationAux::precalculateValue ( )
overrideprotected

Definition at line 39 of file DiscreteNucleationAux.C.

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

Member Data Documentation

◆ _map

const DiscreteNucleationMap& DiscreteNucleationAux::_map
protected

UserObject providing a map of currently active nuclei.

Definition at line 35 of file DiscreteNucleationAux.h.

Referenced by precalculateValue().

◆ _nucleus

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

nucleus data for the current element

Definition at line 38 of file DiscreteNucleationAux.h.

Referenced by computeValue(), and precalculateValue().

◆ _v0

const Real DiscreteNucleationAux::_v0
protected

Bounds for the returned values.

Definition at line 41 of file DiscreteNucleationAux.h.

Referenced by computeValue().

◆ _v1

const Real DiscreteNucleationAux::_v1
protected

Definition at line 42 of file DiscreteNucleationAux.h.

Referenced by computeValue().


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