Plasma3D

class plasmapy.plasma.sources.plasma3d.Plasma3D(domain_x, domain_y, domain_z, **kwargs)

Bases: GenericPlasma

Core class for describing and calculating plasma parameters with spatial dimensions.

Parameters:

• domain_x (Quantity) – 1D array of x-coordinates for the plasma domain. Must have units convertible to length.

• domain_y (Quantity) – 1D array of y-coordinates for the plasma domain. Must have units convertible to length.

• domain_z (Quantity) – 1D array of z-coordinates for the plasma domain. Must have units convertible to length.

• **kwargs – Any keyword accepted by GenericPlasma

Attributes Summary

alfven_speed	(Quantity) (x, y, z) array of the Alfvén speed at every point in the domain.
density	(Quantity) (x, y, z) array of mass density at every point in the domain.
domain_shape	(tuple) Shape of the plasma domain.
electric_field	(Quantity) (3, x, y, z) array of the magnetic field vector at every point in the domain.
electric_field_strength	Total field strength.
grid	(Quantity) (3, x, y, z) array containing the values of each coordinate at every point in the domain.
magnetic_field	(Quantity) (3, x, y, z) array of the magnetic field vector at every point in the domain.
magnetic_field_strength	Total field strength.
momentum	(Quantity) (3, x, y, z) array of the momentum vector at every point in the domain.
pressure	(Quantity) (x, y, z) array of pressure at every point in the domain.
velocity	(Quantity) (3, x, y, z) array of the fluid velocity vector at every point in the domain.
x	(Quantity) x-coordinates within the plasma domain.
y	(Quantity) y-coordinates within the plasma domain.
z	(Quantity) z-coordinates within the plasma domain.

Methods Summary

add_magnetostatic(*mstats)
average_ionization()
electron_density()
electron_temperature()
ion_density()
ion_temperature()
is_datasource_for(**kwargs)

Attributes Documentation

alfven_speed

(Quantity) (x, y, z) array of the Alfvén speed at every point in the domain.

density

(Quantity) (x, y, z) array of mass density at every point in the domain.

domain_shape

(tuple) Shape of the plasma domain.

electric_field

(Quantity) (3, x, y, z) array of the magnetic field vector at every point in the domain.

electric_field_strength

Total field strength.

\[\sqrt{ \sum{ E^2 }}\]

grid

(Quantity) (3, x, y, z) array containing the values of each coordinate at every point in the domain.

magnetic_field

(Quantity) (3, x, y, z) array of the magnetic field vector at every point in the domain.

magnetic_field_strength

Total field strength.

\[\sqrt{ \sum{ B^2 }}\]

momentum

(Quantity) (3, x, y, z) array of the momentum vector at every point in the domain.

pressure

(Quantity) (x, y, z) array of pressure at every point in the domain.

velocity

(Quantity) (3, x, y, z) array of the fluid velocity vector at every point in the domain.

x

(Quantity) x-coordinates within the plasma domain. Equal to the domain_x input parameter.

y

(Quantity) y-coordinates within the plasma domain. Equal to the domain_y input parameter.

z

(Quantity) z-coordinates within the plasma domain. Equal to the domain_z input parameter.

Methods Documentation

add_magnetostatic(*mstats: MagnetoStatics)

average_ionization()

electron_density()

electron_temperature()

ion_density()

ion_temperature()

classmethod is_datasource_for(**kwargs)