doxygen/html/CD__RtSpecies_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_RtSpecies_H

 #define CD_RtSpecies_H


 // Std includes

 #include <functional>


 // Chombo includes

 #include <RealVect.H>


 // Our includes

 #include <CD_NamespaceHeader.H>


 class RtSpecies

 {

 public:

   RtSpecies();


   virtual ~RtSpecies();


   std::string

   getName() const;


   virtual Real

   getAbsorptionCoefficient(const RealVect a_pos) const = 0;


   virtual Real

   getScatteringCoefficient(const RealVect a_pos) const;


 protected:

   std::string m_name;

 };


 #include <CD_NamespaceFooter.H>


 #endif

RtSpecies
Declaration of a class that defines an interface to radiative transfer solvers, i....
Definition: CD_RtSpecies.H:30

RtSpecies::getAbsorptionCoefficient
virtual Real getAbsorptionCoefficient(const RealVect a_pos) const =0
Get kappa (i.e. the inverse absorption length) at physical coordinates.

RtSpecies::getName
std::string getName() const
Get species name.
Definition: CD_RtSpecies.cpp:26

RtSpecies::m_name
std::string m_name
Group name.
Definition: CD_RtSpecies.H:67

RtSpecies::RtSpecies
RtSpecies()
Weak constructor. Sets absorption length and scattering coefficients to one.
Definition: CD_RtSpecies.cpp:16

RtSpecies::getScatteringCoefficient
virtual Real getScatteringCoefficient(const RealVect a_pos) const
Get scattering coefficient (i.e. the inverse scattering length) at physical coordinates.
Definition: CD_RtSpecies.cpp:32

RtSpecies::~RtSpecies
virtual ~RtSpecies()
Weak constructor. Sets absorption length and scattering coefficients to one.
Definition: CD_RtSpecies.cpp:22