www.mooseframework.org
DiscreteNucleationMap.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 "ElementUserObject.h"
14 
16 
17 template <>
18 InputParameters validParams<DiscreteNucleationMap>();
19 
25 class DiscreteNucleationMap : public ElementUserObject
26 {
27 public:
28  DiscreteNucleationMap(const InputParameters & parameters);
29 
30  virtual void initialize();
31  virtual void execute();
32  virtual void threadJoin(const UserObject & y);
33  virtual void finalize() {}
34 
35  virtual void meshChanged();
36 
37  const std::vector<Real> & nuclei(const Elem *) const;
38 
40  std::pair<Real, Real> getRadiusAndWidth() const { return std::make_pair(_radius, _int_width); }
41  Real getPeriodic() const { return _periodic; }
42 
43 protected:
46 
49 
51  std::vector<Real> _elem_map;
52 
54  std::vector<Real> _zero_map;
55 
58 
60  int _periodic;
61 
63  const Real _radius;
64 
66  const Real _int_width;
67 
70 
72  using NucleusMap = std::unordered_map<dof_id_type, std::vector<Real>>;
75 };
76 
DiscreteNucleationMap::_mesh_changed
bool _mesh_changed
Did the mesh change since the last execution of this PP?
Definition: DiscreteNucleationMap.h:45
DiscreteNucleationMap
This UserObject maintains a per QP map that indicates if a nucleus is present or not.
Definition: DiscreteNucleationMap.h:25
DiscreteNucleationMap::_elem_map
std::vector< Real > _elem_map
Buffer for building the per QP map.
Definition: DiscreteNucleationMap.h:51
DiscreteNucleationMap::getRadiusAndWidth
std::pair< Real, Real > getRadiusAndWidth() const
Definition: DiscreteNucleationMap.h:40
DiscreteNucleationMap::_nucleus_map
NucleusMap _nucleus_map
Definition: DiscreteNucleationMap.h:73
validParams< DiscreteNucleationMap >
InputParameters validParams< DiscreteNucleationMap >()
Definition: DiscreteNucleationMap.C:19
DiscreteNucleationMap::_zero_map
std::vector< Real > _zero_map
Dummy map for elements without nuclei.
Definition: DiscreteNucleationMap.h:54
DiscreteNucleationInserterBase
This UserObject manages the insertion and expiration of nuclei in the simulation domain it manages a ...
Definition: DiscreteNucleationInserterBase.h:25
DiscreteNucleationMap::initialize
virtual void initialize()
Definition: DiscreteNucleationMap.C:49
DiscreteNucleationMap::finalize
virtual void finalize()
Definition: DiscreteNucleationMap.h:33
DiscreteNucleationMap::DiscreteNucleationMap
DiscreteNucleationMap(const InputParameters &parameters)
Definition: DiscreteNucleationMap.C:36
DiscreteNucleationMap::threadJoin
virtual void threadJoin(const UserObject &y)
Definition: DiscreteNucleationMap.C:111
DiscreteNucleationMap::NucleusMap
std::unordered_map< dof_id_type, std::vector< Real > > NucleusMap
Per element list with 0/1 flags indicating the presence of a nucleus.
Definition: DiscreteNucleationMap.h:72
DiscreteNucleationMap::_nucleus_list
const DiscreteNucleationInserterBase::NucleusList & _nucleus_list
list of nuclei maintained bu the inserter object
Definition: DiscreteNucleationMap.h:69
DiscreteNucleationMap::meshChanged
virtual void meshChanged()
Definition: DiscreteNucleationMap.C:122
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
DiscreteNucleationMap::_periodic
int _periodic
variable number to use for minPeriodicDistance calls (i.e. use the periodicity of this variable)
Definition: DiscreteNucleationMap.h:60
DiscreteNucleationMap::_int_width
const Real _int_width
Nucleus interface width.
Definition: DiscreteNucleationMap.h:66
DiscreteNucleationMap::nuclei
const std::vector< Real > & nuclei(const Elem *) const
Definition: DiscreteNucleationMap.C:128
DiscreteNucleationMap::_inserter
const DiscreteNucleationInserterBase & _inserter
UserObject that manages nucleus insertin and deletion.
Definition: DiscreteNucleationMap.h:57
DiscreteNucleationMap::_rebuild_map
bool _rebuild_map
Do we need to rebuild the map during this timestep?
Definition: DiscreteNucleationMap.h:48
DiscreteNucleationMap::execute
virtual void execute()
Definition: DiscreteNucleationMap.C:63
DiscreteNucleationMap::_radius
const Real _radius
Nucleus radius.
Definition: DiscreteNucleationMap.h:63
DiscreteNucleationMap::getPeriodic
Real getPeriodic() const
Definition: DiscreteNucleationMap.h:41
DiscreteNucleationInserterBase.h
DiscreteNucleationMap::getInserter
const DiscreteNucleationInserterBase & getInserter() const
Definition: DiscreteNucleationMap.h:39