Package empro :: Module empro :: Module simulation :: Class SimulationData

Class SimulationData

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    SimulationData

Interface to control all data specific to a simulation.

Class Hierarchy for SimulationData

Instance Methods

activePorts(...)
No documentation available.

defaultGoodConductorThreshold(...)
No documentation available.

defaultPerfectConductorThreshold(...)
No documentation available.

fdtdFrequencyPlanList(...)
No documentation available.

FrequencyPlanList

femFrequencyPlanList()
returns a reference to the target frequency plan for a FEM simulation

friendlyName(...)
No documentation available.

None

setPortAsActive(iFeed, iActive)
Specifies whether or not a feed has to be set to active or not.

setPresetByName(...)
No documentation available.

setWaveGuideAsActive(...)
No documentation available.

Inherited from core.Selectable: clone, isSelected

Inherited from core.Updatable: __enter__, __exit__, hash, isValid, reasonWhyInvalid

Properties
	activeWaveGuides No documentation available.
	ambientConditions No documentation available.
	componentsTreatedAsPorts No documentation available.
	coplanarGroundModel No documentation available.
stringNone	dataSetAdsPath obsolete
stringNone	dataSetFileName obsolete
	engine No documentation available.
stringNone	excitationType Determines the type of the excitation for this simulation.
	farFieldAngularResolution No documentation available.
	farFieldEnabled No documentation available.
	femEigenMode No documentation available.
	femEigenSolverSettings No documentation available.
	femExpertSettings No documentation available.
MatrixSolverNone	femMatrixSolver Returns a reference to the FEM matrix solver settings.
FemMeshSettingsNone	femMeshSettings Returns a reference to the FEM mesh (refinement) settings.
	femPerLayerOverrides No documentation available.
FOIParametersNone	foiParameters Returns a reference to the frequency-of-interest-parameters for this simulation.
	frequencyPlans
	goodConductorThreshold No documentation available.
	group No documentation available.
	momExpertSettings No documentation available.
	momMatrixSolver No documentation available.
	momMeshSettings No documentation available.
	momPerLayerOverrides No documentation available.
	momPerNetOverrides No documentation available.
	momPhysModel No documentation available.
	parameterSequences No documentation available.
boolNone	parameterSweepEnabled Determines if a parameter sweep has to be done for this simulation.
	perfectConductorThreshold No documentation available.
	portOnlyDeltaError No documentation available.
	portOnlyMode No documentation available.
	preprocessorSettings No documentation available.
	preset No documentation available.
	resourceSettings No documentation available.
boolNone	reuseSimulation flag indicating whether a simulation is to be reused.
boolNone	sParametersEnabled Determines whether the S-parameters have to be calculated.
intNone	saveFieldsFor flag indicating for which frequencies to store the fields: 0=none, 1=all frequencies, 2=user-defined frequencies only
stringNone	simulationReuseId ID of the simulation run to be reused.
TerminationCriteriaNone	terminationCriteria Returns a reference to the termination criteria for this simulation.
	transfinitePorts No documentation available.
	vemMatrixSolver No documentation available.
	viaDesignerSettings No documentation available.
	viaModel No documentation available.
Inherited from `core.Selectable`: `metaData`, `name`, `notes`

Method Details

setPortAsActive(iFeed, iActive)

Specifies whether or not a feed has to be set to active or not.

Parameters:

iFeed (CircuitComponent) - The feed.
iActive (bool) - True for active, False for non-active.

Returns: None

Property Details

excitationType

Determines the type of the excitation for this simulation. Possible values are {'NoSources','DiscreteSources','ExternalExcitation'}

Type:: stringNone

reuseSimulation

flag indicating whether a simulation is to be reused. If True, the simulation to be reused is indicated by simulationReuseId

Type:: boolNone

simulationReuseId

ID of the simulation run to be reused. Only relevant if {reuseSimulation} is True

Type:: stringNone