#include <doppvel.h>

Inheritance diagram for t_DoppVel:

Collaboration diagram for t_DoppVel:

Public Member Functions
const char *	chName () const

void	zero ()

void	comment (t_warnings &)

Public Member Functions inherited from module
	module ()

virtual	~module ()

Data Fields
realnum	TurbVel

realnum	TurbVelZero

realnum	TurbVelLaw

bool	lgTurbLawOn

realnum	Heiles_Troland_F

bool	lgTurb_pressure

bool	lgTurbEquiMag

realnum	DispScale

Detailed Description

doppvel.h

Definition at line 10 of file doppvel.h.

Member Function Documentation

const char* t_DoppVel::chName ( ) const

inlinevirtual

Implements module.

Definition at line 11 of file doppvel.h.

void t_DoppVel::comment ( t_warnings & )

inlinevirtual

Implements module.

Definition at line 17 of file doppvel.h.

void t_DoppVel::zero ( void )

virtual

Implements module.

Definition at line 7 of file doppvel.cpp.

References DEBUG_ENTRY, DispScale, Heiles_Troland_F, lgTurb_pressure, lgTurbEquiMag, lgTurbLawOn, TurbVel, and TurbVelLaw.

Field Documentation

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

Definition at line 51 of file doppvel.h.

Referenced by GetAveVelocity(), GetDopplerWidth(), highen(), lgConserveEnergy(), ParseTurbulence(), and zero().

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

Definition at line 37 of file doppvel.h.

Referenced by Magnetic_evaluate(), ParseTurbulence(), PresTotCurrent(), and zero().

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

Definition at line 42 of file doppvel.h.

Referenced by ParseTurbulence(), PresTotCurrent(), SaveDo(), and zero().

bool t_DoppVel::lgTurbEquiMag

equipartition option on turbulence command, to set turbulence from B if true then TurbVel set from B

Definition at line 46 of file doppvel.h.

Referenced by Magnetic_evaluate(), ParseTurbulence(), and zero().

bool t_DoppVel::lgTurbLawOn

this flag says that a turbulent velocity law (as a function of depth) has been set with the vlaw command

Definition at line 33 of file doppvel.h.

Referenced by ParseVLaw(), zero(), and ZoneStart().

realnum t_DoppVel::TurbVel

this is the turbulent velocity in cm/s, normally zero, set with turbulence command

Definition at line 21 of file doppvel.h.

Referenced by GetAveVelocity(), GetDopplerWidth(), highen(), Magnetic_evaluate(), ParseTurbulence(), PresTotCurrent(), PrtComment(), SaveDo(), zero(), and ZoneStart().

realnum t_DoppVel::TurbVelLaw

this is the turbulent velocity in cm/s, normally zero, set with turbulence command

Definition at line 29 of file doppvel.h.

Referenced by ParseVLaw(), zero(), and ZoneStart().

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

Definition at line 25 of file doppvel.h.

Referenced by ParseTurbulence(), and ZoneStart().

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

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation