Package empro :: Package toolkit :: Module simulation

Module simulation

Classes
	TimeOutError

Functions

NewSimulationData

setupTerminationCriteria(convergence=... , maxTime=... , engine=...=...)
sets termination criterira on simulation on active project

source code

NewSimulationData

setupSParameterSimulation(convergence=... , maxTime=... , engine=...=...)
Setups simulation on active project for S parameter simulation

source code

NewSimulationData

setupSteadyStateSimulation(frequencies, convergence=... , maxTime=... , engine=...=...)
Setups simulation on active project for S parameter simulation

source code

None

wait()
wait(Simulation) -> None wait([Simulation, ...]) -> None

source code

None

timedWait()
wait(L{Simulation}) -> None wait([L{Simulation}, ...]) -> None

source code

simulateParameterSweep(addToQueue=True, simName=None, simEngine=None, **paramSweeps)
create multiple simulations to perform a parameter sweep, even in FEM mode.

source code

Variables
	ENGINES = `('FdtdEngine', 'FemEngine')`
	FDTD = `'FdtdEngine'`
	FEM = `'FemEngine'`

Function Details

setupTerminationCriteria(convergence=... , maxTime=... , engine=...=...)

source code

sets termination criterira on simulation on active project

Returns: NewSimulationData: returns the simulation setup of the active project

setupSParameterSimulation(convergence=... , maxTime=... , engine=...=...)

source code

Setups simulation on active project for S parameter simulation

Returns: NewSimulationData: returns the simulation setup of the active project

setupSteadyStateSimulation(frequencies, convergence=... , maxTime=... , engine=...=...)

source code

Setups simulation on active project for S parameter simulation

Parameters:

frequencies (list<float>) - list of frequencies of interest

Returns: NewSimulationData

returns the simulation setup of the active project

wait()

source code

wait(Simulation) -> None wait([Simulation, ...]) -> None

This function blocks execution as long as there are simulations that are Running or Queued. It will not wait for simulations in any other state like Created, Ready, Completed, killed or Error. When called without arguments, it will check all simulations in the active project. When called with a single simulation or a list, it will only wait for those specific simulations.

Returns: None

timedWait()

source code

    wait(L{Simulation}) -> None
    wait([L{Simulation}, ...]) -> None
    
    This function blocks execution as long as there are simulations that are
    Running or Queued. It will not wait for simulations in any other state like
    Created, Ready, Completed, killed or Error. When called without arguments, 
    it will check all simulations in the active project. When called with a
    single simulation or a list, it will only wait for those specific 
    simulations.

    When the simulation time exceeds the completion time then an error is raised.
    

timedWait is deprecated, and will be removed in the 2021 release. Use wait(simulations, completionTimeSeconds) instead.

Returns: None

Decorators:

@_deprecation.deprecated(390, "Use wait(simulations, completionTimeSeconds) instead.")

simulateParameterSweep(addToQueue=True, simName=None, simEngine=None, **paramSweeps)

source code


create multiple simulations to perform a parameter sweep, even in FEM mode.
paramSweeps is a dictionary containing the parameters to be swept
The keys are the parameter sweeps, the values are either single values (numbers
or expressions), or a sequence of values.  In the latter case, one simulation
per item in the sequence will be made.  If multiple parameters must be swept,
the product space will be used.  For example:
    
simulateParameterSweep(A=[1, 2], B=3, C=["4 mm", "5 mm"])

The following simulations will be created:
A = 1, B = 3, C = "4 mm"
A = 1, B = 3, C = "5 mm"
A = 2, B = 3, C = "4 mm"
A = 2, B = 3, C = "5 mm"

Optional arguments:
- addToQueue: if True, the created simulations are added to the run queue
- simName: the simulation name to be used.