xref: /honee/README.md (revision 965d9f743f86785935177ec2ff1624a7b09e04f8)
1*965d9f74SJames Wright# HONEE: High-Order Navier-stokes Equation Evaluator
2ea10196cSJeremy L Thompson
3*965d9f74SJames Wright<!-- abstract -->
4ea10196cSJeremy L ThompsonThis page provides a description of the Navier-Stokes example for the libCEED library, based on PETSc.
5ea10196cSJeremy L Thompson
6a515125bSLeila GhaffariThe Navier-Stokes problem solves the compressible Navier-Stokes equations in three dimensions using an explicit time integration.
7a515125bSLeila GhaffariThe state variables are mass density, momentum density, and energy density.
8ea10196cSJeremy L Thompson
9a515125bSLeila GhaffariThe main Navier-Stokes solver for libCEED is defined in [`navierstokes.c`](navierstokes.c) with different problem definitions according to the application of interest.
10ea10196cSJeremy L Thompson
11*965d9f74SJames Wright## Getting Started
12acad7547SJames Wright
13575f8106SLeila GhaffariBuild by using:
14ea10196cSJeremy L Thompson
15ea10196cSJeremy L Thompson`make`
16ea10196cSJeremy L Thompson
17575f8106SLeila Ghaffariand run with:
18ea10196cSJeremy L Thompson
19575f8106SLeila Ghaffari```
20575f8106SLeila Ghaffari./navierstokes -ceed [ceed] -problem [problem type] -degree [degree]
21575f8106SLeila Ghaffari```
22ea10196cSJeremy L Thompson
23acad7547SJames WrightIf you want to do *in situ* machine-learning training, specify `SMARTREDIS_DIR` in the make command like:
24acad7547SJames Wright
25acad7547SJames Wright```
26acad7547SJames Wrightmake SMARTREDIS_DIR=~/software/smartredis/install
27acad7547SJames Wright```
28acad7547SJames Wright
29