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