doxygen/html/CD__PointParticle_8H_source.html

 /* chombo-discharge

  * Copyright © 2021 SINTEF Energy Research.

  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.

  */


 #ifndef CD_PointParticle_H

 #define CD_PointParticle_H


 // Std includes

 #include <string>

 #include <typeinfo>

 #include <cstdio>

 #include <cmath>


 // Our includes

 #include <CD_GenericParticle.H>

 #include <CD_NamespaceHeader.H>


 class PointParticle : public GenericParticle<1, 0>

 {

 public:

   inline PointParticle();


   inline PointParticle(const RealVect a_position, const Real a_weight);


   inline virtual ~PointParticle();


   inline void

   define(const RealVect a_position, const Real a_weight);


   inline Real&

   weight();


   inline const Real&

   weight() const;

 };


 #include <CD_NamespaceFooter.H>


 #include <CD_PointParticleImplem.H>


 #endif

CD_GenericParticle.H
Declaration of a generic particle class.

CD_PointParticleImplem.H
Implementation of CD_PointParticle.H.

GenericParticle
A generic particle class, holding the position and a specified number of real and vector values.
Definition: CD_GenericParticle.H:33

PointParticle
A particle class that only has a position and a weight.
Definition: CD_PointParticle.H:29

PointParticle::PointParticle
PointParticle()
Default constructor. Sets weight and position to zero.
Definition: CD_PointParticleImplem.H:19

PointParticle::~PointParticle
virtual ~PointParticle()
Dtor - does nothing.
Definition: CD_PointParticleImplem.H:27

PointParticle::define
void define(const RealVect a_position, const Real a_weight)
Full define function.
Definition: CD_PointParticleImplem.H:31

PointParticle::weight
Real & weight()
Get weight.
Definition: CD_PointParticleImplem.H:38