www.mooseframework.org
DiscreteNucleationData.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "GeneralPostprocessor.h"
14 
16 
17 template <>
18 InputParameters validParams<DiscreteNucleationData>();
19 
23 class DiscreteNucleationData : public GeneralPostprocessor
24 {
25 public:
26  DiscreteNucleationData(const InputParameters & parameters);
27 
28  void execute() override{};
29  void initialize() override{};
30 
31  Real getValue() override;
32 
33 protected:
36 
39 
41  enum class ValueType
42  {
43  COUNT,
44  UPDATE,
45  RATE,
46  INSERTIONS,
47  DELETIONS
48  } _value_type;
49 };
50 
DiscreteNucleationData::ValueType
ValueType
Type of value to report back.
Definition: DiscreteNucleationData.h:41
validParams< DiscreteNucleationData >
InputParameters validParams< DiscreteNucleationData >()
Definition: DiscreteNucleationData.C:16
DiscreteNucleationData::ValueType::INSERTIONS
DiscreteNucleationInserterBase
This UserObject manages the insertion and expiration of nuclei in the simulation domain it manages a ...
Definition: DiscreteNucleationInserterBase.h:25
DiscreteNucleationData::getValue
Real getValue() override
Definition: DiscreteNucleationData.C:40
DiscreteNucleationData::_value_type
enum DiscreteNucleationData::ValueType _value_type
DiscreteNucleationData::execute
void execute() override
Definition: DiscreteNucleationData.h:28
DiscreteNucleationData::ValueType::DELETIONS
DiscreteNucleationInserterBase::NucleusList
std::vector< NucleusLocation > NucleusList
Every MPI task should keep a full list of nuclei (in case they cross domains with their finite radii)
Definition: DiscreteNucleationInserterBase.h:34
DiscreteNucleationData::ValueType::RATE
DiscreteNucleationData::initialize
void initialize() override
Definition: DiscreteNucleationData.h:29
DiscreteNucleationData
Output diagnostic data on a DiscreteNucleationInserter.
Definition: DiscreteNucleationData.h:23
DiscreteNucleationData::ValueType::UPDATE
DiscreteNucleationData::_inserter
const DiscreteNucleationInserterBase & _inserter
UserObject that manages nucleus insertin and deletion.
Definition: DiscreteNucleationData.h:35
DiscreteNucleationData::_nucleus_list
const DiscreteNucleationInserterBase::NucleusList & _nucleus_list
list of nuclei maintained bu the inserter object
Definition: DiscreteNucleationData.h:38
DiscreteNucleationData::ValueType::COUNT
DiscreteNucleationData::DiscreteNucleationData
DiscreteNucleationData(const InputParameters &parameters)
Definition: DiscreteNucleationData.C:31
DiscreteNucleationInserterBase.h