Jpp  17.0.0-rc.1
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
JPHYSICS::JAbstractMedium Class Referenceabstract

Medium interface. More...

#include <JAbstractMedium.hh>

Inheritance diagram for JPHYSICS::JAbstractMedium:
JPHYSICS::JLED JPHYSICS::JPDF JPHYSICS::JLED_C JPHYSICS::JAbstractPDF JPHYSICS::JPDF_C

Public Member Functions

virtual ~JAbstractMedium ()
 Virtual destructor. More...
 
virtual double getAbsorptionLength (const double lambda) const =0
 Absorption length. More...
 
virtual double getScatteringLength (const double lambda) const =0
 Scattering length. More...
 
virtual double getScatteringProbability (const double ct) const =0
 Model specific function to describe light scattering in water (integral over full solid angle normalised to unity). More...
 

Detailed Description

Medium interface.

Definition at line 17 of file JAbstractMedium.hh.

Constructor & Destructor Documentation

virtual JPHYSICS::JAbstractMedium::~JAbstractMedium ( )
inlinevirtual

Virtual destructor.

Definition at line 22 of file JAbstractMedium.hh.

23  {}

Member Function Documentation

virtual double JPHYSICS::JAbstractMedium::getAbsorptionLength ( const double  lambda) const
pure virtual

Absorption length.

Parameters
lambdawavelenth [nm]
Returns
absorption length [m]

Implemented in JPHYSICS::JPDF_C, and JPHYSICS::JLED_C.

virtual double JPHYSICS::JAbstractMedium::getScatteringLength ( const double  lambda) const
pure virtual

Scattering length.

Parameters
lambdawavelenth [nm]
Returns
scattering length [m]

Implemented in JPHYSICS::JPDF_C, and JPHYSICS::JLED_C.

virtual double JPHYSICS::JAbstractMedium::getScatteringProbability ( const double  ct) const
pure virtual

Model specific function to describe light scattering in water (integral over full solid angle normalised to unity).

Parameters
ctcosine scattering angle
Returns
probability

Implemented in JPHYSICS::JPDF_C, and JPHYSICS::JLED_C.


The documentation for this class was generated from the following file: