SurfaceCurrentsData
Surface currents generated by the Feko Solver.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) -- Retrieve the 'SurfaceCurrentsData' called 'SurfaceCurrents' surfaceCurrentsData = app.Models[1].Configurations[1].SurfaceCurrents["Currents1"] -- Plot surface currents data surfaceCurrentsPlot = app.Views[1].Plots:Add(surfaceCurrentsData)
Inheritance
The SurfaceCurrentsData object is derived from the ResultData object.
Usage locations
The SurfaceCurrentsData object can be accessed from the following locations:
- Methods
- SurfaceCurrentsCollection collection has method Items().
- SurfaceCurrentsCollection collection has method Item(number).
- SurfaceCurrentsCollection collection has method Item(string).
Property List
- Configuration
- The result data's solution configuration in the model. (Read only SolutionConfiguration)
- 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
- ExportData (filename string, components CurrentsExportTypeEnum, samples number)
- Export the result surface currents and charges data to the specified *.os / *.ol file.
- GetDataSet ()
- Returns a data set containing the current values. (Returns a DataSet object.)
- GetDataSet (samplePoints number)
- Returns a data set containing the current values. (Returns a DataSet object.)
- GetDataSet (startFrequency number, endFrequency number, samplePoints number)
- Returns a data set containing the current 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
- 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
- ExportData (filename string, components CurrentsExportTypeEnum, samples number)
- Export the result surface currents and charges data to the specified *.os / *.ol file.
- Input Parameters
- filename(string)
- The name of the exported data file without its extension.
- components(CurrentsExportTypeEnum)
- The components to export specified by the CurrentsExportTypeEnum, e.g. Both (*.os and *.ol), Currents (*.os) or Charges (*.ol).
- samples(number)
- The number of samples for continuous data. This value will be ignored if the data is discrete.
- Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) -- Get the surface currents result from the collection of currents results of -- the solution configuration surfaceCurrents = app.Models[1].Configurations[1].SurfaceCurrents[1] -- Export the surface currents data to the current working directory fileName = "temp_SurfaceCurrents" surfaceCurrents:ExportData(fileName, pf.Enums.CurrentsExportTypeEnum.Both, 51)
- GetDataSet ()
- Returns a data set containing the current values.
- Return
- DataSet
- The data set containing the current values.
- GetDataSet (samplePoints number)
- Returns a data set containing the current values.
- GetDataSet (startFrequency number, endFrequency number, samplePoints number)
- Returns a data set containing the current values.
- Input Parameters
- Return
- DataSet
- The data set containing the current values.
- StoreData ()
- Creates a local stored version of the result data.
- Return
- ResultData
- The new stored data.