sim::LayeredVelModel< ParamsT, LayerT > Class Template Reference

#include <sim_vel_model.hpp>

Inheritance diagram for sim::LayeredVelModel< ParamsT, LayerT >:

Public Member Functions
virtual void	appendLayer (const LayerT &layer, const ParamsT &params)=0
virtual size_t	layersNum () const =0
virtual const LayerT &	layer (const size_t id) const =0
virtual const ParamsT &	params (const size_t id) const =0
virtual void	removeLayer (const size_t id)=0
virtual void	clear ()=0
Public Member Functions inherited from sim::VelModel< ParamsT >
virtual const ParamsT &	operator() (const Point2D &coords) const =0

Detailed Description

template<typename ParamsT, typename LayerT>
class sim::LayeredVelModel< ParamsT, LayerT >

Layered velocity model. Provides interface for Parameters(x,z) and Layers of the model. ParamsT - type of parameters. LayerT - type of velocity model layer.

Member Function Documentation

template<typename ParamsT, typename LayerT>

virtual void sim::LayeredVelModel< ParamsT, LayerT >::appendLayer ( const LayerT &  layer, const ParamsT &  params  )

pure virtual

Append layer with parameters to the model. 

Parameters

layer	new layer to be appended.
params	parameters relating to the layer.

Implemented in sim::VelModel1D2D< ParamsT >.

template<typename ParamsT, typename LayerT>

virtual void sim::LayeredVelModel< ParamsT, LayerT >::clear ( )

pure virtual

Remove all layers.

Implemented in sim::VelModel1D2D< ParamsT >.

template<typename ParamsT, typename LayerT>

virtual const LayerT& sim::LayeredVelModel< ParamsT, LayerT >::layer ( const size_t  id ) const

pure virtual

Get layer with provided index.

Parameters

id	Index of required layer.

Returns

layer or dummy layer if id is out of range.

Implemented in sim::VelModel1D2D< ParamsT >.

template<typename ParamsT, typename LayerT>

virtual size_t sim::LayeredVelModel< ParamsT, LayerT >::layersNum ( ) const

pure virtual

Current number of layers in the model. 

Returns

number of layers.

Implemented in sim::VelModel1D2D< ParamsT >.

template<typename ParamsT, typename LayerT>

virtual const ParamsT& sim::LayeredVelModel< ParamsT, LayerT >::params ( const size_t  id ) const

pure virtual

Get parameters of the layer with provided index.

Parameters

id	Index of required layer.

Returns

layer parameters or dummy layer if id is out of range.

Implemented in sim::VelModel1D2D< ParamsT >.

template<typename ParamsT, typename LayerT>

virtual void sim::LayeredVelModel< ParamsT, LayerT >::removeLayer ( const size_t  id )

pure virtual

Remove layer with provided index.

Parameters

id	Index of the layer. Removes the last layer if id is out of range.

Implemented in sim::VelModel1D2D< ParamsT >.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/s2proc/sim_vel_model.hpp