chombo-discharge
CD_SimpleItoParticle.H
1 /* chombo-discharge
2  * Copyright © 2021 SINTEF Energy Research.
3  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
4  */
5 
12 #ifndef CD_SimpleItoParticleParticle_H
13 #define CD_SimpleItoParticleParticle_H
14 
15 // Std includes
16 #include <string>
17 #include <typeinfo>
18 #include <cstdio>
19 #include <cmath>
20 
21 // Our includes
22 #include <CD_GenericParticle.H>
23 #include <CD_NamespaceHeader.H>
24 
30 class SimpleItoParticle : public GenericParticle<2, 0>
31 {
32 public:
36  inline SimpleItoParticle();
37 
44  inline SimpleItoParticle(const Real a_weight, const RealVect a_position, const Real a_energy);
45 
49  inline virtual ~SimpleItoParticle();
50 
57  inline void
58  define(const Real a_weight, const RealVect a_position, const Real a_energy);
59 
64  inline Real&
65  weight();
66 
71  inline const Real&
72  weight() const;
73 
78  inline Real&
79  energy();
80 
85  inline const Real&
86  energy() const;
87 };
88 
89 #include <CD_NamespaceFooter.H>
90 
92 
93 #endif
Declaration of a generic particle class.
Implementation of CD_SimpleItoParticle.H.
A generic particle class, holding the position and a specified number of real and vector values.
Definition: CD_GenericParticle.H:33
A particle class for reducing HDF5 I/O file sizes when using ItoSolver.
Definition: CD_SimpleItoParticle.H:31
Real & energy()
Get energy.
Definition: CD_SimpleItoParticleImplem.H:51
Real & weight()
Get weight.
Definition: CD_SimpleItoParticleImplem.H:39
SimpleItoParticle()
Default constructor. Should subsequently set weight/position/energy.
Definition: CD_SimpleItoParticleImplem.H:19
void define(const Real a_weight, const RealVect a_position, const Real a_energy)
Define function. Sets weight, position, and energy.
Definition: CD_SimpleItoParticleImplem.H:31
virtual ~SimpleItoParticle()
Destructor (does nothing)
Definition: CD_SimpleItoParticleImplem.H:27