chombo-discharge
Loading...
Searching...
No Matches
CD_Photon.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_PHOTON_H
14#define CD_PHOTON_H
15
16// Std includes
17#include <string>
18#include <typeinfo>
19#include <cstdio>
20#include <cmath>
21
22// Our includes
23#include <CD_GenericParticle.H>
24#include <CD_NamespaceHeader.H>
25
29class Photon : public GenericParticle<2, 1>
30{
31public:
35 inline Photon();
36
44 inline Photon(const RealVect& a_position, const RealVect& a_velocity, const Real& a_kappa, const Real a_weight = 1.0);
45
49 inline virtual ~Photon();
50
58 inline void
59 define(const RealVect& a_position, const RealVect& a_velocity, const Real& a_kappa, const Real a_weight = 1.0);
60
65 inline Real&
66 weight();
67
72 inline const Real&
73 weight() const;
74
79 inline Real&
80 kappa();
81
86 inline const Real&
87 kappa() const;
88
93 inline RealVect&
94 velocity();
95
100 inline const RealVect&
101 velocity() const;
102};
103
104#include <CD_NamespaceFooter.H>
105
106#include <CD_PhotonImplem.H>
107
108#endif
Declaration of a generic particle class.
Implementation of CD_Photon.H.
A generic particle class, holding the position and a specified number of real and vector values.
Definition CD_GenericParticle.H:77
Particle class for usage with Monte Carlo radiative transfer.
Definition CD_Photon.H:30
RealVect & velocity()
Get photon velocity.
Definition CD_PhotonImplem.H:65
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:32
Photon()
Default constructor. Must subsequently set all parameters.
Definition CD_PhotonImplem.H:20
Real & weight()
Get photon weight.
Definition CD_PhotonImplem.H:41
virtual ~Photon()
Destructor (does nothing)
Definition CD_PhotonImplem.H:23
Real & kappa()
Get photon absorption length.
Definition CD_PhotonImplem.H:53
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38