meteoLin Class Reference

Class to define linear gradient for wind and sound speed. More...

#include <meteoLin.h>

Inheritance diagram for meteoLin:

Collaboration diagram for meteoLin:

Public Member Functions
	meteoLin ()
	Default constructor. More...
	meteoLin (const double &windAngle, const double &sound_speed, const double &gradC=0., const double &gradV=0.)
	Constructor. More...
	~meteoLin ()
	Destructor. More...
void	setGradC (const double &g)
	Set speed gradient. More...
double	getGradC () const
	Get speed gradient. More...
void	setGradV (const double &g)
	Set wind gradient. More...
double	getGradV () const
	Get wind gradient. More...
double	cTemp (const vec3 &P, vec3 &grad) const
	Compute speed gradient and sound speed on a position. More...
vec3	cWind (const vec3 &P) const
	Compute wind on a given position. More...
virtual const array< array< double, 3 >, 3 > &	getJacobMatrix ()
	Get the jacobian matrix. More...
virtual void	init ()
	Initialize the Jacobian matrix. More...
Public Member Functions inherited from meteo
	meteo ()
	Default constructor. More...
	meteo (const double &windAngle, const double &sound_speed)
	Constructor. More...
	~meteo ()
virtual void	setC0 (const double &c)
	Set sound speed. More...
virtual double	getC0 () const
	Get sound speed. More...
virtual void	setWindAngle (const double &windAngle)
	Define wind: angle given in windrose orientation (clockwise angle with 0 for a wind from north to south) More...
virtual double	getWindAngle () const
	Get the windrose oriented wind angle in radian (clockwise angle with 0 for a wind from north to south) More...

Private Attributes
double	grad_C
	Sound speed gradient. More...
double	grad_V
	Wind gradient. More...
array< array< double, 3 >, 3 >	jacob_matrix
	Jacobian matrix. More...

Additional Inherited Members
Protected Attributes inherited from meteo
double	c0
	Ground sound speed (z = 0) More...
double	wind_angle
	The windrose oriented wind angle in radian (clockwise angle with 0 for a wind from north to south) More...

Detailed Description

Class to define linear gradient for wind and sound speed.

Definition at line 33 of file meteoLin.h.

Constructor & Destructor Documentation

meteoLin() [1/2]

meteoLin::meteoLin ( )

inline

Default constructor.

Definition at line 37 of file meteoLin.h.

meteoLin() [2/2]

meteoLin::meteoLin ( const double &  windAngle, const double &  sound_speed, const double &  gradC = 0., const double &  gradV = 0.  )

inline

Constructor.

Definition at line 39 of file meteoLin.h.

~meteoLin()

meteoLin::~meteoLin ( )

inline

Destructor.

Definition at line 47 of file meteoLin.h.

Member Function Documentation

cTemp()

double meteoLin::cTemp	(	const vec3 &	P,
		vec3 &	grad
	)		const

Compute speed gradient and sound speed on a position.

Parameters

[in]	P	Position
[out]	grad	Speed gradient according to z

Returns

Sound speed at position z

Definition at line 19 of file meteoLin.cpp.

cWind()

vec3 meteoLin::cWind

(

const vec3 &

P

)

const

Compute wind on a given position.

Parameters

P

Position

Returns

Wind

Definition at line 31 of file meteoLin.cpp.

getGradC()

double meteoLin::getGradC ( ) const

inline

Get speed gradient.

Definition at line 52 of file meteoLin.h.

getGradV()

double meteoLin::getGradV ( ) const

inline

Get wind gradient.

Definition at line 57 of file meteoLin.h.

getJacobMatrix()

const double ** meteoLin::getJacobMatrix ( )

inlinevirtual

Get the jacobian matrix.

Definition at line 80 of file meteoLin.h.

init()

void meteoLin::init ( )

virtual

Initialize the Jacobian matrix.

Reimplemented from meteo.

Definition at line 46 of file meteoLin.cpp.

setGradC()

void meteoLin::setGradC ( const double &  g )

inline

Set speed gradient.

Definition at line 50 of file meteoLin.h.

setGradV()

void meteoLin::setGradV ( const double &  g )

inline

Set wind gradient.

Definition at line 55 of file meteoLin.h.

Member Data Documentation

grad_C

double meteoLin::grad_C

private

Sound speed gradient.

Definition at line 86 of file meteoLin.h.

grad_V

double meteoLin::grad_V

private

Wind gradient.

Definition at line 87 of file meteoLin.h.

jacob_matrix

array< array<double, 3>, 3 > meteoLin::jacob_matrix

private

Jacobian matrix.

Definition at line 89 of file meteoLin.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AnalyticRayTracer/meteoLin.h
• /home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AnalyticRayTracer/meteoLin.cpp