CD_ItoParticle.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_ITOPARTICLE_H
#define CD_ITOPARTICLE_H
 
// Std includes
#include <string>
#include <typeinfo>
#include <cstdio>
#include <cmath>
 
// Our includes
#include <CD_GenericParticle.H>
#include <CD_NamespaceHeader.H>
 
class ItoParticle : public GenericParticle<5, 3>
{
public:
  static std::vector<std::string> s_realVariables;
 
  static std::vector<std::string> s_vectVariables;
 
  inline ItoParticle();
 
  inline ItoParticle(const Real      a_weight,
                     const RealVect& a_position,
                     const RealVect& a_velocity  = RealVect::Zero,
                     const Real      a_diffusion = 0.0,
                     const Real      a_mobility  = 1.0,
                     const Real      a_energy    = 0.0);
 
  inline ItoParticle(const ItoParticle& a_other);
 
  inline virtual ~ItoParticle();
 
  inline void
  define(const Real      a_weight,
         const RealVect& a_position,
         const RealVect& a_velocity  = RealVect::Zero,
         const Real      a_diffusion = 0.0,
         const Real      a_mobility  = 1.0,
         const Real      a_energy    = 0.0);
 
  inline Real&
  weight();
 
  inline const Real&
  weight() const;
 
  inline Real&
  diffusion();
 
  inline const Real&
  diffusion() const;
 
  inline Real&
  mobility();
 
  inline const Real&
  mobility() const;
 
  inline Real&
  energy();
 
  inline const Real&
  energy() const;
 
  inline RealVect&
  oldPosition();
 
  inline const RealVect&
  oldPosition() const;
 
  inline RealVect&
  velocity();
 
  inline const RealVect&
  velocity() const;
 
  inline Real
  totalEnergy() const;
 
  inline Real
  conductivity() const;
 
  inline Real
  diffusivity() const;
 
  inline Real&
  tmpReal();
 
  inline const Real&
  tmpReal() const;
 
  inline RealVect&
  tmpVect();
 
  inline const RealVect&
  tmpVect() const;
 
  inline virtual int
  H5size() const;
 
  inline virtual void
  H5linearOut(void* const a_buffer) const;
 
  inline virtual void
  H5linearIn(const void* const a_buffer);
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoParticleImplem.H>
 
#endif