 | E3DSimulation Class |
A single or multi-run EMA3D FDTD simulation.
Inheritance HierarchyNamespace: ema3d.Api.V25.Core.Execution
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0
SyntaxThe E3DSimulation type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | EndTime |
Gets time that the process finished or current time if process is still running.
(Inherited from SubProcessBase) |
| Progress |
Gets the current percent completion of process [0 - 100].
(Inherited from SubProcessBase) |
| StartTime |
Gets time that the process was started.
(Inherited from SubProcessBase) |
| Status |
Gets current status of the process.
(Inherited from SubProcessBase) |
Methods| Name | Description | |
|---|---|---|
  | BuildResults | |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SubProcessBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Kill |
Kills the process.
(Inherited from SubProcessBase) |
| Launch | Starts a standard EMA3D FDTD simulation using the provided input file. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WaitForCompletion |
Blocks until the process finishes.
(Inherited from SubProcessBase) |
| WaitForCompletion(CancellationToken) |
Blocks until the process finishes.
(Inherited from SubProcessBase) |
Events| Name | Description | |
|---|---|---|
 | MessageReceived |
Occurs when some message is received from the process.
(Inherited from SubProcessBase) |
ExamplePython
from ema3d.Api.V25.Core.Execution import E3DSimulation as E3DSimulation # Run simulation from filepath _filepath = r"C:\Users\Example Simulation\Domain.emin" _sim = E3DSimulation.Launch(_filepath).WaitForCompletion()
See Also