gstlrn::TurningBandDirection Class Reference

#include <TurningBandDirection.hpp>

Detailed Description

Class for management of Directions used in Turning Band algorithm Remark: The 3-D definition is compulsory (even in 2-D)

Public Member Functions
	TurningBandDirection ()
	TurningBandDirection (const TurningBandDirection &r)
TurningBandDirection &	operator= (const TurningBandDirection &r)
virtual	~TurningBandDirection ()
const &	getAng () const
double	getAng (Id i) const
double	getDXP () const
double	getDYP () const
double	getDZP () const
double	getT00 () const
double	getTmax () const
double	getTmin () const
double	getScale () const
void	setAng (const 1 &ang)
void	setAng (Id i, double value)
void	setDXP (double dxp)
void	setDYP (double dyp)
void	setDZP (double dzp)
void	setT00 (double t00)
void	setTmax (double tmax)
void	setTmin (double tmin)
void	setScale (double scale)
double	projectPoint (const Db *db, Id iech) const
double	projectGrid (const DbGrid *db, Id ix, Id iy, Id iz) const
void	dump (bool flagGrid=true) const

Constructor & Destructor Documentation

TurningBandDirection() [1/2]

gstlrn::TurningBandDirection::TurningBandDirection

(

)

TurningBandDirection() [2/2]

gstlrn::TurningBandDirection::TurningBandDirection

(

const TurningBandDirection &

r

)

~TurningBandDirection()

gstlrn::TurningBandDirection::~TurningBandDirection ( )

virtual

Member Function Documentation

dump()

void gstlrn::TurningBandDirection::dump

(

bool

flagGrid = true

)

const

getAng() [1/2]

const & gstlrn::TurningBandDirection::getAng ( ) const

inline

getAng() [2/2]

double gstlrn::TurningBandDirection::getAng ( Id  i ) const

inline

getDXP()

double gstlrn::TurningBandDirection::getDXP ( ) const

inline

getDYP()

double gstlrn::TurningBandDirection::getDYP ( ) const

inline

getDZP()

double gstlrn::TurningBandDirection::getDZP ( ) const

inline

getScale()

double gstlrn::TurningBandDirection::getScale ( ) const

inline

getT00()

double gstlrn::TurningBandDirection::getT00 ( ) const

inline

getTmax()

double gstlrn::TurningBandDirection::getTmax ( ) const

inline

getTmin()

double gstlrn::TurningBandDirection::getTmin ( ) const

inline

operator=()

TurningBandDirection & gstlrn::TurningBandDirection::operator=

(

const TurningBandDirection &

r

)

projectGrid()

double gstlrn::TurningBandDirection::projectGrid	(	const DbGrid *	db,
		Id	ix,
		Id	iy,
		Id	iz
	)		const

Calculates the projection of a grid node on a turning band

Returns

Projection value

Parameters

[in]	db	Db structure
[in]	ix	grid index along X
[in]	iy	grid index along Y
[in]	iz	grid index along Z

projectPoint()

double gstlrn::TurningBandDirection::projectPoint	(	const Db *	db,
		Id	iech
	)		const

Calculates the projection of a point on a turning band

Returns

Projection value

Parameters

[in]	db	Db structure
[in]	iech	rank of the sample

setAng() [1/2]

void gstlrn::TurningBandDirection::setAng ( const 1 &  ang )

inline

setAng() [2/2]

void gstlrn::TurningBandDirection::setAng ( Id  i, double  value  )

inline

setDXP()

void gstlrn::TurningBandDirection::setDXP ( double  dxp )

inline

setDYP()

void gstlrn::TurningBandDirection::setDYP ( double  dyp )

inline

setDZP()

void gstlrn::TurningBandDirection::setDZP ( double  dzp )

inline

setScale()

void gstlrn::TurningBandDirection::setScale ( double  scale )

inline

setT00()

void gstlrn::TurningBandDirection::setT00 ( double  t00 )

inline

setTmax()

void gstlrn::TurningBandDirection::setTmax ( double  tmax )

inline

setTmin()

void gstlrn::TurningBandDirection::setTmin ( double  tmin )

inline

---

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

• include/Simulation/TurningBandDirection.hpp
• src/Simulation/TurningBandDirection.cpp