NMPB08 Shared Libraries
Public Member Functions | Protected Member Functions | Protected Attributes
GroundEffectNMPB::GroundEffect Class Reference

Class used to calculate ground effects. More...

#include <GroundEffect.h>

List of all members.

Public Member Functions

 GroundEffect ()
 Initialization of the GroundEffect class.
 GroundEffect (double dp, double zEqS, double zEqR, double Gpath, double Gsource, double freq, GroundCalculationType groundCalculationType)
 Initialization of the GroundEffect class.
double AttenuationCalculationH ()
 Calculates homogeneous attenuation.
double AttenuationCalculationF ()
 Calculates favorable attenuation.
double get_AsolH ()
 Gets ground effect attenuation in homogeneous conditions.
double get_AsolF ()
 Gets ground effect attenuation in favorable conditions.
double Get_zEqSource ()
 Gets equivalent height of S measured perpendicular to the mean ground plane.
double Get_zEqReceiver ()
 Gets equivalent height of R measured perpendicular to the mean ground plane.
double Get_zEqSource_f ()
 Gets equivalent height of S measured perpendicular to the mean ground plane in favorable conditions.
double Get_zEqReceiver_f ()
 Gets equivalent height of R measured perpendicular to the mean ground plane in favorable conditions.
double get_EquivalentGpath ()
 Gets equivalent ground coefficient along a propagation path.

Protected Member Functions

void CorrectedGroundCoeffCalculation ()
 Calculates corrected ground sound absorption.
double WparamCalculation (double Gw)
 Calculates the w parameter.
void CfCalculation ()
 Calculates the Cf parameter.
void KfreqCalculation ()
 Calculates the k parameter.
double AttenuationCalculation (double z1, double z2, double cf)
 : Calculates attenuation

Protected Attributes

double _dp
 distance between source and receiver on the mean plane
double _zEqS
 S equivalent height in homogeneous conditions.
double _zEqR
 R equivalent height in homogeneous conditions.
double _zEqS_f
 S equivalent height in favorable conditions.
double _zEqR_f
 R equivalent height in favorable conditions.
double _freq
 center frequency fm
double _Gpath
 ground coefficient
double _Gsource
 source ground coefficient
double _correctedGpath
 corrected ground coefficient (with d and z)
GroundCalculationType _groundCalculationType
 ground Calculation Type (Enum) used to know when using _Gpath or _correctedGpath
double _kFreq
 k parameter depending on the frequency fm
double _cfH
 Cf parameter depending on the distance and w, for homogeneous or favorable conditions.
double _cfF
double _AsolH
 ground effect attenuation in homogeneous conditions
double _AsolF
 ground effect attenuation in favorable conditions

Detailed Description

Class used to calculate ground effects.

p. 38-44 - § 9.3

Definition at line 247 of file GroundEffect.h.


Constructor & Destructor Documentation

GroundEffectNMPB::GroundEffect::GroundEffect ( ) [inline]

Initialization of the GroundEffect class.

Definition at line 254 of file GroundEffect.h.

GroundEffectNMPB::GroundEffect::GroundEffect ( double  dp,
double  zEqS,
double  zEqR,
double  Gpath,
double  Gsource,
double  freq,
GroundCalculationType  groundCalculationType 
) [inline]

Initialization of the GroundEffect class.

Parameters:
dp: distance between source and receiver on the mean plane
zEqS: S equivalent height
zEqR: R equivalent height
Gpath: ground coefficient
Gsource: source ground coefficient
freq: center frequency
groundCalculationType: ground calculation type (Asol, DeltaSol_SO or DeltaSol_OR)

GroundEffect Initialization with SR mean plane distance, equivalent heights, and center frequency

Definition at line 293 of file GroundEffect.h.


Member Function Documentation

double GroundEffectNMPB::GroundEffect::AttenuationCalculation ( double  z1,
double  z2,
double  cf 
) [protected]

: Calculates attenuation

Parameters:
z1: source equivalent height
z2: receiver equivalent height
cf: Cf parameter
Returns:
: calculated attenuation

Attenuation calculation depending on distances, heights, frequencies and ground type p. 41 - § 9.3.3 formula (23) before calling max

Exceptions:
ERRDivZero,ERRSqrtNegative

Definition at line 306 of file GroundEffect.cpp.

double GroundEffectNMPB::GroundEffect::AttenuationCalculationF ( )

Calculates favorable attenuation.

Returns:
Asol,H : favorable attenuation

Attenuation calculation in favorable propagation conditions, depending on distances, heights, frequency and ground type p. 42 - § 9.3.4 using formula (23) and (27)

Exceptions:
ERRDivZero
Returns:
Asol,F : favorable attenuation

