Class HarmonicFieldBase

Namespace

VirtualLabAPI.Core.FieldRepresentations

Assembly

VirtualLabAPI.dll

Base class for Harmonic Fields and Harmonic Fields Sets.

[Serializable]
public abstract class HarmonicFieldBase : FieldRepresentationObject, IDeserializationCallback, IDisposable, ISerializable, IDocument, IEquatable<IObjectBase>, ICloneable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

FieldRepresentationObject

HarmonicFieldBase

Implements

IDeserializationCallback

IDisposable

ISerializable

IDocument

IEquatable<IObjectBase>

ICloneable

Derived

ComplexAmplitude

HarmonicFieldsSet

Inherited Members

FieldRepresentationObject.FieldRepresentation

FieldRepresentationObject.Save(string)

FieldRepresentationObject.FileExtension

FieldRepresentationObject.TypeOfDocument

FieldRepresentationObject.EmbeddingMedium

FieldRepresentationObject.Equals(object, EqualityIntent)

FieldRepresentationObject.Clone()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FileHandlingSupport.SaveCompressed(IStorableOnHDD, string, ListOfSavedViewSettings)

Constructors

HarmonicFieldBase()

Default constructor to initialize a new instance of the HarmonicFieldBase class.

public HarmonicFieldBase()

HarmonicFieldBase(HarmonicFieldBase)

Copy constructor to initialize a new instance of the HarmonicFieldBase class.

public HarmonicFieldBase(HarmonicFieldBase field)

Parameters

field HarmonicFieldBase

The field to copy.

Properties

IsSpatial

Gets and sets whether the field is in spatial domain (if true) or spectral domain (if false).

public abstract bool IsSpatial { get; set; }

Property Value

bool

PropagatesInPositiveZDirection

Gets or sets whether the sign of the z-component of the k-vector is positive or not.

public abstract bool PropagatesInPositiveZDirection { get; set; }

Property Value

bool

Methods

GetFields()

Gets all member fields in the harmonic field.

public abstract IEnumerable<ComplexAmplitude> GetFields()

Returns

IEnumerable<ComplexAmplitude>

Collection of the member fields.

RemoveSphericalPhaseFactor(CancellationToken?)

Removes the Spherical Phase Factor(s) from the field.

public abstract void RemoveSphericalPhaseFactor(CancellationToken? cancellationToken = null)

Parameters

cancellationToken CancellationToken?

Optional token for cooperative task cancellation.

See Also

FieldRepresentationObject