Merge branch 'dev' of github.com:greole/OGL into dev

README.md

 # OGL
 
+
 A wrapper for [Ginkgo](https://github.com/ginkgo-project/ginkgo) solver to provide GPGPU capabilities to [OpenFOAM](https://openfoam.org/) 
 
-# Requirements
+## Requirements
+
 
 OGL has the following requirements
 
 * Ginkgo
 * OpenFOAM
 
-# Compilation
+## Compilation
 
-OGL can be compiled using `wmake` in the main folder. Make sure that
+
+OGL can be build using cmake in the main folder. Make sure that
 the `controlDict` includes the `OGL.so` file:
 
     libs ("libOGL.so");
     
-and that `libginkgo.so` can be found.
 
-# Usage
+## Usage
+
 
 OGL solver support the same syntax as the default OpenFOAM solver. Thus, to use a CG solver you can simply replace "PCG" by "GKOCG". In order to run either with CUDA, HIP, or OMP support set the "executor" to cuda, hip, or omp in your solver dictionary. 
 
@@ -26,3 +29,18 @@ Currently the following solver are supported
 
 - CG with and without block Jacobi preconditioner
 
+## Citing 
+
+When using OGL please cite the main Ginkgo paper describing Ginkgo's purpose, design and interface, which is
+available through the following reference:
+
+``` bibtex
+@misc{anzt2020ginkgo,
+    title={Ginkgo: A Modern Linear Operator Algebra Framework for High Performance Computing},
+    author={Hartwig Anzt and Terry Cojean and Goran Flegar and Fritz Göbel and Thomas Grützmacher and Pratik Nayak and Tobias Ribizel and Yuhsiang Mike Tsai and Enrique S. Quintana-Ortí},
+    year={2020},
+    eprint={2006.16852},
+    archivePrefix={arXiv},
+    primaryClass={cs.MS}
+}
+```