fieldmodels.dipole Class Reference

Inheritance diagram for fieldmodels.dipole:

Collaboration diagram for fieldmodels.dipole:

Public Member Functions
	__init__ (self, centerx, centery, centerz, tilt_phi, tilt_theta, mult=1.0, radius_f=None, radius_z=None)
	set_dipole (self, centerx, centery, centerz, tilt_phi, tilt_theta, mult=1.0, radius_f=None, radius_z=None)
	get_old (self, x, y, z, derivative, fComponent, dComponent)
	get_ldp (self, x, y, z, derivative, fComponent, dComponent)
	get (self, x, y, z, derivative, fComponent, dComponent)
	getX (self, x, y, z, derivative, fComponent, dComponent)

Public Attributes
	radius = np.zeros(2)
	q = np.zeros(3)
	center = np.zeros(3)
int	tilt_angle_phi = tilt_phi * math.pi/180.
int	tilt_angle_theta = tilt_theta * math.pi/180.
int	moment = mult*self.moment_base

Static Public Attributes
int	moment_base = 8.e15
int	minimumR = 1e-3*RE

Detailed Description

 Class generating dipole fields

Definition at line 34 of file fieldmodels.py.

Constructor & Destructor Documentation

__init__()

fieldmodels.dipole.__init__	(		self,
			centerx,
			centery,
			centerz,
			tilt_phi,
			tilt_theta,
			mult = 1.0,
			radius_f = None,
			radius_z = None )

Definition at line 43 of file fieldmodels.py.

Member Function Documentation

get()

fieldmodels.dipole.get	(		self,
			x,
			y,
			z,
			derivative,
			fComponent,
			dComponent )

Definition at line 146 of file fieldmodels.py.

Here is the call graph for this function:

get_ldp()

fieldmodels.dipole.get_ldp	(		self,
			x,
			y,
			z,
			derivative,
			fComponent,
			dComponent )

Definition at line 111 of file fieldmodels.py.

Here is the call graph for this function:

get_old()

fieldmodels.dipole.get_old	(		self,
			x,
			y,
			z,
			derivative,
			fComponent,
			dComponent )

Definition at line 83 of file fieldmodels.py.

Here is the call graph for this function:

getX()

fieldmodels.dipole.getX	(		self,
			x,
			y,
			z,
			derivative,
			fComponent,
			dComponent )

Definition at line 336 of file fieldmodels.py.

Here is the call graph for this function:

set_dipole()

fieldmodels.dipole.set_dipole	(		self,
			centerx,
			centery,
			centerz,
			tilt_phi,
			tilt_theta,
			mult = 1.0,
			radius_f = None,
			radius_z = None )

Definition at line 68 of file fieldmodels.py.

Member Data Documentation

center

fieldmodels.dipole.center = np.zeros(3)

Definition at line 47 of file fieldmodels.py.

minimumR

fieldmodels.dipole.minimumR = 1e-3*RE

static

Definition at line 41 of file fieldmodels.py.

moment

int fieldmodels.dipole.moment = mult*self.moment_base

Definition at line 54 of file fieldmodels.py.

moment_base

int fieldmodels.dipole.moment_base = 8.e15

static

Definition at line 38 of file fieldmodels.py.

q

fieldmodels.dipole.q = np.zeros(3)

Definition at line 46 of file fieldmodels.py.

radius

fieldmodels.dipole.radius = np.zeros(2)

Definition at line 44 of file fieldmodels.py.

tilt_angle_phi

int fieldmodels.dipole.tilt_angle_phi = tilt_phi * math.pi/180.

Definition at line 52 of file fieldmodels.py.

tilt_angle_theta

int fieldmodels.dipole.tilt_angle_theta = tilt_theta * math.pi/180.

Definition at line 53 of file fieldmodels.py.

---

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

• doc/vectordipole/fieldmodels.py