`MagneticFrequencyCollection`

A collection of frequency points modelling the magnetic properties.

Example

app = cf.GetApplication()
project = app:NewProject()

dielectric = project.Media:AddDielectric()

properties = dielectric:GetProperties()
properties.MagneticModelling.DefinitionMethod = 
    cf.Enums.MediumMagneticDefinitionMethodEnum.FrequencyList
properties.MagneticModelling.FrequencyPoints[1].Frequency = 1e3
properties.MagneticModelling.FrequencyPoints[1].RelativePermeability = 1.0
properties.MagneticModelling.FrequencyPoints[1].LossTangent = 0
dielectric:SetProperties(properties)

magneticFrequencyCollection = dielectric.MagneticModelling.FrequencyPoints

    -- Use the magnetic frequency collection to change magnetic frequency points

magneticFrequencyCollection:Modify(1, 1.5e3, 1.0, 1e7)
magneticFrequencyCollection:Add(2e3, 1.0, 1.5e7)
magneticFrequencyCollection:Remove(1)

Usage locations (collections)

The following objects contain the MagneticFrequencyCollection collection:

MagneticModelling(.FrequencyPoints)

Property List

Count: The number of MagneticFrequencyPoint items in the collection. (Read only number)

Method List

Add (frequency Expression, relativepermeability Expression, losstangent Expression): Add a frequency point of magnetic properties to the dielectric medium. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.
Item (index number): Returns the MagneticFrequencyPoint at the given index. (Returns a MagneticFrequencyPoint object.)
Modify (index number, frequency Expression, relativepermeability Expression, losstangent Expression): Modify the frequency point of magnetic properties at the given index. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.
Remove (index number): Remove the frequency point of magnetic properties at the given index. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.

Index List

[number]: Returns the MagneticFrequencyPoint at the given index in the collection. (Read MagneticFrequencyPoint)

Property Details

Count

The number of MagneticFrequencyPoint items in the collection.

Type: number
Access: Read only

Method Details

Add (frequency Expression, relativepermeability Expression, losstangent Expression)

Add a frequency point of magnetic properties to the dielectric medium. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.

Input Parameters

frequency(Expression): The frequency value (Hz).
relativepermeability(Expression): The relative permeability value.
losstangent(Expression): The magnetic loss tangent value.

Item (index number)

Returns the MagneticFrequencyPoint at the given index.

Input Parameters

index(number): The index of the MagneticFrequencyPoint.

Return

MagneticFrequencyPoint: The MagneticFrequencyPoint at the given index.

Modify (index number, frequency Expression, relativepermeability Expression, losstangent Expression)

Modify the frequency point of magnetic properties at the given index. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.

Input Parameters

index(number): The frequency point index.
frequency(Expression): The frequency value (Hz).
relativepermeability(Expression): The relative permeability value.
losstangent(Expression): The magnetic loss tangent value.

Remove (index number)

Remove the frequency point of magnetic properties at the given index. This method is only valid when the MagneticModelling DefinitionMethod is FrequencyList.

Input Parameters

index(number): The frequency point index.