LineBroadener Class Reference

Base class for classes implementing line shapes of various types. More...

#include <LineBroadener.h>

Inheritance diagram for LineBroadener:

Public Member Functions
	LineBroadener ()
	Default constructor. More...
virtual	~LineBroadener ()
	Destructor. More...
virtual doublereal	profile (doublereal deltaFreq)
	The line shape profile \[ P(\Delta\nu) *\] as a function of distance from line center \( \Delta\nu \). More...
doublereal	operator() (doublereal deltaFreq)
virtual doublereal	cumulative (doublereal deltaFreq)
	The cumulative profile, defined as \[ C(\Delta \nu) = \int_{-\infty}^{\Delta \nu} P(x) dx \] . More...
virtual doublereal	width ()

Detailed Description

Base class for classes implementing line shapes of various types.

Deprecated:

incomplete / abandoned

Definition at line 20 of file LineBroadener.h.

Constructor & Destructor Documentation

LineBroadener ( )

inline

Default constructor.

Definition at line 26 of file LineBroadener.h.

References Cantera::warn_deprecated().

virtual ~LineBroadener ( )

inlinevirtual

Destructor.

Definition at line 31 of file LineBroadener.h.

Member Function Documentation

virtual doublereal profile ( doublereal  deltaFreq )

inlinevirtual

The line shape profile

\[ P(\Delta\nu) *\]

as a function of distance from line center \( \Delta\nu \).

This function must have total area = 1.0. Note that this method must be overloaded in each derived class. If the base class method is called, an exception will be thrown.

Reimplemented in Voigt, GaussianProfile, and LorentzianProfile.

Definition at line 45 of file LineBroadener.h.

virtual doublereal cumulative ( doublereal  deltaFreq )

inlinevirtual

The cumulative profile, defined as

\[ C(\Delta \nu) = \int_{-\infty}^{\Delta \nu} P(x) dx \]

.

Reimplemented in GaussianProfile, and LorentzianProfile.

Definition at line 60 of file LineBroadener.h.

---

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

• LineBroadener.h