|
|
## Core API
|
|
|
The [core](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/api/core.py) API is the common base of all APIs. It simply consists in a `initDart` method which will return all the C++ objects wrapped in python required to run DART. If a new API is created, it should initialize itself by calling this method.
|
|
|
The [core](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/api/core.py) API is the common base of all APIs. It simply consists in a `init_dart` method which will return all the C++ objects wrapped in python required to run DART. If a new API is created, it should initialize itself by calling this method.
|
|
|
|
|
|
**1. Defining the parameters**
|
|
|
In practise, DART is initialized by using a dictionary of parameters, and the type of scenario and task. The different parameters are listed hereunder.
|
... | ... | @@ -54,8 +54,8 @@ cfg = { |
|
|
**2. Initializing DART**
|
|
|
Once the parameters have been defined, DART can simply be initialized by calling,
|
|
|
```python
|
|
|
from dart.api.core import initDart
|
|
|
_dart = initDart(cfg, scenario='aerodynamic', task='analysis', `viscous=False`)
|
|
|
from dart.api.core import init_dart
|
|
|
_dart = init_dart(cfg, scenario='aerodynamic', task='analysis', `viscous=False`)
|
|
|
```
|
|
|
where `scenario` can be `'aerodynamic'` or `'aerostructural'`, and `task` can be `'analysis'` or `'optimization'`, and viscous is a boolean indicating whether the solver should also be configured for viscous-inviscid interaction. `_dart` is a dictionary containing the following objects (named after their key):
|
|
|
- `dim` is the number of dimensions (`2` or `3`)
|
... | ... | |