#include <ExtinctionInterface.hpp>

Inheritance diagram for ExtinctionInterface:

Public Member Functions
virtual	~ExtinctionInterface ()
virtual double	getExtinctionOpticalDepth (const PhotonPacket *pp, double distance) const =0

Protected Member Functions
	ExtinctionInterface ()

Detailed Description

ExtinctionInterface is a pure interface implemented by the MediumSystem class. It offers instruments access to the extinction optical depth calculation performed by the medium system, without requiring the instrument module to link against the medium system's own module.

Constructor & Destructor Documentation

◆ ExtinctionInterface()

ExtinctionInterface::ExtinctionInterface ( )

inlineprotected

The empty constructor for the interface.

◆ ~ExtinctionInterface()

virtual ExtinctionInterface::~ExtinctionInterface ( )

inlinevirtual

The empty destructor for the interface.

Member Function Documentation

◆ getExtinctionOpticalDepth()

virtual double ExtinctionInterface::getExtinctionOpticalDepth	(	const PhotonPacket *	pp,
		double	distance ) const

pure virtual

This function calculates and returns the extinction optical depth along a path through the medium system defined by the initial position and direction of the specified PhotonPacket object and up to the specified distance. This function is intended for handling peel-off photon packets during the photon life cycle.

Implemented in MediumSystem.

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

ExtinctionInterface.hpp