swarmng.Integrator Class Reference
An ODE integration algorithms. More...
Inheritance diagram for swarmng.Integrator:
Public Member Functions | |
| def | create |
| Create an integrator object from the configuration specified the only mandatory items is an identifier for the integrator, namely the value 'integrator'. More... | |
| def | integrate |
| Run the integration up to the specified destination_time. | |
Properties | |
| ensemble = property | |
| The ensemble data structure to operate on, of type Ensemble. | |
| destination_time = property | |
| All of the systems will be integrated to this specified time. More... | |
Detailed Description
An ODE integration algorithms.
The different implementations of ODE integration methods provide the same interface, this class is abstract and the create method loads a specific implementation based on the configuration that is passed to the method.
Definition at line 274 of file __init__.doc.py.
Member Function Documentation
| def swarmng.Integrator.create | ( | cfg) |
Create an integrator object from the configuration specified the only mandatory items is an identifier for the integrator, namely the value 'integrator'.
cfg: configuration object of type swarmng.Config for selecting and configuring the integrator.
For more information refer to swarm::integrator::create
Definition at line 289 of file __init__.doc.py.
Property Documentation
|
static |
All of the systems will be integrated to this specified time.
(scalar floating point value)
Definition at line 279 of file __init__.doc.py.
The documentation for this class was generated from the following file:
- /home/saleh/projects/swarm/py/swarmng/__init__.doc.py
