sim Namespace Reference

Namespaces
	fdm

Classes
class	VelModel
class	Impulse
class	RickerImpulse
class	DiracImpulse
class	UserImpulse
struct	Point2D
class	LayeredVelModel
class	VelModel1D2D
class	VmLayer1D2D
class	VmParamsIso
class	VmParamsAniso

Typedefs
typedef double	TimeT
typedef double	AmplT
typedef double	CoordT
typedef double	FreqT

Enumerations
enum	ImpulseType { IT_RICKER = 0, IT_DIRAC, IT_USER }
enum	CoordsMask { X_COORD = 1, Z_COORD = 2 }
enum	ErrCode {   EC_OK = 0, EC_EMPTY_WF, EC_USER_TERM, EC_FDM_STABILITY_COND,   EC_FDM_BAD_GRID_SIZE, EC_FDM_SRCS_INIT }

Functions
std::string	toString (const ImpulseType &it)
std::string	coordsMaskToString (const unsigned int &cm)
std::string	toString (const ErrCode &ec)

Detailed Description

Simulation.

Enumeration Type Documentation

enum sim::CoordsMask

Mask of coordinates.

Enumerator
X_COORD	X coordinate.
Z_COORD	Z coordinate.

enum sim::ErrCode

Error codes.

Enumerator
EC_OK	No errors.
EC_EMPTY_WF	Empty wavefield provided.
EC_USER_TERM	Terminated by user.
EC_FDM_STABILITY_COND	Stability condition failed.
EC_FDM_BAD_GRID_SIZE	Bad size of modelling grid.
EC_FDM_SRCS_INIT	Failed to initialize sources.

enum sim::ImpulseType

Type of impulse.

Enumerator
IT_RICKER	Ricker impulse.
IT_DIRAC	Dirac impulse.
IT_USER	User defined impulse.

Function Documentation

std::string sim::coordsMaskToString

(

const unsigned int &

cm

)

Get symbolic name of provided mask of coordinates.

std::string sim::toString

(

const ImpulseType &

it

)

Get symbolic name of impulse type.

std::string sim::toString

(

const ErrCode &

ec

)

Generates string with error description from provided ErrCode.