t_magnetic Struct Reference

#include <magnetic.h>

Inheritance diagram for t_magnetic:

Collaboration diagram for t_magnetic:

Public Member Functions
const char *	chName () const
void	zero (void)
void	comment (t_warnings &)
Public Member Functions inherited from module
	module ()
virtual	~module ()

Data Fields
bool	lgB
double	EnthalpyDensity
double	pressure
double	energydensity

Detailed Description

Definition at line 23 of file magnetic.h.

Member Function Documentation

const char* t_magnetic::chName ( ) const

inlinevirtual

Implements module.

Definition at line 25 of file magnetic.h.

void t_magnetic::comment ( t_warnings &  )

inlinevirtual

Implements module.

Definition at line 32 of file magnetic.h.

void t_magnetic::zero ( void  )

virtual

zero initialize magnetic field parameters

Implements module.

Definition at line 133 of file magnetic.cpp.

References Bpar_here, Bpar_init, Btan_here, Btan_init, Btangl_here, Btangl_init, DEBUG_ENTRY, energydensity, EnthalpyDensity, gamma_mag, lgB, lgBinitialized, and pressure.

Field Documentation

double t_magnetic::energydensity

energy density at current location, this is positive

Definition at line 44 of file magnetic.h.

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

double t_magnetic::EnthalpyDensity

enthalpy density associated with field

Definition at line 38 of file magnetic.h.

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

bool t_magnetic::lgB

this says mag fields are turned on

Definition at line 35 of file magnetic.h.

Referenced by Magnetic_evaluate(), ParseMagnet(), PrtComment(), and zero().

double t_magnetic::pressure

this is magnetic pressure at current location - this can be negative for ordered field

Definition at line 41 of file magnetic.h.

Referenced by CoolEvaluate(), Magnetic_evaluate(), t_mean::MeanInc(), PresTotCurrent(), PrtZone(), SaveDo(), and zero().

---

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

• magnetic.h
• magnetic.cpp