From 93636dafac93d0570565f7577c2bdf33ca80cefa Mon Sep 17 00:00:00 2001
From: Adrien Crovato <a.crovato@uliege.be>
Date: Sun, 5 Sep 2021 14:40:58 +0200
Subject: [PATCH] Patch CI + add README

---
 .gitlab-ci.yml |  1 +
 README.md      | 26 +++++++++++++++++++++++---
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index bc9bbd5..d4c2bbc 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -14,6 +14,7 @@ default:
 variables:
     GIT_SUBMODULE_STRATEGY: recursive
     GIT_STRATEGY: clone # workaround full clone for each pipeline (https://gitlab.com/gitlab-org/gitlab-runner/-/issues/26993)
+    GIT_LFS_SKIP_SMUDGE: 1 # do not pull LFS
 
 stages:
     - build
diff --git a/README.md b/README.md
index 17c3441..39fe9a0 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,31 @@
 # DARTFlo
-Discrete Adjoint for Rapid Transonic Flows
+DARTFlo (Discrete Adjoint for Rapid Transonic Flows, abbreviated as DART) is an open-source C++/python, unstructured finite-element, full potential solver, developed at the University of Liège by Adrien Crovato with the active collaboration of Romain Boman, and under the supervision Vincent Terrapon and Grigorios Dimitriadis, during the academic years 2018-2022.  
+DART is currently capable of rapidly solving steady transonic flows on arbitrary configurations, ranging from 2D airfoils to 3D full aircraft (without engine), as well as calculating the flow gradients using a discrete adjoint method. Furthemore, the code is interfaced with [CUPyDO](https://github.com/ulgltas/CUPyDO) and [openMDAO](https://openmdao.org/) so that aeroelastic computations and optimization can be easily carried out.
 
 ![](/dox/title.png)
 
 ## Main features
-* TODO
-  - [x] TODO
+* Cross platform (Windows and Unix) C++/python code
+* Physical model
+  - unstructured meshes for 2D and 3D geometries using [gmsh](https://gmsh.info/)
+  - steady transonic flows
+  - viscous-inviscid interation (2D only)
+* Numerical methods
+  - linear algrebra using [Eigen](http://eigen.tuxfamily.org/) and [Intel MKL](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onemkl.html#gs.a3o4w5) or [openBLAS](https://www.openblas.net/)
+  - direct (forward) and adjoint (backward) modes
+  - nonlinear Newton solver with Bank&Rose line search
+  - linear Intel PARDISO, Eigen GMRES or [MUMPS](http://mumps.enseeiht.fr/) solvers
+* Interfaced with
+  - [VTK](https://vtk.org/)
+  - [CUPyDO](https://github.com/ulgltas/CUPyDO)
+  - [openMDAO](https://openmdao.org/)
 
 ## Build
 Detailed build instructions can be found in the [wiki](https://gitlab.uliege.be/am-dept/dartflo/wikis/home).
+
+## References
+Crovato Adrien, [Steady Transonic Aerodynamic and Aeroelastic Modeling for Preliminary Aircraft Design](http://hdl.handle.net/2268/251906), PhD thesis, University of Liège, 2020.
+
+Crovato A., Boman R., Guner H., Terrapon V., Dimitriadis G., Almeida H., Prado A., Breviglieri C., Cabral P., and Silva, G., [A Full Potential Static Aeroelastic Solver for Preliminary Aircraft Design](http://hdl.handle.net/2268/237955), 18th International Forum on Aeroelasticity and Structural Dynamics, IFASD 2019.
+
+Bilocq Amaury, [Implementation of a viscous-inviscid interaction scheme in a finite element full potential solver](http://hdl.handle.net/2268/252195), Master thesis, University of Liège, 2020.
-- 
GitLab