DiscreteNucleationData Class Reference

Output diagnostic data on a DiscreteNucleationInserter. More...

#include <DiscreteNucleationData.h>

Inheritance diagram for DiscreteNucleationData:

Public Member Functions
	DiscreteNucleationData (const InputParameters &parameters)
void	execute () override
void	initialize () override
Real	getValue () override

Protected Types
enum	ValueType {   ValueType::COUNT, ValueType::UPDATE, ValueType::RATE, ValueType::INSERTIONS,   ValueType::DELETIONS }
	Type of value to report back. More...

Protected Attributes
const DiscreteNucleationInserterBase &	_inserter
	UserObject that manages nucleus insertin and deletion. More...
const DiscreteNucleationInserterBase::NucleusList &	_nucleus_list
	list of nuclei maintained bu the inserter object More...
enum DiscreteNucleationData::ValueType	_value_type

Detailed Description

Output diagnostic data on a DiscreteNucleationInserter.

Definition at line 23 of file DiscreteNucleationData.h.

Member Enumeration Documentation

ValueType

enum DiscreteNucleationData::ValueType

strongprotected

Type of value to report back.

Enumerator
COUNT
UPDATE
RATE
INSERTIONS
DELETIONS

Definition at line 41 of file DiscreteNucleationData.h.

  {
    COUNT,
    UPDATE,
    RATE,
    INSERTIONS,
    DELETIONS
  } _value_type;

Constructor & Destructor Documentation

DiscreteNucleationData()

DiscreteNucleationData::DiscreteNucleationData

(

const InputParameters &

parameters

)

Definition at line 31 of file DiscreteNucleationData.C.

  : GeneralPostprocessor(parameters),
    _inserter(getUserObject<DiscreteNucleationInserterBase>("inserter")),
    _nucleus_list(_inserter.getNucleusList()),
    _value_type(getParam<MooseEnum>("value").getEnum<ValueType>())
{
}

Member Function Documentation

execute()

void DiscreteNucleationData::execute ( )

inlineoverride

Definition at line 28 of file DiscreteNucleationData.h.

{};

getValue()

Real DiscreteNucleationData::getValue ( )

override

Definition at line 40 of file DiscreteNucleationData.C.

{
  switch (_value_type)
  {
    case ValueType::COUNT:
      return _nucleus_list.size();
 
    case ValueType::UPDATE:
      return _inserter.isMapUpdateRequired();
 
    case ValueType::RATE:
      return _inserter.getRate();
 
    case ValueType::INSERTIONS:
      return _inserter.getInsertionsAndDeletions().first;
 
    case ValueType::DELETIONS:
      return _inserter.getInsertionsAndDeletions().second;
 
    default:
      mooseError("Invalid value type");
  }
}

initialize()

void DiscreteNucleationData::initialize ( )

inlineoverride

Definition at line 29 of file DiscreteNucleationData.h.

{};

Member Data Documentation

_inserter

const DiscreteNucleationInserterBase& DiscreteNucleationData::_inserter

protected

UserObject that manages nucleus insertin and deletion.

Definition at line 35 of file DiscreteNucleationData.h.

Referenced by getValue().

_nucleus_list

const DiscreteNucleationInserterBase::NucleusList& DiscreteNucleationData::_nucleus_list

protected

list of nuclei maintained bu the inserter object

Definition at line 38 of file DiscreteNucleationData.h.

Referenced by getValue().

_value_type

enum DiscreteNucleationData::ValueType DiscreteNucleationData::_value_type

protected

Referenced by getValue().

---

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

• phase_field/include/postprocessors/DiscreteNucleationData.h
• phase_field/src/postprocessors/DiscreteNucleationData.C