SolutionConfiguration

A solution configuration for which the model is simulated.

Example

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

    -- Get the first configuration in the configuration collection
    
config = app.Models[1].Configurations[1]

    -- Get the far field, near field and currents collections from the configuration
    
startFrequency = config.StartFrequency
endFrequency = config.EndFrequency

    -- Export the first near field 
    -- if it is a frequency configuration and it contains at least one far field

if (config.FrequencyConfiguration and config.FarFields.Count >= 1) then
    config:ExportNearFields("temp_Export.efe", pf.Enums.NearFieldsExportTypeEnum.Electric, 10)
end

Usage locations (object properties)

The following objects have properties using the SolutionConfiguration object:

Property List

EndFrequency
The end frequency of the configuration. (Read only number)
FrequencyConfiguration
The configuration is a frequency configuration. (Read only boolean)
Label
The object label. (Read only string)
Mesh
The mesh used to simulate the configuration. (Read only Mesh)
Model
The solution configuration's associated model. (Read only Model)
StartFrequency
The start frequency of the configuration. (Read only number)
Type
The object type string. (Read only string)

Collection List

CharacteristicModes
The characteristic modes result in the configuration. This collection will only contain one item. (CharacteristicModeCollection of CharacteristicModeData.)
ErrorEstimates
The collection of error estimates in the configuration. (ErrorEstimateCollection of ErrorEstimateData.)
Excitations
The collection of excitations in the configuration. (ExcitationCollection of ExcitationData.)
FarFieldPowerIntegrals
The collection of far field power integrals in the configuration. (FarFieldPowerIntegralCollection of FarFieldPowerIntegralData.)
FarFields
The collection of far fields in the configuration. (FarFieldCollection of FarFieldData.)
Loads
The collection of loads in the configuration. (LoadCollection of LoadData.)
NearFieldPowerIntegrals
The collection of near field power integrals in the configuration. (NearFieldPowerIntegralCollection of NearFieldPowerIntegralData.)
NearFields
The collection of near fields in the configuration. (NearFieldCollection of NearFieldData.)
Networks
The collection of networks in the configuration. (NetworkCollection of NetworkData.)
Power
The power result in the configuration. This collection will only contain one item. (PowerCollection of PowerData.)
Rays
The rays result in the configuration. This collection will only contain one item. (RayCollection of RayData.)
ReceivingAntennas
The collection of receiving antennas in the configuration. (ReceivingAntennaCollection of ReceivingAntennaData.)
SAR
The collection of SAR results in the configuration. (SARCollection of SARData.)
SParameters
The collection of S-parameters in the configuration. (SParameterCollection of SParameterData.)
SpiceProbes
The collection of SPICE probes in the configuration. (SpiceProbeCollection of SpiceProbeData.)
SurfaceCurrents
The collection of surface currents in the configuration. (SurfaceCurrentsCollection of SurfaceCurrentsData.)
TRCoefficients
The collection of transmission reflection coefficients in the configuration. (TRCoefficientCollection of TRCoefficientData.)
TransmissionLines
The collection of transmission lines in the configuration. (TransmissionLineCollection of TransmissionLineData.)
WireCurrents
The collection of wire currents in the configuration. (WireCurrentsCollection of WireCurrentsData.)

Method List

ExportFarFields (filename string, quantity FarFieldsExportTypeEnum, samples number)
Export all the result far field data in the configuration to the specified *.ffe file.
ExportNearFields (filename string, components NearFieldsExportTypeEnum, samples number)
Export all the result near field data the configuration to the specified *.efe / *.hfe file.

Property Details

EndFrequency
The end frequency of the configuration.
Type
number
Access
Read only
FrequencyConfiguration
The configuration is a frequency configuration.
Type
boolean
Access
Read only
Label
The object label.
Type
string
Access
Read only
Mesh
The mesh used to simulate the configuration.
Type
Mesh
Access
Read only
Model
The solution configuration's associated model.
Type
Model
Access
Read only
StartFrequency
The start frequency of the configuration.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Collection Details

CharacteristicModes
The characteristic modes result in the configuration. This collection will only contain one item.
Type
CharacteristicModeCollection
ErrorEstimates
The collection of error estimates in the configuration.
Type
ErrorEstimateCollection
Excitations
The collection of excitations in the configuration.
Type
ExcitationCollection
FarFieldPowerIntegrals
The collection of far field power integrals in the configuration.
Type
FarFieldPowerIntegralCollection
FarFields
The collection of far fields in the configuration.
Type
FarFieldCollection
Loads
The collection of loads in the configuration.
Type
LoadCollection
NearFieldPowerIntegrals
The collection of near field power integrals in the configuration.
Type
NearFieldPowerIntegralCollection
NearFields
The collection of near fields in the configuration.
Type
NearFieldCollection
Networks
The collection of networks in the configuration.
Type
NetworkCollection
Power
The power result in the configuration. This collection will only contain one item.
Type
PowerCollection
Rays
The rays result in the configuration. This collection will only contain one item.
Type
RayCollection
ReceivingAntennas
The collection of receiving antennas in the configuration.
Type
ReceivingAntennaCollection
SAR
The collection of SAR results in the configuration.
Type
SARCollection
SParameters
The collection of S-parameters in the configuration.
Type
SParameterCollection
SpiceProbes
The collection of SPICE probes in the configuration.
Type
SpiceProbeCollection
SurfaceCurrents
The collection of surface currents in the configuration.
Type
SurfaceCurrentsCollection
TRCoefficients
The collection of transmission reflection coefficients in the configuration.
Type
TRCoefficientCollection
TransmissionLines
The collection of transmission lines in the configuration.
Type
TransmissionLineCollection
WireCurrents
The collection of wire currents in the configuration.
Type
WireCurrentsCollection

Method Details

ExportFarFields (filename string, quantity FarFieldsExportTypeEnum, samples number)
Export all the result far field data in the configuration to the specified *.ffe file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
quantity(FarFieldsExportTypeEnum)
The quantity type to export specified by the FarFieldsExportTypeEnum, e.g. Gain, Directivity, RCS, etc.
samples(number)
The number of samples for continuous data. This value will be ignored if the data is discrete.
ExportNearFields (filename string, components NearFieldsExportTypeEnum, samples number)
Export all the result near field data the configuration to the specified *.efe / *.hfe file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
components(NearFieldsExportTypeEnum)
The components to export specified by the NearFieldsExportTypeEnum, e.g. Both (*.efe and *.hfe), Electric (*.efe) or Magnetic (*.hfe).
samples(number)
The number of samples for continuous data. This value will be ignored if the data is discrete.