MPIMagneticFields
Documentation for MPIMagneticFields.
MPIMagneticFields.μ₀MPIMagneticFields.AbstractFieldNodeMPIMagneticFields.AbstractMagneticFieldMPIMagneticFields.AbstractNegativeFieldMPIMagneticFields.AbstractSequencedFieldMPIMagneticFields.AbstractSuperimposedFieldMPIMagneticFields.FieldNodeMPIMagneticFields.LimitedSequencedFieldMPIMagneticFields.MotionPatternMPIMagneticFields.MotionPatternSequenceMPIMagneticFields.NegativeFieldMPIMagneticFields.NoRotationPatternMPIMagneticFields.NoTranslationPatternMPIMagneticFields.NoisyRotationPatternMPIMagneticFields.RotationPatternMPIMagneticFields.SawtoothTranslationPatternMPIMagneticFields.SequenceMPIMagneticFields.SequenceTemplateMPIMagneticFields.SequencedFieldMPIMagneticFields.SinusoidalTranslationPatternMPIMagneticFields.StandardRotationPatternMPIMagneticFields.StaticTranslationPatternMPIMagneticFields.SuperimposedFieldMPIMagneticFields.TranslationPatternMPIMagneticFields.TriangleTranslationPatternMPIMagneticFields.amplitudeMPIMagneticFields.amplitudeMPIMagneticFields.amplitudeMPIMagneticFields.amplitudeMPIMagneticFields.amplitudeMPIMagneticFields.fieldOverTimeMPIMagneticFields.frequencyMPIMagneticFields.frequencyMPIMagneticFields.frequencyMPIMagneticFields.frequencyMPIMagneticFields.frequencyMPIMagneticFields.motionAtTimeMPIMagneticFields.nodesMPIMagneticFields.offsetMPIMagneticFields.offsetMPIMagneticFields.offsetMPIMagneticFields.offsetMPIMagneticFields.offsetMPIMagneticFields.phaseMPIMagneticFields.phaseMPIMagneticFields.phaseMPIMagneticFields.phaseMPIMagneticFields.phaseMPIMagneticFields.rotationMPIMagneticFields.sequenceMPIMagneticFields.totalSequenceTimeMPIMagneticFields.translationMPIMagneticFields.valueMPIMagneticFields.value_
MPIMagneticFields.μ₀ — Constant
Vacuum magnetic permeability for usage within the field definitions
MPIMagneticFields.AbstractFieldNode — Type
abstract type AbstractFieldNodeAbstract supertype for evaluated nodes of magnetic fields.
MPIMagneticFields.AbstractMagneticField — Type
abstract type AbstractMagneticFieldAbstract supertype for magnetic fields.
MPIMagneticFields.AbstractNegativeField — Type
abstract type AbstractNegativeField <: AbstractMagneticFieldAbstract supertype for negative fields.
MPIMagneticFields.AbstractSequencedField — Type
abstract type AbstractSequencedField <: AbstractMagneticFieldAbstract supertype for sequenced fields.
MPIMagneticFields.AbstractSuperimposedField — Type
abstract type AbstractSuperimposedField <: AbstractMagneticFieldAbstract supertype for superimposed fields.
MPIMagneticFields.FieldNode — Type
struct FieldNode{T, V} <: MPIMagneticFields.AbstractFieldNodeEvaluated node of magnetic field.
MPIMagneticFields.LimitedSequencedField — Type
struct LimitedSequencedField{SFT<:AbstractSequencedField, T<:Number} <: AbstractSequencedFieldContainer for limited sequenced fields.
Applies field limits to a sequenced field.
MPIMagneticFields.MotionPattern — Type
Abstract type for motion patterns describing e.g. rotations or translations.
MPIMagneticFields.MotionPatternSequence — Type
Abstract type for describing a sequence based on motion patterns.
MPIMagneticFields.NegativeField — Type
struct NegativeField{T<:AbstractMagneticField} <: AbstractNegativeFieldContainer for negative fields.
The field of this container is interpreted as being the negative of field.
MPIMagneticFields.NoRotationPattern — Type
Rotational movement pattern describing a non-existing movement.
MPIMagneticFields.NoTranslationPattern — Type
Translational movement pattern describing a non-existing movement.
MPIMagneticFields.NoisyRotationPattern — Type
Rotational movement extending the StandardRotationPattern by a random deviation.
MPIMagneticFields.RotationPattern — Type
Abstract type describing rotational motions.
MPIMagneticFields.SawtoothTranslationPattern — Type
Translational movement pattern describing a sawtooth-like movement.
MPIMagneticFields.Sequence — Type
Abstract type for describing a sequence.
MPIMagneticFields.SequenceTemplate — Type
Abstract type for sequence templates which are a convenient way to construct sequences.
MPIMagneticFields.SequencedField — Type
struct SequencedField{FT<:AbstractMagneticField, ST<:Sequence} <: AbstractSequencedFieldContainer for sequenced fields.
Attaches a sequence to a field defining the movement over time.
MPIMagneticFields.SinusoidalTranslationPattern — Type
Translational movement pattern describing a sinusoidal movement.
MPIMagneticFields.StandardRotationPattern — Type
Standard rotational movement defined by an angular frequency ω and a phase ϕ
MPIMagneticFields.StaticTranslationPattern — Type
Translational movement pattern describing a static movement.
MPIMagneticFields.SuperimposedField — Type
struct SuperimposedField{T<:AbstractMagneticField, U<:AbstractMagneticField} <: AbstractSuperimposedFieldContainer for superimposed fields.
The fields in fieldA and fieldB are interpreted as being linearily superimposed.
MPIMagneticFields.TranslationPattern — Type
Abstract type describing translational motions.
MPIMagneticFields.TriangleTranslationPattern — Type
Translational movement pattern describing a triangle-like movement.
MPIMagneticFields.amplitude — Method
Amplitude of the rotation pattern.
MPIMagneticFields.amplitude — Method
Amplitude of the translation pattern.
MPIMagneticFields.amplitude — Method
Amplitude of the translation pattern.
MPIMagneticFields.amplitude — Method
Amplitude of the rotation pattern.
MPIMagneticFields.amplitude — Method
Amplitude of the translation pattern.
MPIMagneticFields.fieldOverTime — Method
Calculate the field for a given position r and at a given time point t
MPIMagneticFields.frequency — Method
Frequency of the rotation pattern.
MPIMagneticFields.frequency — Method
Frequency of the translation pattern.
MPIMagneticFields.frequency — Method
Frequency of the translation pattern.
MPIMagneticFields.frequency — Method
Frequency of the rotation pattern.
MPIMagneticFields.frequency — Method
Frequency of the translation pattern.
MPIMagneticFields.motionAtTime — Method
Calculate the state of the motion at a given time point t
MPIMagneticFields.nodes — Method
nodes(field, args; kwargs...)
Evaluate field at given position and return it together with the position.
MPIMagneticFields.offset — Method
Offset of the rotation pattern.
MPIMagneticFields.offset — Method
Offset of the translation pattern.
MPIMagneticFields.offset — Method
Offset of the translation pattern.
MPIMagneticFields.offset — Method
Offset of the rotation pattern.
MPIMagneticFields.offset — Method
Offset of the translation pattern.
MPIMagneticFields.phase — Method
Phase of the rotation pattern.
MPIMagneticFields.phase — Method
Phase of the translation pattern.
MPIMagneticFields.phase — Method
Phase of the translation pattern.
MPIMagneticFields.phase — Method
Phase of the rotation pattern.
MPIMagneticFields.phase — Method
Phase of the translation pattern.
MPIMagneticFields.rotation — Method
Rotation pattern of the sequence
MPIMagneticFields.sequence — Method
Convert a sequence template to a regular sequence
MPIMagneticFields.totalSequenceTime — Method
Total trajectory duration
MPIMagneticFields.translation — Method
Translation pattern of the sequence
MPIMagneticFields.value — Method
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 δ.
MPIMagneticFields.value_ — Method
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!