www.mooseframework.org
GrainDataTracker.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 "GrainTracker.h"
13 
18 template <typename T>
20 {
21 public:
22  GrainDataTracker(const InputParameters & parameters);
23 
25  const T & getData(unsigned int grain_id) const;
26 
27 protected:
29  virtual T newGrain(unsigned int new_grain_id) = 0;
30 
31  virtual void newGrainCreated(unsigned int new_grain_id);
32 
34  std::vector<T> _grain_data;
35 };
36 
37 template <typename T>
38 GrainDataTracker<T>::GrainDataTracker(const InputParameters & parameters) : GrainTracker(parameters)
39 {
40 }
41 
42 template <typename T>
43 const T &
44 GrainDataTracker<T>::getData(unsigned int grain_id) const
45 {
46  mooseAssert(grain_id < _grain_data.size(), "Requested data for invalid grain index.");
47  return _grain_data[grain_id];
48 }
49 
50 template <typename T>
51 void
52 GrainDataTracker<T>::newGrainCreated(unsigned int new_grain_id)
53 {
54  if (_grain_data.size() <= new_grain_id)
55  _grain_data.resize(new_grain_id + 1);
56 
57  _grain_data[new_grain_id] = newGrain(new_grain_id);
58 }
59 
GrainDataTracker::newGrain
virtual T newGrain(unsigned int new_grain_id)=0
implement this method to initialize the data for the new grain
GrainDataTracker::GrainDataTracker
GrainDataTracker(const InputParameters &parameters)
Definition: GrainDataTracker.h:38
GrainTracker
Definition: GrainTracker.h:24
GrainDataTracker
GrainTracker derived class template to base objects on which maintain physical parameters for individ...
Definition: GrainDataTracker.h:19
GrainDataTracker::getData
const T & getData(unsigned int grain_id) const
return data for selected grain
Definition: GrainDataTracker.h:44
GrainDataTracker::newGrainCreated
virtual void newGrainCreated(unsigned int new_grain_id)
This method is called when a new grain is detected.
Definition: GrainDataTracker.h:52
GrainTracker.h
GrainDataTracker::_grain_data
std::vector< T > _grain_data
per grain data
Definition: GrainDataTracker.h:34