#include <doppvel.h>
Public Member Functions | |
| const char * | chName () const |
| void | zero () |
| void | comment (t_warnings &) |
| Public Member Functions inherited from module | |
| module () | |
| virtual | ~module () |
Public Attributes | |
| realnum | TurbVel |
| realnum | TurbVelZero |
| realnum | TurbVelLaw |
| bool | lgTurbLawOn |
| realnum | Heiles_Troland_F |
| bool | lgTurb_pressure |
| bool | lgTurbEquiMag |
| realnum | DispScale |
Detailed Description
Member Function Documentation
◆ chName()
|
inlinevirtual |
Implements module.
◆ comment()
|
inlinevirtual |
Implements module.
◆ zero()
|
virtual |
Implements module.
References DEBUG_ENTRY, DispScale, Heiles_Troland_F, lgTurb_pressure, lgTurbEquiMag, lgTurbLawOn, TurbVel, and TurbVelLaw.
Member Data Documentation
◆ DispScale
| realnum t_DoppVel::DispScale |
The scale in cm over which the turbulence is dissipated. Normally 0, only set if dissipate keyword appears on turbulence command, entered as log of scale
Referenced by zero().
◆ Heiles_Troland_F
| realnum t_DoppVel::Heiles_Troland_F |
this is the factor F in equation 34 of
>refer pressure turb Heiles, C. & Troland, T.H. 2005, 624, 773
Referenced by zero().
◆ lgTurb_pressure
| bool t_DoppVel::lgTurb_pressure |
is TurbVel included in pressure? - can be done two ways, with the velocity being set of with equipartition - true when TurbVel set if not equipartition, false with NO PRESSURE option on turbulence command
Referenced by zero().
◆ lgTurbEquiMag
| bool t_DoppVel::lgTurbEquiMag |
equipartition option on turbulence command, to set turbulence from B if true then TurbVel set from B
Referenced by zero().
◆ lgTurbLawOn
| bool t_DoppVel::lgTurbLawOn |
this flag says that a turbulent velocity law (as a function of depth) has been set with the vlaw command
Referenced by zero().
◆ TurbVel
| realnum t_DoppVel::TurbVel |
this is the turbulent velocity in cm/s, normally zero, set with turbulence command
Referenced by zero().
◆ TurbVelLaw
| realnum t_DoppVel::TurbVelLaw |
this is the turbulent velocity in cm/s, normally zero, set with turbulence command
Referenced by zero().
◆ TurbVelZero
| realnum t_DoppVel::TurbVelZero |
this is the turbulent velocity in cm/s at the beginning of the calculation, this is only important if turbulence law is set with vlaw command
The documentation for this struct was generated from the following files:
