JPHYSICS::JAbstractMedium Class Reference

Medium interface. More...

#include <JAbstractMedium.hh>

Inheritance diagram for JPHYSICS::JAbstractMedium:

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

~JAbstractMedium()

virtual JPHYSICS::JAbstractMedium::~JAbstractMedium ( )

inlinevirtual

Virtual destructor.

Definition at line 22 of file JAbstractMedium.hh.

    {}

Member Function Documentation

getAbsorptionLength()

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

pure virtual

Absorption length.

Parameters

lambda

wavelenth [nm]

Returns

absorption length [m]

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

getScatteringLength()

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

pure virtual

Scattering length.

Parameters

lambda

wavelenth [nm]

Returns

scattering length [m]

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

getScatteringProbability()

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

ct	cosine scattering angle

Returns

probability

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

---

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

• JAbstractMedium.hh