warpy.functions.harris_current_sheet.harris_current_sheet_field Class Reference

Function which sets field to a given uniform value. More...

Inheritance diagram for warpy.functions.harris_current_sheet.harris_current_sheet_field:

Detailed Description

Function which sets field to a given uniform value.

See also

harris_current_sheet_field

Public Member Functions
def	__init__ (self, name, sheet_width, Bz, perturbation_amplitude=None, perturbation_wavelength=None)

Constructor & Destructor Documentation

__init__()

def warpy.functions.harris_current_sheet.harris_current_sheet_field.__init__	(		self,
			name,
			sheet_width,
			Bz,
			perturbation_amplitude = None,
			perturbation_wavelength = None
	)

Parameters

name	Name of module
sheet_width	Sheet width
Bz	Reference magnetic field
perturbation_amplitude	Amplitude of perturbation
perturbation_wavelength	Wavelength of perturbation

---

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

• tools/warpy/functions/harris_current_sheet.py