`LoadParallel`

Parallel load results generated by the Feko Solver.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]])

    -- Retrieve the 'LoadParallel' called 'ParallelLoad'

loadParallel = app.Models[1].Configurations[1].Loads["ParallelLoad"]

    -- Manipulate the parallel load data. See 'DataSet' for faster and more comprehensive options
    
dataSet = loadParallel:GetDataSet()
print(dataSet) -- Describes the structure of the data
inspect(dataSet) -- Gives a list of the data set contents

    -- Scale the parallel load current values

scale = 2
for freqIndex = 1, #dataSet.Axes["Frequency"] do
    indexedValue = dataSet[freqIndex]
    indexedValue.Current = indexedValue.Current * scale
end

    -- Store the manipulated data 
    
scaledParallelLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load)

    -- Compare the original parallel load to the manipulated parallel load
    
graph = app.CartesianGraphs:Add()
loadTrace1 = graph.Traces:Add(loadParallel)
loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current
loadTrace2 = graph.Traces:Add(scaledParallelLoad)
loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current

Inheritance

The LoadParallel object is derived from the LoadData object.

Property List

Configuration: The result data's solution configuration in the model. (Read only SolutionConfiguration)
ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
DataSetAvailable: Valid result data exist. (Read only boolean)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

GetDataSet (): Returns a data set containing the network values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the network values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the network values. (Returns a DataSet object.)
StoreData (): Creates a local stored version of the result data. (Returns a ResultData object.)

Property Details

Configuration

The result data's solution configuration in the model.

Type: SolutionConfiguration
Access: Read only

ContinuousFrequencyAxis

Continuous frequency axis exists.

Type: boolean
Access: Read only

DataSetAvailable

Valid result data exist.

Type: boolean
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

GetDataSet ()

Returns a data set containing the network values.

Return

DataSet: The data set containing the network values.

GetDataSet (samplePoints number)

Returns a data set containing the network values.

Input Parameters

samplePoints(number): The number of sample points used to sample the continuous frequency axis.

Return

DataSet: The data set containing the network values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

Returns a data set containing the network values.

Input Parameters

startFrequency(number): The start frequency used to sample the continuous frequency axis.
endFrequency(number): The end frequency used to sample the continuous frequency axis.
samplePoints(number): The number of sample points used to sample the continuous frequency axis.

Return

DataSet: The data set containing the network values.

StoreData ()

Creates a local stored version of the result data.

Return

ResultData: The new stored data.