Unverified Commit 466e9b95 authored by greole's avatar greole Committed by GitHub
Browse files

Update README.md

parent 9663fe3f
# 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
......@@ -13,19 +11,16 @@ 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.
......@@ -34,8 +29,7 @@ Currently the following solver are supported
- CG with and without block Jacobi preconditioner
Citing
-------------
## Citing
When using OGL please cite the main Ginkgo paper describing Ginkgo's purpose, design and interface, which is
available through the following reference:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment