Merge pull request #73 from NREL/docup

Update the documentation with the new solver and tutorials

README.md

@@ -18,11 +18,16 @@ conda activate bird
 pip install nrel-bird
 ```
 
-## OpenFOAM solvers
+## Install BiRD solver
 
-Place the attached models in `OFsolvers` into the same arborescence in your `$FOAM_APP` directory. These compile with `openFOAM-9`
+1. Activate your OpenFOAM-9 environment (`source <OpenFOAM-9 installation directory>/etc/<your-shell>rc`)
+2. cd `OFsolvers/birdmultiphaseEulerFoam/`
+3. `./Allwmake`
 
-We provide a new drag model `Grace`, a new interfacial composition model `Higbie` and various other models which magnitude can be controlled via an efficiency factor `*_limited`
+The same steps are done in the `ci.yml` (under `Test-OF - Compile solver`) which can be used as a reference. 
+However, note that `ci.yml` compiles the solver in debug mode which is not suitable for production.
+
+We provide a new drag model `Grace`, a new interfacial composition model `Higbie` and various other models which magnitude can be controlled via an efficiency factor (see [this paper](https://arxiv.org/pdf/2404.19636) for why efficiency factors are useful).
 
 
 ## Meshing
@@ -52,6 +57,10 @@ Mesh visualized in Paraview
   <img src="https://raw.githubusercontent.com/NREL/BioReactorDesign/main/assets/stirred_tank.png" width="350"/>
 </p>
 
+#### Related tutorial
+
+`tutorial_cases/stirred_tank`
+
 
 ### Block cylindrical meshing
 
@@ -165,6 +174,11 @@ options:
                         Output folder for blockMeshDict
 ```
 
+#### Related tutorials
+
+- `tutorial_cases/side_sparger`
+- `tutorial_cases/bubble_column_20L` 
+
 
 ### Block rectangular meshing
 
@@ -211,7 +225,11 @@ The corners are defined in the `input.json`
 }
 ...
 ```
-To see how to use this on an actual case see `OFsolvers/tutorial_cases/loop_reactor`
+
+#### Related tutorials
+
+- `tutorial_cases/loop_reactor_mixing`
+- `tutorial_cases/loop_reactor_reacting` 
 
 ## Preprocess
 ### Generate STL mesh
@@ -227,7 +245,7 @@ Generates
 </p>
 
 
-To see how to use this on an actual case see `OFsolvers/tutorial_cases/loop_reactor`
+To see how to use this on an actual case see `tutorial_cases/loop_reactor_mixing` and `tutorial_cases/loop_reactor_reacting` 
 
 ### Manual
 
@@ -241,7 +259,6 @@ options:
   -i , --input   Boundary patch Json input
   -v, --verbose  plot on screen
 ```
-
 ### How to change the set of shapes in the boundary patch
 
 Edit the json files read when generating the mesh. In the case below, the boundary condition `inlets` consists of 3 discs 
@@ -256,6 +273,12 @@ Edit the json files read when generating the mesh. In the case below, the bounda
 }
 ...
 ```
+### Related tutorials
+
+- `tutorial_cases/bubble_column_20L`
+- `tutorial_cases/loop_reactor_mixing`
+- `tutorial_cases/loop_reactor_reacting` 
+
 
 ## Postprocess