Update use_api_core authored by Adrien Crovato's avatar Adrien Crovato
......@@ -2,7 +2,7 @@
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.
In practise, DART is initialized by using a dictionary of parameters, which are listed hereunder:
```python
cfg = {
'options': {
......@@ -65,7 +65,7 @@ cfg = {
Remarks:
- `'symmetry'` is only required for 3D cases;
- `'free_edge'` is only required for 3D cases;
- if `'kutta_bodies'` is not provided, all the bodies provided in `'bound_bodies'` will be used;
- if `'kutta_bodies'` is not provided, all the bodies provided in `'bound_bodies'` will be used (the Kutta condition will be applied on all attached bodies);
- `'bound_bodies'` can be provided either via a list if the trailing edge of the body 'body' is named 'bodyTe', or via a dict that defines the mapping between a body and its trailing edge explicitly;
- `'dyn_pressure'` is only required for fluid-structure calculations.
......
......