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 <DiscreteNucleationFromFile.h>

Inheritance diagram for DiscreteNucleationFromFile:

[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
	DiscreteNucleationFromFile (const InputParameters &parameters)

void	initialize () override

void	execute () override

void	threadJoin (const UserObject &) override

void	finalize () override

const Real &	getRate () const override

virtual bool	isMapUpdateRequired () const

virtual const NucleusList &	getNucleusList () const

virtual const NucleusChanges &	getInsertionsAndDeletions () const

Protected Attributes
const Real	_hold_time
	Duration of time each nucleus is kept active after insertion. More...

MooseUtils::DelimitedFileReader	_reader
	CSV file to read. More...

NucleusList	_nucleation_history
	Total nucleation history read from file. More...

std::size_t	_history_pointer
	pointer to the next nucleation event in the history More...

const Real	_tol
	tolerance for determining insertion time More...

const Real	_nucleation_rate
	total nucleation rate More...

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 26 of file DiscreteNucleationFromFile.h.

Member Typedef Documentation

◆ NucleusChanges

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

inherited

Definition at line 37 of file DiscreteNucleationInserterBase.h.

◆ NucleusList

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

inherited

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>

inherited

A nucleus has an expiration time and a location.

Definition at line 31 of file DiscreteNucleationInserterBase.h.

Constructor & Destructor Documentation

◆ DiscreteNucleationFromFile()

DiscreteNucleationFromFile::DiscreteNucleationFromFile ( const InputParameters & parameters )

Definition at line 32 of file DiscreteNucleationFromFile.C.

   : DiscreteNucleationInserterBase(parameters),
     _hold_time(getParam<Real>("hold_time")),
     _reader(getParam<FileName>("file")),
     _history_pointer(0),
     _tol(getParam<Real>("tolerance")),
     _nucleation_rate(0.0)
 {
   _reader.read();
  
   auto & names = _reader.getNames();
   auto & data = _reader.getData();
  
   const std::size_t rows = data[0].size();
   _nucleation_history.resize(rows);
  
   bool found_time = false;
   bool found_x = false;
   bool found_y = false;
   bool found_z = false;
  
   for (std::size_t i = 0; i < names.size(); ++i)
   {
     // make sure all data columns have the same length
     if (data[i].size() != rows)
       paramError("file", "Mismatching column lengths in file");
  
     if (names[i] == "time")
     {
       for (std::size_t j = 0; j < rows; ++j)
         _nucleation_history[j].first = data[i][j];
       found_time = true;
     }
     else if (names[i] == "x")
     {
       for (std::size_t j = 0; j < rows; ++j)
         _nucleation_history[j].second(0) = data[i][j];
       found_x = true;
     }
     else if (names[i] == "y")
     {
       for (std::size_t j = 0; j < rows; ++j)
         _nucleation_history[j].second(1) = data[i][j];
       found_y = true;
     }
     else if (names[i] == "z")
     {
       for (std::size_t j = 0; j < rows; ++j)
         _nucleation_history[j].second(2) = data[i][j];
       found_z = true;
     }
   }
  
   // check if all required columns were found
   if (!found_time)
     paramError("file", "Missing 'time' column in file");
   if (!found_x)
     paramError("file", "Missing 'x' column in file");
   if (!found_y && _mesh.dimension() >= 2)
     paramError("file", "Missing 'y' column in file");
   if (!found_z && _mesh.dimension() >= 3)
     paramError("file", "Missing 'z' column in file");
  
   // sort the nucleation history primarily according to time
   std::sort(_nucleation_history.begin(), _nucleation_history.end());
 }

Member Function Documentation

◆ execute()

void DiscreteNucleationFromFile::execute ( )

inlineoverride

Definition at line 32 of file DiscreteNucleationFromFile.h.

32 {}

◆ finalize()

void DiscreteNucleationFromFile::finalize ( )

override

Definition at line 136 of file DiscreteNucleationFromFile.C.

 {
   // no communication necessary as all ranks have the full nucleus history from the
   // DelimitedFileReader
   _update_required = _changes_made.first > 0 || _changes_made.second > 0;
 }

◆ getInsertionsAndDeletions()

virtual const NucleusChanges& DiscreteNucleationInserterBase::getInsertionsAndDeletions ( ) const

inlinevirtualinherited

Definition at line 41 of file DiscreteNucleationInserterBase.h.

41 { return _changes_made; }

Referenced by DiscreteNucleationData::getValue().

◆ getNucleusList()

virtual const NucleusList& DiscreteNucleationInserterBase::getNucleusList ( ) const

inlinevirtualinherited

Definition at line 40 of file DiscreteNucleationInserterBase.h.

40 { return _global_nucleus_list; }

◆ getRate()

const Real& DiscreteNucleationFromFile::getRate ( ) const

inlineoverridevirtual

Implements DiscreteNucleationInserterBase.

Definition at line 36 of file DiscreteNucleationFromFile.h.

36 { return _nucleation_rate; }

◆ initialize()

void DiscreteNucleationFromFile::initialize ( )

override

Definition at line 100 of file DiscreteNucleationFromFile.C.

 {
   // clear insertion and deletion counter
   _changes_made = {0, 0};
  
   // expire entries from the local nucleus list (if the current time step converged)
   if (_fe_problem.converged())
   {
     unsigned int i = 0;
     while (i < _global_nucleus_list.size())
     {
       if (_global_nucleus_list[i].first - _tol <= _fe_problem.time())
       {
         // remove entry (by replacing with last element and shrinking size by one)
         _global_nucleus_list[i] = _global_nucleus_list.back();
         _global_nucleus_list.pop_back();
         _changes_made.second++;
       }
       else
         ++i;
     }
   }
  
   // check if it is time to insert from the nucleus history
   while (_history_pointer < _nucleation_history.size() &&
          _nucleation_history[_history_pointer].first <= _fe_problem.time())
   {
     _global_nucleus_list.push_back(
         NucleusLocation(_nucleation_history[_history_pointer].first + _hold_time,
                         _nucleation_history[_history_pointer].second));
     _changes_made.first++;
     _history_pointer++;
   }
 }