Package empro :: Module empro :: Module simulation :: Class FOIParameters

Class FOIParameters

core.Updatable --+
                 |
                FOIParameters

Interface to control the frequencies of interest in a simulation.

Class Hierarchy for FOIParameters

Instance Methods

None

addSpecifiedFrequency(iFrequency)
Add a frequency to the list of frequencies of interest.

None

clearSpecifiedFrequencies()
Removes all the frequencies of interest.

listExpression

specifiedFrequencies()
Returns the list of frequencies of interest.

Properties
boolNone	collectSteadyStateData Controls whether steady-state data has to be collected.
boolNone	computeDissipatedPower Controls whether the dissipated power has to be computed for the frequencies of interest.
stringNone	dataStorageType Determines the data storage type for the frequencies of interest.
stringNone	foiSource Determines whether to use the waveform frequency or the specified frequencies of interest.
boolNone	normalizeFields Determines whether the far-zone fields for the specified frequencies of interest have to normalized such that they are the same as the far-zone fields calculated with a sinusiodal excitation
intNone	samplingInterval The sampling interval (number of timesteps) for the DFT algorithm.
boolNone	saveFarZoneBox Determines whether to save data for post-simulation far zon steady-state processing.
boolNone	useAutomaticSampling Determines whether to use the automatically created default sampling interval.

Method Details

Add a frequency to the list of frequencies of interest.

Parameters:

Returns: None

Property Details

Determines the data storage type for the frequencies of interest. Possible values are {'InMemory', 'OnDisk'}

Determines whether to use the waveform frequency or the specified frequencies of interest. Possible values are {'Waveform', 'Specified'}