SLBM  3.0
Regional Seismic Travel Time
Public Member Functions | Private Attributes | List of all members
taup::VZero< V > Class Template Reference

A function object used to zero-in on the velocity at r that gives the input ray parameter (vzP). The operator() returns r - vzP * vzV(r) where r is input and vzP is set and vzV(r) is the velocity function. This function object is used when r cannot be solved for explicitly.

#include <TPVelocityModels.h>

Public Member Functions

 VZero (double p, V &v)
 Standard constructor. More...
 
 VZero (const VZero &vz)
 Copy constructor. More...
 
virtual ~VZero ()
 Destructor. More...
 
VZerooperator= (const VZero &vz)
 Assignment operator. More...
 
double operator() (double r)
 

Private Attributes

double vzP
 A ray parameter that will be used to zero-in on r in the operator() function. More...
 
V & vzV
 The velocity model used to zeroin on r. More...
 

Constructor & Destructor Documentation

template<class V >
taup::VZero< V >::VZero ( double  p,
V &  v 
)
inline

Sets the velocity model, v, and the ray parameter, p, that will be used by a Brents function to zero-in on r.

template<class V >
taup::VZero< V >::VZero ( const VZero< V > &  vz)
inline
template<class V >
virtual taup::VZero< V >::~VZero ( )
inlinevirtual

Member Function Documentation

template<class V >
double taup::VZero< V >::operator() ( double  r)
inline

Standard operator() overload which returns the zero of r - p * vel(r). This function is used to zero-in on a value for the radius (r) given a ray parameter and a velocity model.

template<class V >
VZero& taup::VZero< V >::operator= ( const VZero< V > &  vz)
inline

Member Data Documentation

template<class V >
double taup::VZero< V >::vzP
private
template<class V >
V& taup::VZero< V >::vzV
private

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