MPIMagneticFields

Vacuum magnetic permeability for usage within the field definitions

abstract type AbstractFieldNode

Abstract supertype for evaluated nodes of magnetic fields.

abstract type AbstractMagneticField

Abstract supertype for magnetic fields.

abstract type AbstractNegativeField <: AbstractMagneticField

Abstract supertype for negative fields.

abstract type AbstractSequencedField <: AbstractMagneticField

Abstract supertype for sequenced fields.

abstract type AbstractSuperimposedField <: AbstractMagneticField

Abstract supertype for superimposed fields.

struct FieldNode{T, V} <: MPIMagneticFields.AbstractFieldNode

Evaluated node of magnetic field.

struct LimitedSequencedField{SFT<:AbstractSequencedField, T<:Number} <: AbstractSequencedField

Container for limited sequenced fields.

Applies field limits to a sequenced field.

Abstract type for motion patterns describing e.g. rotations or translations.

Abstract type for describing a sequence based on motion patterns.

struct NegativeField{T<:AbstractMagneticField} <: AbstractNegativeField

Container for negative fields.

The field of this container is interpreted as being the negative of field.

Rotational movement pattern describing a non-existing movement.

Translational movement pattern describing a non-existing movement.

Rotational movement extending the StandardRotationPattern by a random deviation.

Abstract type describing rotational motions.

Translational movement pattern describing a sawtooth-like movement.

Abstract type for describing a sequence.

Abstract type for sequence templates which are a convenient way to construct sequences.

struct SequencedField{FT<:AbstractMagneticField, ST<:Sequence} <: AbstractSequencedField

Container for sequenced fields.

Attaches a sequence to a field defining the movement over time.

Translational movement pattern describing a sinusoidal movement.

Standard rotational movement defined by an angular frequency ω and a phase ϕ

Translational movement pattern describing a static movement.

struct SuperimposedField{T<:AbstractMagneticField, U<:AbstractMagneticField} <: AbstractSuperimposedField

Container for superimposed fields.

The fields in fieldA and fieldB are interpreted as being linearily superimposed.

Abstract type describing translational motions.

Translational movement pattern describing a triangle-like movement.

Amplitude of the rotation pattern.

Amplitude of the translation pattern.

Amplitude of the translation pattern.

Amplitude of the rotation pattern.

Amplitude of the translation pattern.

Calculate the field for a given position r and at a given time point t

Frequency of the rotation pattern.

Frequency of the translation pattern.

Frequency of the translation pattern.

Frequency of the rotation pattern.

Frequency of the translation pattern.

Calculate the state of the motion at a given time point t

nodes(field, args; kwargs...)

Evaluate field at given position and return it together with the position.

Offset of the rotation pattern.

Offset of the translation pattern.

Offset of the translation pattern.

Offset of the rotation pattern.

Offset of the translation pattern.

Phase of the rotation pattern.

Phase of the translation pattern.

Phase of the translation pattern.

Phase of the rotation pattern.

Phase of the translation pattern.

Rotation pattern of the sequence

Convert a sequence template to a regular sequence

Total trajectory duration

Translation pattern of the sequence

value(field, args; kwargs...)

Retrieve the value of a magnetic field.

The order of arguments varies depending on the traits of the actual type.

With a time varying field, the first argument is the time t.

Otherwise the position r is the first parameter.

The rotation angle ϕ is the next parameter if the field is rotatable,

otherwise it is the shift vektor δ.

value_(field, args; kargs...)

Retrieve the value of a magnetic field.

The order of arguments varies depending on the traits of the actual type. With a time varying field, the first argument is the time t. Otherwise the position r is the first parameter. The rotation angle ϕ is the next parameter if the field is rotatable, otherwise it is the shift vektor δ. Note: The underscore is important!