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

Output diagnostic data on a DiscreteNucleationInserter. More...

#include <DiscreteNucleationData.h>

Inheritance diagram for DiscreteNucleationData:
[legend]

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 24 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 42 of file DiscreteNucleationData.h.

43  {
44  COUNT,
45  UPDATE,
46  RATE,
47  INSERTIONS,
48  DELETIONS
49  } _value_type;
enum DiscreteNucleationData::ValueType _value_type

Constructor & Destructor Documentation

◆ DiscreteNucleationData()

DiscreteNucleationData::DiscreteNucleationData ( const InputParameters &  parameters)

Definition at line 31 of file DiscreteNucleationData.C.

32  : GeneralPostprocessor(parameters),
33  _inserter(getUserObject<DiscreteNucleationInserterBase>("inserter")),
35  _value_type(getParam<MooseEnum>("value").getEnum<ValueType>())
36 {
37 }
ValueType
Type of value to report back.
virtual const NucleusList & getNucleusList() const
const DiscreteNucleationInserterBase::NucleusList & _nucleus_list
list of nuclei maintained bu the inserter object
enum DiscreteNucleationData::ValueType _value_type
const DiscreteNucleationInserterBase & _inserter
UserObject that manages nucleus insertin and deletion.

Member Function Documentation

◆ execute()

void DiscreteNucleationData::execute ( )
inlineoverride

Definition at line 29 of file DiscreteNucleationData.h.

29 {};

◆ getValue()

Real DiscreteNucleationData::getValue ( )
override

Definition at line 40 of file DiscreteNucleationData.C.

41 {
42  switch (_value_type)
43  {
44  case ValueType::COUNT:
45  return _nucleus_list.size();
46 
47  case ValueType::UPDATE:
49 
50  case ValueType::RATE:
51  return _inserter.getRate();
52 
54  return _inserter.getInsertionsAndDeletions().first;
55 
57  return _inserter.getInsertionsAndDeletions().second;
58 
59  default:
60  mooseError("Invalid value type");
61  }
62 }
const DiscreteNucleationInserterBase::NucleusList & _nucleus_list
list of nuclei maintained bu the inserter object
virtual const Real & getRate() const =0
enum DiscreteNucleationData::ValueType _value_type
virtual const NucleusChanges & getInsertionsAndDeletions() const
const DiscreteNucleationInserterBase & _inserter
UserObject that manages nucleus insertin and deletion.

◆ initialize()

void DiscreteNucleationData::initialize ( )
inlineoverride

Definition at line 30 of file DiscreteNucleationData.h.

30 {};

Member Data Documentation

◆ _inserter

const DiscreteNucleationInserterBase& DiscreteNucleationData::_inserter
protected

UserObject that manages nucleus insertin and deletion.

Definition at line 36 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 39 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: