`MetallicFrequencyCollection`

A collection of frequency points modelling the metallic properties.

Example

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

metal = project.Media:AddMetal()

properties = metal:GetProperties()
properties.DefinitionMethod = cf.Enums.MediumMetallicDefinitionMethodEnum.FrequencyList
properties.FrequencyPoints[1].Frequency = 1e3
properties.FrequencyPoints[1].RelativePermeability = 1.0
properties.FrequencyPoints[1].LossTangent = 0
properties.FrequencyPoints[1].Conductivity = 1e7
metal:SetProperties(properties)

metallicFrequencyCollection = metal.FrequencyPoints

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

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

Usage locations (collections)

The following objects contain the MetallicFrequencyCollection collection:

Metal(.FrequencyPoints)

Property List

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

Method List

Add (frequency Expression, relativepermeability Expression, losstangent Expression, conductivity Expression): Add a frequency point of metallic properties to the metallic medium. This method will set the DefinitionMethod to FrequencyList.
Item (index number): Returns the MetallicFrequencyPoint at the given index. (Returns a MetallicFrequencyPoint object.)
Modify (index number, frequency Expression, relativepermeability Expression, losstangent Expression, conductivity Expression): Modify the frequency point of metallic properties at the given index. This method is only valid when the DefinitionMethod is FrequencyList.
Remove (index number): Remove the frequency point of metallic properties at the given index. This method is only valid when the DefinitionMethod is FrequencyList.

Index List

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

Property Details

Count

The number of MetallicFrequencyPoint items in the collection.

Type: number
Access: Read only

Method Details

Add (frequency Expression, relativepermeability Expression, losstangent Expression, conductivity Expression)

Add a frequency point of metallic properties to the metallic medium. This method will set the DefinitionMethod to FrequencyList.

Input Parameters

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

Item (index number)

Returns the MetallicFrequencyPoint at the given index.

Input Parameters

index(number): The index of the MetallicFrequencyPoint.

Return

MetallicFrequencyPoint: The MetallicFrequencyPoint at the given index.

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

Modify the frequency point of metallic properties at the given index. This method is only valid when the 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.
conductivity(Expression): The conductivity value (S/m).

Remove (index number)

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

Input Parameters

index(number): The frequency point index.