DiscreteNucleationInserterBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "ElementUserObject.h"

class DiscreteNucleationInserterBase : public ElementUserObject
{
public:
  static InputParameters validParams();

  DiscreteNucleationInserterBase(const InputParameters & parameters);

  // using NucleusLocation = std::tuple<Real, Point, Real>;
  struct NucleusLocation
  {
    Real time;
    Point center;
    Real radius;
  };

  using NucleusList = std::vector<NucleusLocation>;

  // counter pair to track insertions and deletion in the current timestep
  using NucleusChanges = std::pair<unsigned int, unsigned int>;

  virtual bool isMapUpdateRequired() const { return _update_required; }
  virtual const NucleusList & getNucleusList() const { return _global_nucleus_list; }
  virtual const NucleusChanges & getInsertionsAndDeletions() const { return _changes_made; }

  virtual const Real & getRate() const = 0;

protected:
  NucleusList & _global_nucleus_list;

  NucleusChanges _changes_made;

  bool _update_required;
};

// Used for Restart
template <>
void dataStore(std::ostream & stream,
               DiscreteNucleationInserterBase::NucleusLocation & nl,
               void * context);
template <>
void dataLoad(std::istream & stream,
              DiscreteNucleationInserterBase::NucleusLocation & nl,
              void * context);