Attenuation calculation in favorable propagation conditions, depending on distances, heights, frequency and ground type p. 42 - § 9.3.4 using formula (23) and (27)

Exceptions:
ERRDivZero

Definition at line 387 of file GroundEffect.cpp.

double GroundEffectNMPB::GroundEffect::AttenuationCalculationH ( )

Calculates homogeneous attenuation.

Returns:
Asol,H : homogeneous attenuation

Attenuation calculation in homogeneous propagation conditions, depending on distances, heights, frequency and ground type p. 41 - § 9.3.3 formula (23)

Definition at line 344 of file GroundEffect.cpp.

void GroundEffectNMPB::GroundEffect::CfCalculation ( ) [protected]

Calculates the Cf parameter.

Cf parameter calculation : used in the ground attenuation calculation p. 41 - § 9.3.3 formula (24)

Exceptions:
ERRDivZero

Definition at line 236 of file GroundEffect.cpp.

void GroundEffectNMPB::GroundEffect::CorrectedGroundCoeffCalculation ( ) [protected]

Calculates corrected ground sound absorption.

Calculates Gpath' : correct Gpath depending on distances p. 39 - § 9.3.2 formula (22)

Definition at line 188 of file GroundEffect.cpp.

double GroundEffectNMPB::GroundEffect::get_AsolF ( ) [inline]

Gets ground effect attenuation in favorable conditions.

Returns:
ground effect attenuation in favorable conditions

Definition at line 353 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::get_AsolH ( ) [inline]

Gets ground effect attenuation in homogeneous conditions.

Returns:
ground effect attenuation in homogeneous conditions

Definition at line 344 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::get_EquivalentGpath ( ) [inline]

Gets equivalent ground coefficient along a propagation path.

Returns:
equivalent ground coefficient along a propagation path

Definition at line 403 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::Get_zEqReceiver ( ) [inline]

Gets equivalent height of R measured perpendicular to the mean ground plane.

Returns:
equivalent height of R measured perpendicular to the mean ground plane

Definition at line 373 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::Get_zEqReceiver_f ( ) [inline]

Gets equivalent height of R measured perpendicular to the mean ground plane in favorable conditions.

Returns:
equivalent height of R measured perpendicular to the mean ground plane in favorable conditions

Definition at line 393 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::Get_zEqSource ( ) [inline]

Gets equivalent height of S measured perpendicular to the mean ground plane.

Returns:
equivalent height of S measured perpendicular to the mean ground plane

Definition at line 363 of file GroundEffect.h.

double GroundEffectNMPB::GroundEffect::Get_zEqSource_f ( ) [inline]

Gets equivalent height of S measured perpendicular to the mean ground plane in favorable conditions.

Returns:
equivalent height of S measured perpendicular to the mean ground plane in favorable conditions

Definition at line 383 of file GroundEffect.h.

void GroundEffectNMPB::GroundEffect::KfreqCalculation ( ) [protected]

Calculates the k parameter.

k parameter calculation : used in the ground attenuation calculation p. 41 - § 9.3.3 formula (23)

Definition at line 285 of file GroundEffect.cpp.

double GroundEffectNMPB::GroundEffect::WparamCalculation ( double  Gw) [protected]

Calculates the w parameter.

w parameter calculation : used in Cf calculation for ground attenuation p. 41 - § 9.3.3 formula (25)

Parameters:
Gw: Gpath or corrected Gpath
Exceptions:
ERRDivZero

Definition at line 211 of file GroundEffect.cpp.


Member Data Documentation

ground effect attenuation in favorable conditions

Definition at line 466 of file GroundEffect.h.

ground effect attenuation in homogeneous conditions

Definition at line 462 of file GroundEffect.h.

Definition at line 457 of file GroundEffect.h.

Cf parameter depending on the distance and w, for homogeneous or favorable conditions.

Definition at line 457 of file GroundEffect.h.

corrected ground coefficient (with d and z)

Definition at line 444 of file GroundEffect.h.

distance between source and receiver on the mean plane

Definition at line 412 of file GroundEffect.h.

center frequency fm

Definition at line 432 of file GroundEffect.h.

ground coefficient

Definition at line 436 of file GroundEffect.h.

ground Calculation Type (Enum) used to know when using _Gpath or _correctedGpath

Definition at line 448 of file GroundEffect.h.

source ground coefficient

Definition at line 440 of file GroundEffect.h.

k parameter depending on the frequency fm

Definition at line 453 of file GroundEffect.h.

R equivalent height in homogeneous conditions.

Definition at line 420 of file GroundEffect.h.

R equivalent height in favorable conditions.

Definition at line 428 of file GroundEffect.h.

S equivalent height in homogeneous conditions.

Definition at line 416 of file GroundEffect.h.

S equivalent height in favorable conditions.

Definition at line 424 of file GroundEffect.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines