`DielectricFrequencyCollection`

A collection of frequency points modelling the dielectric properties.

Example

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

    -- Create a dielectric medium

dielectric = project.Media.Library:AddToModel("Construction_glass")

    -- Get the loss tangent for the second frequency point in the collection
    
lossTangent = dielectric.DielectricModelling.FrequencyPoints[2].LossTangent

Usage locations (collections)

The following objects contain the DielectricFrequencyCollection collection:

DielectricModelling(.FrequencyPoints)

Property List

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

Method List

Add (frequency Expression, relativepermittivity Expression, conductivity Expression): Add a frequency point of dielectric properties to the dielectric medium. For the loss tangent or conductivity value, both will be set to the given value. The active one is specified by the ConductivityType property. This method is only valid when the DielectricModelling DefinitionMethod is FrequencyList.
Item (index number): Returns the DielectricFrequencyPoint at the given index. (Returns a DielectricFrequencyPoint object.)
Modify (index number, frequency Expression, relativepermittivity Expression, conductivity Expression): Modify the frequency point of dielectric properties at the given index. For the loss tangent or conductivity value, both will be set to the given value. The active one is specified by the ConductivityType property. This method is only valid when the DielectricModelling DefinitionMethod is FrequencyList.
Remove (index number): Remove the frequency point of dielectric properties at the given index. This method is only valid when the DielectricModelling DefinitionMethod is FrequencyList.

Index List

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

Property Details

Count

The number of DielectricFrequencyPoint items in the collection.

Type: number
Access: Read only

Method Details

Add (frequency Expression, relativepermittivity Expression, conductivity Expression)

Add a frequency point of dielectric properties to the dielectric medium. For the loss tangent or conductivity value, both will be set to the given value. The active one is specified by the ConductivityType property. This method is only valid when the DielectricModelling DefinitionMethod is FrequencyList.

Input Parameters

frequency(Expression): The frequency value (Hz).
relativepermittivity(Expression): The relative permittivity value.
conductivity(Expression): The dielectric loss tangent/conductivity value.

Item (index number)

Returns the DielectricFrequencyPoint at the given index.

Input Parameters

index(number): The index of the DielectricFrequencyPoint.

Return

DielectricFrequencyPoint: The DielectricFrequencyPoint at the given index.

Modify (index number, frequency Expression, relativepermittivity Expression, conductivity Expression)

Modify the frequency point of dielectric properties at the given index. For the loss tangent or conductivity value, both will be set to the given value. The active one is specified by the ConductivityType property. This method is only valid when the DielectricModelling DefinitionMethod is FrequencyList.

Input Parameters

index(number): The frequency point index.
frequency(Expression): The frequency value (Hz).
relativepermittivity(Expression): The relative permittivity value.
conductivity(Expression): The dielectric loss tangent/conductivity value.

Remove (index number)

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

Input Parameters

index(number): The frequency point index.