taup::TPdDistdr< V > Class Template Reference

Distance Integrand. Integrating this function over radius yields distance. More...

#include <TPVelocityModels.h>

Public Member Functions
	TPdDistdr (V &v)
	Standard constructor. More...
	TPdDistdr (const TPdDistdr< V > &di)
	Copy constructor. More...
virtual	~TPdDistdr ()
	Destructor. More...
TPdDistdr &	operator= (const TPdDistdr< V > &di)
	Assignment Operator. More...
double	operator() (double r)
	Function operator that returns the result of the distance integrand evaluated at the input radius r. More...
void	setP (double p)
	Sets the ray parameter to the input value p. More...

Detailed Description

template<class V>
class taup::TPdDistdr< V >

Distance Integrand. Integrating this function over radius yields distance.

This is the 1D radially symetric layered model distance integrand given by

                     p v(r)
dDist/dr = --------------------------
           r sqrt(r^2 - (p v(r))^2)

This object requires the velocity model as a template parameter (V) from which the velocity at a radial position (v(r)) is found. The ray parameter (p) is set with the function setP(). The velocity model is set at construction and cannot be changed once defined.

The equation above is defined in the overloaded function operator() which is called by the numerical integration facility to integrate the function.

Definition at line 100 of file TPVelocityModels.h.

Constructor & Destructor Documentation

TPdDistdr() [1/2]

template<class V >

taup::TPdDistdr< V >::TPdDistdr ( V &  v )

inline

Standard constructor.

This is the only means of setting the velocity model into the integrand. The ray parameter is initialized to 0.

Definition at line 108 of file TPVelocityModels.h.

TPdDistdr() [2/2]

template<class V >

taup::TPdDistdr< V >::TPdDistdr ( const TPdDistdr< V > &  di )

inline

Copy constructor.

Definition at line 111 of file TPVelocityModels.h.

~TPdDistdr()

template<class V >

virtual taup::TPdDistdr< V >::~TPdDistdr ( )

inlinevirtual

Destructor.

Definition at line 114 of file TPVelocityModels.h.

Member Function Documentation

operator()()

template<class V >

double taup::TPdDistdr< V >::operator() ( double  r )

inline

Function operator that returns the result of the distance integrand evaluated at the input radius r.

Definition at line 129 of file TPVelocityModels.h.

operator=()

template<class V >

TPdDistdr& taup::TPdDistdr< V >::operator= ( const TPdDistdr< V > &  di )

inline

Assignment Operator.

Since the velocity model is set by reference it cannot be changed. The assignment operator simply sets the ray parameter as defined in the input TPdDistdr

Definition at line 121 of file TPVelocityModels.h.

setP()

template<class V >

void taup::TPdDistdr< V >::setP ( double  p )

inline

Sets the ray parameter to the input value p.

Definition at line 140 of file TPVelocityModels.h.

---

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

• rstt/SLBM/include/TPVelocityModels.h