xref: /honee/README.md (revision a240d89ff73a88207d4c64f60d6d33ce1ad93221)
1ea10196cSJeremy L Thompson## libCEED: Navier-Stokes Example
2ea10196cSJeremy L Thompson
3ea10196cSJeremy L ThompsonThis page provides a description of the Navier-Stokes example for the libCEED library, based on PETSc.
4ea10196cSJeremy L Thompson
5ea10196cSJeremy L ThompsonThe Navier-Stokes problem solves the compressible Navier-Stokes equations in three dimensions using an
6ea10196cSJeremy L Thompsonexplicit time integration. The state variables are mass density, momentum density, and energy density.
7ea10196cSJeremy L Thompson
8ea10196cSJeremy L ThompsonThe main Navier-Stokes solver for libCEED is defined in [`navierstokes.c`](navierstokes.c)
9ea10196cSJeremy L Thompsonwith different problem definitions according to the application of interest.
10ea10196cSJeremy L Thompson
11ea10196cSJeremy L ThompsonBuild by using
12ea10196cSJeremy L Thompson
13ea10196cSJeremy L Thompson`make`
14ea10196cSJeremy L Thompson
15ea10196cSJeremy L Thompsonand run with
16ea10196cSJeremy L Thompson
1740f3b208SJed Brown`./navierstokes`
18ea10196cSJeremy L Thompson
19ea10196cSJeremy L ThompsonAvailable runtime options are:
20ea10196cSJeremy L Thompson
21ea10196cSJeremy L Thompson|  Option                  | Meaning                                                                                         |
22ea10196cSJeremy L Thompson| :----------------------- | :-----------------------------------------------------------------------------------------------|
23ea10196cSJeremy L Thompson| `-ceed`                  | CEED resource specifier                                                                         |
24ea10196cSJeremy L Thompson| `-test`                  | Run in test mode                                                                                |
25ea10196cSJeremy L Thompson| `-problem`               | Problem to solve (`advection`, `advection2d`, or `density_current`)                             |
26ea10196cSJeremy L Thompson| `-stab`                  | Stabilization method                                                                            |
27ea10196cSJeremy L Thompson| `-implicit`              | Use implicit time integartor formulation                                                        |
28ea10196cSJeremy L Thompson| `-bc_wall`               | Use wall boundary conditions on this list of faces                                              |
29ea10196cSJeremy L Thompson| `-bc_slip_x`             | Use slip boundary conditions, for the x component, on this list of faces                        |
30ea10196cSJeremy L Thompson| `-bc_slip_y`             | Use slip boundary conditions, for the y component, on this list of faces                        |
31ea10196cSJeremy L Thompson| `-bc_slip_z`             | Use slip boundary conditions, for the z component, on this list of faces                        |
32ea10196cSJeremy L Thompson| `-viz_refine`            | Use regular refinement for visualization                                                        |
3340f3b208SJed Brown| `-degree`                | Polynomial degree of tensor product basis (must be >= 1)                                        |
34ea10196cSJeremy L Thompson| `-units_meter`           | 1 meter in scaled length units                                                                  |
35ea10196cSJeremy L Thompson| `-units_second`          | 1 second in scaled time units                                                                   |
36ea10196cSJeremy L Thompson| `-units_kilogram`        | 1 kilogram in scaled mass units                                                                 |
37ea10196cSJeremy L Thompson| `-units_Kelvin`          | 1 Kelvin in scaled temperature units                                                            |
38ea10196cSJeremy L Thompson| `-theta0`                | Reference potential temperature                                                                 |
39ea10196cSJeremy L Thompson| `-thetaC`                | Perturbation of potential temperature                                                           |
40ea10196cSJeremy L Thompson| `-P0`                    | Atmospheric pressure                                                                            |
41ea10196cSJeremy L Thompson| `-N`                     | Brunt-Vaisala frequency                                                                         |
42ea10196cSJeremy L Thompson| `-cv`                    | Heat capacity at constant volume                                                                |
43ea10196cSJeremy L Thompson| `-cp`                    | Heat capacity at constant pressure                                                              |
44ea10196cSJeremy L Thompson| `-g`                     | Gravitational acceleration                                                                      |
45ea10196cSJeremy L Thompson| `-lambda`                | Stokes hypothesis second viscosity coefficient                                                  |
46ea10196cSJeremy L Thompson| `-mu`                    | Shear dynamic viscosity coefficient                                                             |
47ea10196cSJeremy L Thompson| `-k`                     | Thermal conductivity                                                                            |
48ea10196cSJeremy L Thompson| `-CtauS`                 | Scale coefficient for stabilization tau (nondimensional)                                        |
49ea10196cSJeremy L Thompson| `-strong_form`           | Strong (1) or weak/integrated by parts (0) advection residual                                   |
50ea10196cSJeremy L Thompson| `-lx`                    | Length scale in x direction                                                                     |
51ea10196cSJeremy L Thompson| `-ly`                    | Length scale in y direction                                                                     |
52ea10196cSJeremy L Thompson| `-lz`                    | Length scale in z direction                                                                     |
53ea10196cSJeremy L Thompson| `-rc`                    | Characteristic radius of thermal bubble                                                         |
54ea10196cSJeremy L Thompson| `-resx`                  | Resolution in x                                                                                 |
55ea10196cSJeremy L Thompson| `-resy`                  | Resolution in y                                                                                 |
56ea10196cSJeremy L Thompson| `-resz`                  | Resolution in z                                                                                 |
57ea10196cSJeremy L Thompson| `-center`                | Location of bubble center                                                                       |
58ea10196cSJeremy L Thompson| `-dc_axis`               | Axis of density current cylindrical anomaly, or {0,0,0} for spherically symmetric               |
59ea10196cSJeremy L Thompson| `-output_freq`           | Frequency of output, in number of steps                                                         |
60ea10196cSJeremy L Thompson| `-continue`              | Continue from previous solution                                                                 |
61ea10196cSJeremy L Thompson| `-degree`                | Polynomial degree of tensor product basis                                                       |
62ea10196cSJeremy L Thompson| `-qextra`                | Number of extra quadrature points                                                               |
63ea10196cSJeremy L Thompson| `-of`                    | Output folder                                                                                   |
64ea10196cSJeremy L Thompson
65682b106eSvaleriabarraFor the case of a square/cubic mesh, the list of face indices to be used with `-bc_wall` and/or `-bc_slip_x`,
66*a240d89fSLeila Ghaffari`-bc_slip_y`, and `-bc_slip_z` are:
67682b106eSvaleriabarra
68682b106eSvaleriabarra* 2D:
69682b106eSvaleriabarra  - faceMarkerBottom = 1;
70682b106eSvaleriabarra  - faceMarkerRight  = 2;
71682b106eSvaleriabarra  - faceMarkerTop    = 3;
72682b106eSvaleriabarra  - faceMarkerLeft   = 4;
73682b106eSvaleriabarra* 3D:
74682b106eSvaleriabarra  - faceMarkerBottom = 1;
75682b106eSvaleriabarra  - faceMarkerTop    = 2;
76682b106eSvaleriabarra  - faceMarkerFront  = 3;
77682b106eSvaleriabarra  - faceMarkerBack   = 4;
78682b106eSvaleriabarra  - faceMarkerRight  = 5;
79682b106eSvaleriabarra  - faceMarkerLeft   = 6;
80ea10196cSJeremy L Thompson
81ea10196cSJeremy L Thompson### Advection
82ea10196cSJeremy L Thompson
83ea10196cSJeremy L ThompsonThis problem solves the convection (advection) equation for the total (scalar) energy density,
84ea10196cSJeremy L Thompsontransported by the (vector) velocity field.
85ea10196cSJeremy L Thompson
86ea10196cSJeremy L ThompsonThis is 3D advection given in two formulations based upon the weak form.
87ea10196cSJeremy L Thompson
88ea10196cSJeremy L ThompsonState Variables:
89ea10196cSJeremy L Thompson
90ea10196cSJeremy L Thompson   *q = ( rho, U<sub>1</sub>, U<sub>2</sub>, U<sub>3</sub>, E )*
91ea10196cSJeremy L Thompson
92ea10196cSJeremy L Thompson   *rho* - Mass Density
93ea10196cSJeremy L Thompson
94ea10196cSJeremy L Thompson   *U<sub>i</sub>*  - Momentum Density    ,   *U<sub>i</sub> = rho ui*
95ea10196cSJeremy L Thompson
96ea10196cSJeremy L Thompson   *E*   - Total Energy Density,   *E  = rho Cv T + rho (u u) / 2 + rho g z*
97ea10196cSJeremy L Thompson
98ea10196cSJeremy L ThompsonAdvection Equation:
99ea10196cSJeremy L Thompson
100ea10196cSJeremy L Thompson   *dE/dt + div( E _u_ ) = 0*
101ea10196cSJeremy L Thompson
102ea10196cSJeremy L Thompson#### Initial Conditions
103ea10196cSJeremy L Thompson
104ea10196cSJeremy L ThompsonMass Density:
105ea10196cSJeremy L Thompson    Constant mass density of 1.0
106ea10196cSJeremy L Thompson
107ea10196cSJeremy L ThompsonMomentum Density:
108ea10196cSJeremy L Thompson    Rotational field in x,y with no momentum in z
109ea10196cSJeremy L Thompson
110ea10196cSJeremy L ThompsonEnergy Density:
111ea10196cSJeremy L Thompson    Maximum of 1. x0 decreasing linearly to 0. as radial distance increases
112ea10196cSJeremy L Thompson    to 1/8, then 0. everywhere else
113ea10196cSJeremy L Thompson
114ea10196cSJeremy L Thompson#### Boundary Conditions
115ea10196cSJeremy L Thompson
116ea10196cSJeremy L ThompsonMass Density:
117ea10196cSJeremy L Thompson    0.0 flux
118ea10196cSJeremy L Thompson
119ea10196cSJeremy L ThompsonMomentum Density:
120ea10196cSJeremy L Thompson    0.0
121ea10196cSJeremy L Thompson
122ea10196cSJeremy L ThompsonEnergy Density:
123ea10196cSJeremy L Thompson    0.0 flux
124ea10196cSJeremy L Thompson
125ea10196cSJeremy L Thompson### Density Current
126ea10196cSJeremy L Thompson
127ea10196cSJeremy L ThompsonThis problem solves the full compressible Navier-Stokes equations, using
128ea10196cSJeremy L Thompsonoperator composition and design of coupled solvers in the context of atmospheric
129ea10196cSJeremy L Thompsonmodeling. This problem uses the formulation given in Semi-Implicit Formulations
130ea10196cSJeremy L Thompsonof the Navier-Stokes Equations: Application to Nonhydrostatic Atmospheric Modeling,
131ea10196cSJeremy L ThompsonGiraldo, Restelli, and Lauter (2010).
132ea10196cSJeremy L Thompson
133ea10196cSJeremy L ThompsonThe 3D compressible Navier-Stokes equations are formulated in conservation form with state
134ea10196cSJeremy L Thompsonvariables of density, momentum density, and total energy density.
135ea10196cSJeremy L Thompson
136ea10196cSJeremy L ThompsonState Variables:
137ea10196cSJeremy L Thompson
138ea10196cSJeremy L Thompson   *q = ( rho, U<sub>1</sub>, U<sub>2</sub>, U<sub>3</sub>, E )*
139ea10196cSJeremy L Thompson
140ea10196cSJeremy L Thompson   *rho* - Mass Density
141ea10196cSJeremy L Thompson
142ea10196cSJeremy L Thompson   *U<sub>i</sub>*  - Momentum Density   ,  *U<sub>i</sub> = rho u<sub>i</sub>*
143ea10196cSJeremy L Thompson
144ea10196cSJeremy L Thompson   *E*   - Total Energy Density,  *E  = rho c<sub>v</sub> T + rho (u u) / 2 + rho g z*
145ea10196cSJeremy L Thompson
146ea10196cSJeremy L ThompsonNavier-Stokes Equations:
147ea10196cSJeremy L Thompson
148ea10196cSJeremy L Thompson   *drho/dt + div( U )                               = 0*
149ea10196cSJeremy L Thompson
150ea10196cSJeremy L Thompson   *dU/dt   + div( rho (u x u) + P I<sub>3</sub> ) + rho g khat = div( F<sub>u</sub> )*
151ea10196cSJeremy L Thompson
152ea10196cSJeremy L Thompson   *dE/dt   + div( (E + P) u )                       = div( F<sub>e</sub> )*
153ea10196cSJeremy L Thompson
154ea10196cSJeremy L ThompsonViscous Stress:
155ea10196cSJeremy L Thompson
156ea10196cSJeremy L Thompson   *F<sub>u</sub> = mu (grad( u ) + grad( u )^T + lambda div ( u ) I<sub>3</sub>)*
157ea10196cSJeremy L Thompson
158ea10196cSJeremy L ThompsonThermal Stress:
159ea10196cSJeremy L Thompson
160ea10196cSJeremy L Thompson   *F<sub>e</sub> = u F<sub>u</sub> + k grad( T )*
161ea10196cSJeremy L Thompson
162ea10196cSJeremy L ThompsonEquation of State:
163ea10196cSJeremy L Thompson
164ea10196cSJeremy L Thompson   *P = (gamma - 1) (E - rho (u u) / 2 - rho g z)*
165ea10196cSJeremy L Thompson
166ea10196cSJeremy L ThompsonTemperature:
167ea10196cSJeremy L Thompson
168ea10196cSJeremy L Thompson   *T = (E / rho - (u u) / 2 - g z) / c<sub>v</sub>*
169ea10196cSJeremy L Thompson
170ea10196cSJeremy L ThompsonConstants:
171ea10196cSJeremy L Thompson
172ea10196cSJeremy L Thompson   *lambda = - 2 / 3*,  From Stokes hypothesis
173ea10196cSJeremy L Thompson
174ea10196cSJeremy L Thompson   *mu*              ,  Dynamic viscosity
175ea10196cSJeremy L Thompson
176ea10196cSJeremy L Thompson   *k*               ,  Thermal conductivity
177ea10196cSJeremy L Thompson
178ea10196cSJeremy L Thompson   *c<sub>v</sub>*              ,  Specific heat, constant volume
179ea10196cSJeremy L Thompson
180ea10196cSJeremy L Thompson   *c<sub>p</sub>*              ,  Specific heat, constant pressure
181ea10196cSJeremy L Thompson
182ea10196cSJeremy L Thompson   *g*               ,  Gravity
183ea10196cSJeremy L Thompson
184ea10196cSJeremy L Thompson   *gamma  = c<sub>p</sub> / c<sub>v</sub>*,  Specific heat ratio
185ea10196cSJeremy L Thompson
186ea10196cSJeremy L Thompson#### Initial Conditions
187ea10196cSJeremy L Thompson
188ea10196cSJeremy L ThompsonPotential Temperature:
189ea10196cSJeremy L Thompson
190ea10196cSJeremy L Thompson   *theta = thetabar + deltatheta*
191ea10196cSJeremy L Thompson
192ea10196cSJeremy L Thompson   *thetabar   = theta0 exp( N * * 2 z / g )*
193ea10196cSJeremy L Thompson
194ea10196cSJeremy L Thompson   *deltatheta =
195ea10196cSJeremy L Thompson        r <= rc : theta0(1 + cos(pi r)) / 2
196ea10196cSJeremy L Thompson        r > rc : 0*
197ea10196cSJeremy L Thompson
198ea10196cSJeremy L Thompson   *r        = sqrt( (x - xc) * * 2 + (y - yc) * * 2 + (z - zc) * * 2 )*
199ea10196cSJeremy L Thompson    with *(xc,yc,zc)* center of domain
200ea10196cSJeremy L Thompson
201ea10196cSJeremy L ThompsonExner Pressure:
202ea10196cSJeremy L Thompson
203ea10196cSJeremy L Thompson   *Pi = Pibar + deltaPi*
204ea10196cSJeremy L Thompson
205ea10196cSJeremy L Thompson   *Pibar      = g * * 2 (exp( - N * * 2 z / g ) - 1) / (cp theta0 N * * 2)*
206ea10196cSJeremy L Thompson
207ea10196cSJeremy L Thompson   *deltaPi    = 0* (hydrostatic balance)
208ea10196cSJeremy L Thompson
209ea10196cSJeremy L ThompsonVelocity/Momentum Density:
210ea10196cSJeremy L Thompson
211ea10196cSJeremy L Thompson   *U<sub>i</sub> = u<sub>i</sub> = 0*
212ea10196cSJeremy L Thompson
213ea10196cSJeremy L ThompsonConversion to Conserved Variables:
214ea10196cSJeremy L Thompson
215ea10196cSJeremy L Thompson   *rho = P0 Pi**(c<sub>v</sub>/R<sub>d</sub>) / (R<sub>d</sub> theta)*
216ea10196cSJeremy L Thompson
217ea10196cSJeremy L Thompson   *E   = rho (c<sub>v</sub> theta Pi + (u u)/2 + g z)*
218ea10196cSJeremy L Thompson
219ea10196cSJeremy L ThompsonConstants:
220ea10196cSJeremy L Thompson
221ea10196cSJeremy L Thompson   *theta0*          ,  Potential temperature constant
222ea10196cSJeremy L Thompson
223ea10196cSJeremy L Thompson   *thetaC*          ,  Potential temperature perturbation
224ea10196cSJeremy L Thompson
225ea10196cSJeremy L Thompson   *P0*              ,  Pressure at the surface
226ea10196cSJeremy L Thompson
227ea10196cSJeremy L Thompson   *N*               ,  Brunt-Vaisala frequency
228ea10196cSJeremy L Thompson
229ea10196cSJeremy L Thompson   *c<sub>v</sub>*              ,  Specific heat, constant volume
230ea10196cSJeremy L Thompson
231ea10196cSJeremy L Thompson   *c<sub>p</sub>*              ,  Specific heat, constant pressure
232ea10196cSJeremy L Thompson
233ea10196cSJeremy L Thompson   *R<sub>d</sub>*     = c<sub>p</sub> - c<sub>v</sub>,  Specific heat difference
234ea10196cSJeremy L Thompson
235ea10196cSJeremy L Thompson   *g*               ,  Gravity
236ea10196cSJeremy L Thompson
237ea10196cSJeremy L Thompson   *r<sub>c</sub>*              ,  Characteristic radius of thermal bubble
238ea10196cSJeremy L Thompson
239ea10196cSJeremy L Thompson   *l<sub>x</sub>*              ,  Characteristic length scale of domain in x
240ea10196cSJeremy L Thompson
241ea10196cSJeremy L Thompson   *l<sub>y</sub>*              ,  Characteristic length scale of domain in y
242ea10196cSJeremy L Thompson
243ea10196cSJeremy L Thompson   *l<sub>z</sub>*              ,  Characteristic length scale of domain in z
244ea10196cSJeremy L Thompson
245ea10196cSJeremy L Thompson
246ea10196cSJeremy L Thompson#### Boundary Conditions
247ea10196cSJeremy L Thompson
248ea10196cSJeremy L ThompsonMass Density:
249ea10196cSJeremy L Thompson    0.0 flux
250ea10196cSJeremy L Thompson
251ea10196cSJeremy L ThompsonMomentum Density:
252ea10196cSJeremy L Thompson    0.0
253ea10196cSJeremy L Thompson
254ea10196cSJeremy L ThompsonEnergy Density:
255ea10196cSJeremy L Thompson    0.0 flux
256ea10196cSJeremy L Thompson
257ea10196cSJeremy L Thompson### Time Discretization
258ea10196cSJeremy L Thompson
259682b106eSvaleriabarraFor all different problems, the time integration is performed with an explicit
260682b106eSvaleriabarraor implicit formulation.
261ea10196cSJeremy L Thompson
262ea10196cSJeremy L Thompson### Space Discretization
263ea10196cSJeremy L Thompson
264ea10196cSJeremy L ThompsonThe geometric factors and coordinate transformations required for the integration of the weak form
265ea10196cSJeremy L Thompsonare described in the file [`common.h`](common.h)
266