This UserObject manages the insertion and expiration of nuclei in the simulation domain it manages a list of nuclei with their insertion times and their center positions. More...

#include <DiscreteNucleationInserterBase.h>

Inheritance diagram for DiscreteNucleationInserterBase:

[legend]

Public Types
using	NucleusLocation = std::pair< Real, Point >
	A nucleus has an expiration time and a location. More...

using	NucleusList = std::vector< NucleusLocation >
	Every MPI task should keep a full list of nuclei (in case they cross domains with their finite radii) More...

using	NucleusChanges = std::pair< unsigned int, unsigned int >

Public Member Functions
	DiscreteNucleationInserterBase (const InputParameters &parameters)

virtual bool	isMapUpdateRequired () const

virtual const NucleusList &	getNucleusList () const

virtual const NucleusChanges &	getInsertionsAndDeletions () const

virtual const Real &	getRate () const =0

Protected Attributes
NucleusList &	_global_nucleus_list
	the global list of all nuclei over all processors More...

NucleusChanges	_changes_made
	count the number of nucleus insertions and deletions More...

bool	_update_required
	is a map update required More...

Detailed Description

This UserObject manages the insertion and expiration of nuclei in the simulation domain it manages a list of nuclei with their insertion times and their center positions.

A DiscreteNucleationMap is needed to enable the DiscreteNucleation material to look up if a nucleus is present at a given element/qp.

Definition at line 25 of file DiscreteNucleationInserterBase.h.

Member Typedef Documentation

◆ NucleusChanges

using DiscreteNucleationInserterBase::NucleusChanges = std::pair<unsigned int, unsigned int>

Definition at line 37 of file DiscreteNucleationInserterBase.h.

◆ NucleusList

using DiscreteNucleationInserterBase::NucleusList = std::vector<NucleusLocation>

Every MPI task should keep a full list of nuclei (in case they cross domains with their finite radii)

Definition at line 34 of file DiscreteNucleationInserterBase.h.

◆ NucleusLocation

using DiscreteNucleationInserterBase::NucleusLocation = std::pair<Real, Point>

A nucleus has an expiration time and a location.

Definition at line 31 of file DiscreteNucleationInserterBase.h.

Constructor & Destructor Documentation

◆ DiscreteNucleationInserterBase()

DiscreteNucleationInserterBase::DiscreteNucleationInserterBase ( const InputParameters & parameters )

Definition at line 21 of file DiscreteNucleationInserterBase.C.

   : ElementUserObject(parameters),
     _global_nucleus_list(declareRestartableData("global_nucleus_list", NucleusList(0))),
     _changes_made(0, 0),
     _update_required(_app.isRecovering() || _app.isRestarting())
 {
   setRandomResetFrequency(EXEC_TIMESTEP_END);
 }