SurfaceCurrentsQuantity
The surface currents and charges quantity properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) surfaceCurrentsPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) -- Adjust 'SurfaceCurrentsQuantity' of the plot surfaceCurrentsPlot.Quantity.Type = pf.Enums.SurfaceCurrentsQuantityTypeEnum.Charges surfaceCurrentsPlot.Quantity.ValuesNormalised = true surfaceCurrentsPlot.Quantity.ValuesScaledToDB = true
Usage locations
The SurfaceCurrentsQuantity object can be accessed from the following locations:
- Properties
- SurfaceCurrents3DPlot object has property Quantity.
Property List
- ComplexComponent
- The complex component of the surface currents value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Instantaneous. (Read/Write ComplexComponentEnum)
- InstantaneousPhase
- The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360]. (Read/Write number)
- Type
- The type of surface currents quantity to be plotted specified by the SurfaceCurrentsQuantityTypeEnum, e.g. ElectricCurrents, MagneticCurrents or Charges. (Read/Write SurfaceCurrentsQuantityTypeEnum)
- ValuesNormalised
- Specifies whether the surface currents quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. (Read/Write boolean)
- ValuesScaledToDB
- Specifies whether the surface currents quantity values are scaled to dB before plotting. (Read/Write boolean)
Property Details
- ComplexComponent
- The complex component of the surface currents value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Instantaneous.
- Type
- ComplexComponentEnum
- Access
- Read/Write
- InstantaneousPhase
- The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360].
- Type
- number
- Access
- Read/Write
- Type
- The type of surface currents quantity to be plotted specified by the SurfaceCurrentsQuantityTypeEnum, e.g. ElectricCurrents, MagneticCurrents or Charges.
- Type
- SurfaceCurrentsQuantityTypeEnum
- Access
- Read/Write
- ValuesNormalised
- Specifies whether the surface currents quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling.
- Type
- boolean
- Access
- Read/Write
- ValuesScaledToDB
- Specifies whether the surface currents quantity values are scaled to dB before plotting.
- Type
- boolean
- Access
- Read/Write