doxygen/html/CD__Photon_8H_source.html

 /* chombo-discharge

  * Copyright © 2022 SINTEF Energy Research.

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

  */


 #ifndef CD_Photon_H

 #define CD_Photon_H


 // Std includes

 #include <string>

 #include <typeinfo>

 #include <cstdio>

 #include <cmath>


 // Our includes

 #include <CD_GenericParticle.H>

 #include <CD_NamespaceHeader.H>


 class Photon : public GenericParticle<2, 1>

 {

 public:

   inline Photon();


   inline Photon(const RealVect& a_position, const RealVect& a_velocity, const Real& a_kappa, const Real a_weight = 1.0);


   inline virtual ~Photon();


   inline void

   define(const RealVect& a_position, const RealVect& a_velocity, const Real& a_kappa, const Real a_weight = 1.0);


   inline Real&

   weight();


   inline const Real&

   weight() const;


   inline Real&

   kappa();


   inline const Real&

   kappa() const;


   inline RealVect&

   velocity();


   inline const RealVect&

   velocity() const;

 };


 #include <CD_NamespaceFooter.H>


 #include <CD_PhotonImplem.H>


 #endif

CD_GenericParticle.H
Declaration of a generic particle class.

CD_PhotonImplem.H
Implementation of CD_Photon.H.

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

Photon
Particle class for usage with Monte Carlo radiative transfer.
Definition: CD_Photon.H:29

Photon::velocity
RealVect & velocity()
Get photon velocity.
Definition: CD_PhotonImplem.H:64

Photon::define
void define(const RealVect &a_position, const RealVect &a_velocity, const Real &a_kappa, const Real a_weight=1.0)
Define function. Sets all parameters.
Definition: CD_PhotonImplem.H:31

Photon::Photon
Photon()
Default constructor. Must subsequently set all parameters.
Definition: CD_PhotonImplem.H:19

Photon::weight
Real & weight()
Get photon weight.
Definition: CD_PhotonImplem.H:40

Photon::~Photon
virtual ~Photon()
Destructor (does nothing)
Definition: CD_PhotonImplem.H:22

Photon::kappa
Real & kappa()
Get photon absorption length.
Definition: CD_PhotonImplem.H:52