magnetic fields

This module implements Magnetic field classes, which are mostly bare implementations of generic fields defined in atomsmltr.environment.fields.

See also

atomsmltr.environment.fields.generic, atomsmltr.environment.fields.interpolated

class atomsmltr.environment.fields.magnetic.magnetic.InterpMag1D1D(data_position: ndarray, data_field: ndarray, field_direction: ndarray = (1, 0, 0), position_direction: ndarray = (1, 0, 0), origin: ndarray = (0, 0, 0), scale: float = 1.0, tag: str = None)

Bases: MagneticField, InterpolatedField1D1D

An interpolated field 1D / 1D

See also

atomsmltr.environment.fields.interpolated.InterpolatedField1D1D

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.InterpMag3D3D(data_position: tuple, data_field: ndarray, origin: ndarray = (0, 0, 0), scale: float = 1.0, tag: str = None)

Bases: MagneticField, InterpolatedField3D3D

An interpolated field 3D/3D

See also

atomsmltr.environment.fields.interpolated.InterpolatedField3D3D

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticField(*args, **kwargs)

Bases: Field

A generic magnetic field class. Used to set some properties common to all magnetic fields objects, and to have a way to identify magnetic field objects.

property type

a description of the object type

Type:

str

property unit

returns the unit of the field

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticGradient(origin: ndarray, slope: float, gradient_direction: ndarray, field_direction: ndarray, offset: float = 0.0, tag: str = None)

Bases: MagneticField, GradientField

A perfect magnetic field gradient

See also

atomsmltr.environment.fields.generic.GradientField

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticOffset(field_value: ndarray = (0, 0, 0), tag: str = None)

Bases: MagneticField, ConstantField

A perfect magnetic field offset

See also

atomsmltr.environment.fields.generic.ConstantField

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticQuadrupole(origin: ndarray, strong_axis: ndarray, slope: float, tag: str = None)

Bases: MagneticField, QuadrupoleField

A perfect magnetic field quadrupole, with strong axis along a given vector (x,y,z)

See also

atomsmltr.environment.fields.generic.QuadrupoleField

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticQuadrupoleX(origin: ndarray, slope: float, tag: str = None)

Bases: MagneticField, QuadrupoleFieldX

A perfect magnetic field quadrupole, with strong axis along X

See also

atomsmltr.environment.fields.generic.QuadrupoleFieldX

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticQuadrupoleY(origin: ndarray, slope: float, tag: str = None)

Bases: MagneticField, QuadrupoleFieldY

A perfect magnetic field quadrupole, with strong axis along Y

See also

atomsmltr.environment.fields.generic.QuadrupoleFieldY

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.magnetic.magnetic.MagneticQuadrupoleZ(origin: ndarray, slope: float, tag: str = None)

Bases: MagneticField, QuadrupoleFieldZ

A perfect magnetic field quadrupole, with strong axis along Z

See also

atomsmltr.environment.fields.generic.QuadrupoleFieldZ

property type

a description of the object type

Type:

str