Changes

Adrien Crovato · 628ec6e4
--- a/use_api_internal.md
+++ b/use_api_internal.md
 ## Internal API
 The internal API is meant for users wanting to run a standard computational procedure on a classic lifting configuration. The procedures that are currently implemented can be found under [api/internal](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/api/internal):
 - a [polar](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/api/internal/polar.py) analysis, to compute the aerodynamic coefficients for various angles of attack,
 - a [trim](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/api/internal/trim.py) analysis, to find the angle of attack that produces a desired lift coefficient.
 Sample cases making use of the internal API can be found under [cases](https://gitlab.uliege.be/am-dept/dartflo/blob/master/dart/cases).
 **1. Defining the parameters**  
-In practise, all the internal APIs use the [Core API](use_api_core) to initialize DART using a dictionary of parameters. Some additional parameters need to be defined and are listed hereunder.  
+In practise, all the internal APIs use the [Core API](use_api_core) to initialize DART using a dictionary of parameters. Additional configuration dicts must be provided and are listed hereunder.  
-Additional common parameters:
+Additional dict for post-processing:
 ```python
-# Post-pro
+post_cfg = {
-cfg['Slice'] = list of float # y-coordinates of cutting planes to extract slices on the geometry (optional, will only work with VTK)
+    'cut_tag': int # id of physical group to be sliced (can be obtained through Gmsh)
-cfg['TagId'] = int # id of physical group to be sliced (id can be obtained through gmsh)
+    'y_slices': list(float) # y-coordinates of cutting planes to extract slices on the geometry (will only work if output format is VTK)
-```
+}
-Additional parameters specific to Polar class:
+```
-```python
+Additional dict for polar calculation:
-cfg['AoA_begin'] = float # first value of the angle of attack [degrees]
+```python
-cfg['AoA_end'] = float # last value of the angle of attack [degrees]
+polar_cfg = {
-cfg['AoA_step'] = float # step in the angle of attack [degrees]
+    'aoas': list(float) # list of angles of attack [deg] (optional, default=[0])
-```
+}
-Additional parameters specific to Trim class:
+```
-```python
+Additional dict for trim calculation:
-cfg['CL'] = float # target lift coefficient
+```python
-cfg['AoA'] = float # guess (first) angle of attack
+trim_cfg = {
-cfg['dCL'] = float # guess (first) slope of CL w.r.t AoA [1/rad]
+    'cl_target': float, # target lift coefficient (optional, default=0)
-```
+    'aoa_init': float, # guess (first) angle of attack [deg] (optional, default=0)
+    'cl_slope': float # guess (first) slope of CL w.r.t AoA [1/rad] (optional, default=6.3)
-**2. Using the solver**  
+}
-After the parameters have been defined, the solver can be set up automatically by instantiating the object as,
+```
-```python
-import dart.api.internal.polar as pol
+**2. Using the solver**  
-polar = pol.Polar(cfg)
+After the parameters have been defined, the solver can be set up automatically by instantiating the object as,
-# or
+```python
-import dart.api.internal.trim as trm
+import dart.api.internal.polar as pol
-trim = trm.Trim(cfg)
+polar = pol.Polar(cfg, polar_cfg, post_cfg=None)
-```
+# or
-The script can then be run by calling,
+import dart.api.internal.trim as trm
-```python
+trim = trm.Trim(cfg, trim_cfg, post_cfg=None)
-polar.run()
+```
-# or
+The script can then be run by calling,
-trim.run()
+```python
-```
+polar.run()
-Finally, the results can be displayed using,
+# or
-```python
+trim.run()
-polar.disp()
+```
-# or
+Finally, the results can be displayed using,
-trim.disp()
+```python
-```
+polar.disp()
+# or
+trim.disp()
+```