xref: /honee/problems/newtonian.c (revision 8a02cd4c87f0d986fdd337778674e558be30ecff)
1 // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors.
2 // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause
3 
4 /// @file
5 /// Utility functions for setting up problems using the Newtonian Qfunction
6 
7 #include "../qfunctions/newtonian.h"
8 
9 #include <ceed.h>
10 #include <petscdm.h>
11 
12 #include <navierstokes.h>
13 
14 // For use with PetscOptionsEnum
15 static const char *const StateVariables[] = {"CONSERVATIVE", "PRIMITIVE", "ENTROPY", "StateVariable", "STATEVAR_", NULL};
16 
17 static PetscErrorCode CheckQWithTolerance(const CeedScalar Q_s[5], const CeedScalar Q_a[5], const CeedScalar Q_b[5], const char *name,
18                                           PetscReal rtol_0, PetscReal rtol_u, PetscReal rtol_4) {
19   CeedScalar relative_error[5];  // relative error
20   CeedScalar divisor_threshold = 10 * CEED_EPSILON;
21 
22   PetscFunctionBeginUser;
23   relative_error[0] = (Q_a[0] - Q_b[0]) / (fabs(Q_s[0]) > divisor_threshold ? Q_s[0] : 1);
24   relative_error[4] = (Q_a[4] - Q_b[4]) / (fabs(Q_s[4]) > divisor_threshold ? Q_s[4] : 1);
25 
26   CeedScalar u_magnitude = sqrt(Square(Q_s[1]) + Square(Q_s[2]) + Square(Q_s[3]));
27   CeedScalar u_divisor   = u_magnitude > divisor_threshold ? u_magnitude : 1;
28   for (int i = 1; i < 4; i++) {
29     relative_error[i] = (Q_a[i] - Q_b[i]) / u_divisor;
30   }
31 
32   if (fabs(relative_error[0]) >= rtol_0) {
33     printf("%s[0] error %g (expected %.10e, got %.10e)\n", name, relative_error[0], Q_s[0], Q_a[0]);
34   }
35   for (int i = 1; i < 4; i++) {
36     if (fabs(relative_error[i]) >= rtol_u) {
37       printf("%s[%d] error %g (expected %.10e, got %.10e)\n", name, i, relative_error[i], Q_s[i], Q_a[i]);
38     }
39   }
40   if (fabs(relative_error[4]) >= rtol_4) {
41     printf("%s[4] error %g (expected %.10e, got %.10e)\n", name, relative_error[4], Q_s[4], Q_a[4]);
42   }
43   PetscFunctionReturn(PETSC_SUCCESS);
44 }
45 
46 // @brief Verify `StateFromQ` by converting A0 -> B0 -> A0_test, where A0 should equal A0_test
47 static PetscErrorCode TestState(StateVariable state_var_A, StateVariable state_var_B, NewtonianIdealGasContext gas, const CeedScalar A0[5],
48                                 CeedScalar rtol_0, CeedScalar rtol_u, CeedScalar rtol_4) {
49   CeedScalar        B0[5], A0_test[5];
50   char              buf[128];
51   const char *const StateVariables_Initial[] = {"U", "Y", "V"};
52 
53   PetscFunctionBeginUser;
54   const char *A_initial = StateVariables_Initial[state_var_A];
55   const char *B_initial = StateVariables_Initial[state_var_B];
56 
57   State state_A0 = StateFromQ(gas, A0, state_var_A);
58   StateToQ(gas, state_A0, B0, state_var_B);
59   State state_B0 = StateFromQ(gas, B0, state_var_B);
60   StateToQ(gas, state_B0, A0_test, state_var_A);
61 
62   snprintf(buf, sizeof buf, "%s->%s->%s: %s", A_initial, B_initial, A_initial, A_initial);
63   PetscCall(CheckQWithTolerance(A0, A0_test, A0, buf, rtol_0, rtol_u, rtol_4));
64   PetscFunctionReturn(PETSC_SUCCESS);
65 }
66 
67 // @brief Verify `StateFromQ_fwd` via a finite difference approximation
68 static PetscErrorCode TestState_fwd(StateVariable state_var_A, StateVariable state_var_B, NewtonianIdealGasContext gas, const CeedScalar A0[5],
69                                     CeedScalar rtol_0, CeedScalar rtol_u, CeedScalar rtol_4) {
70   CeedScalar        eps = 4e-7;  // Finite difference step
71   char              buf[128];
72   const char *const StateVariables_Initial[] = {"U", "Y", "V"};
73 
74   PetscFunctionBeginUser;
75   const char *A_initial = StateVariables_Initial[state_var_A];
76   const char *B_initial = StateVariables_Initial[state_var_B];
77   State       state_0   = StateFromQ(gas, A0, state_var_A);
78 
79   for (int i = 0; i < 5; i++) {
80     CeedScalar dB[5] = {0.}, dB_fd[5] = {0.};
81     {  // Calculate dB using State functions
82       CeedScalar dA[5] = {0};
83 
84       dA[i]          = A0[i];
85       State dstate_0 = StateFromQ_fwd(gas, state_0, dA, state_var_A);
86       StateToQ_fwd(gas, state_0, dstate_0, dB, state_var_B);
87     }
88 
89     {  // Calculate dB_fd via finite difference approximation
90       CeedScalar A1[5], B0[5], B1[5];
91 
92       for (int j = 0; j < 5; j++) A1[j] = (1 + eps * (i == j)) * A0[j];
93       State state_1 = StateFromQ(gas, A1, state_var_A);
94       StateToQ(gas, state_0, B0, state_var_B);
95       StateToQ(gas, state_1, B1, state_var_B);
96       for (int j = 0; j < 5; j++) dB_fd[j] = (B1[j] - B0[j]) / eps;
97     }
98 
99     snprintf(buf, sizeof buf, "d%s->d%s: StateFrom%s_fwd i=%d: d%s", A_initial, B_initial, A_initial, i, B_initial);
100     PetscCall(CheckQWithTolerance(dB_fd, dB, dB_fd, buf, rtol_0, rtol_u, rtol_4));
101   }
102   PetscFunctionReturn(PETSC_SUCCESS);
103 }
104 
105 // @brief Test the Newtonian State transformation functions, `StateFrom*`
106 static PetscErrorCode UnitTests_Newtonian(User user, NewtonianIdealGasContext gas) {
107   Units            units = user->units;
108   const CeedScalar kg = units->kilogram, m = units->meter, sec = units->second, K = units->Kelvin;
109 
110   PetscFunctionBeginUser;
111   const CeedScalar T          = 200 * K;
112   const CeedScalar rho        = 1.2 * kg / Cube(m);
113   const CeedScalar P          = (HeatCapacityRatio(gas) - 1) * rho * gas->cv * T;
114   const CeedScalar u_base     = 40 * m / sec;
115   const CeedScalar u[3]       = {u_base, u_base * 1.1, u_base * 1.2};
116   const CeedScalar e_kinetic  = 0.5 * Dot3(u, u);
117   const CeedScalar e_internal = gas->cv * T;
118   const CeedScalar e_total    = e_kinetic + e_internal;
119   const CeedScalar gamma      = HeatCapacityRatio(gas);
120   const CeedScalar entropy    = log(P) - gamma * log(rho);
121   const CeedScalar rho_div_p  = rho / P;
122   const CeedScalar Y0[5]      = {P, u[0], u[1], u[2], T};
123   const CeedScalar U0[5]      = {rho, rho * u[0], rho * u[1], rho * u[2], rho * e_total};
124   const CeedScalar V0[5]      = {(gamma - entropy) / (gamma - 1) - rho_div_p * (e_kinetic), rho_div_p * u[0], rho_div_p * u[1], rho_div_p * u[2],
125                                  -rho_div_p};
126 
127   {
128     CeedScalar rtol = 20 * CEED_EPSILON;
129 
130     PetscCall(TestState(STATEVAR_PRIMITIVE, STATEVAR_CONSERVATIVE, gas, Y0, rtol, rtol, rtol));
131     PetscCall(TestState(STATEVAR_PRIMITIVE, STATEVAR_ENTROPY, gas, Y0, rtol, rtol, rtol));
132     PetscCall(TestState(STATEVAR_CONSERVATIVE, STATEVAR_PRIMITIVE, gas, U0, rtol, rtol, rtol));
133     PetscCall(TestState(STATEVAR_CONSERVATIVE, STATEVAR_ENTROPY, gas, U0, rtol, rtol, rtol));
134     PetscCall(TestState(STATEVAR_ENTROPY, STATEVAR_CONSERVATIVE, gas, V0, rtol, rtol, rtol));
135     PetscCall(TestState(STATEVAR_ENTROPY, STATEVAR_PRIMITIVE, gas, V0, rtol, rtol, rtol));
136   }
137 
138   {
139     CeedScalar rtol = 5e-6;
140 
141     PetscCall(TestState_fwd(STATEVAR_PRIMITIVE, STATEVAR_CONSERVATIVE, gas, Y0, rtol, rtol, rtol));
142     PetscCall(TestState_fwd(STATEVAR_PRIMITIVE, STATEVAR_ENTROPY, gas, Y0, rtol, rtol, rtol));
143     PetscCall(TestState_fwd(STATEVAR_CONSERVATIVE, STATEVAR_PRIMITIVE, gas, U0, rtol, rtol, rtol));
144     PetscCall(TestState_fwd(STATEVAR_CONSERVATIVE, STATEVAR_ENTROPY, gas, U0, 10 * rtol, rtol, rtol));
145     PetscCall(TestState_fwd(STATEVAR_ENTROPY, STATEVAR_CONSERVATIVE, gas, V0, 5 * rtol, rtol, rtol));
146     PetscCall(TestState_fwd(STATEVAR_ENTROPY, STATEVAR_PRIMITIVE, gas, V0, 5 * rtol, 5 * rtol, 5 * rtol));
147   }
148   PetscFunctionReturn(PETSC_SUCCESS);
149 }
150 
151 // @brief Create CeedOperator for stabilized mass KSP for explicit timestepping
152 //
153 // Only used for SUPG stabilization
154 PetscErrorCode CreateKSPMassOperator_NewtonianStabilized(User user, CeedOperator *op_mass) {
155   Ceed                 ceed = user->ceed;
156   CeedInt              num_comp_q, q_data_size;
157   CeedQFunction        qf_mass;
158   CeedElemRestriction  elem_restr_q, elem_restr_qd_i;
159   CeedBasis            basis_q;
160   CeedVector           q_data;
161   CeedQFunctionContext qf_ctx = NULL;
162   PetscInt             dim    = 3;
163 
164   PetscFunctionBeginUser;
165   {  // Get restriction and basis from the RHS function
166     CeedOperator     *sub_ops;
167     CeedOperatorField field;
168     PetscInt          sub_op_index = 0;  // will be 0 for the volume op
169 
170     PetscCallCeed(ceed, CeedCompositeOperatorGetSubList(user->op_rhs_ctx->op, &sub_ops));
171     PetscCallCeed(ceed, CeedOperatorGetFieldByName(sub_ops[sub_op_index], "q", &field));
172     PetscCallCeed(ceed, CeedOperatorFieldGetElemRestriction(field, &elem_restr_q));
173     PetscCallCeed(ceed, CeedOperatorFieldGetBasis(field, &basis_q));
174 
175     PetscCallCeed(ceed, CeedOperatorGetFieldByName(sub_ops[sub_op_index], "qdata", &field));
176     PetscCallCeed(ceed, CeedOperatorFieldGetElemRestriction(field, &elem_restr_qd_i));
177     PetscCallCeed(ceed, CeedOperatorFieldGetVector(field, &q_data));
178 
179     PetscCallCeed(ceed, CeedOperatorGetContext(sub_ops[sub_op_index], &qf_ctx));
180   }
181 
182   PetscCallCeed(ceed, CeedElemRestrictionGetNumComponents(elem_restr_q, &num_comp_q));
183   PetscCallCeed(ceed, CeedElemRestrictionGetNumComponents(elem_restr_qd_i, &q_data_size));
184 
185   PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, MassFunction_Newtonian_Conserv, MassFunction_Newtonian_Conserv_loc, &qf_mass));
186 
187   PetscCallCeed(ceed, CeedQFunctionSetContext(qf_mass, qf_ctx));
188   PetscCallCeed(ceed, CeedQFunctionSetUserFlopsEstimate(qf_mass, 0));
189   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "q_dot", 5, CEED_EVAL_INTERP));
190   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "q", 5, CEED_EVAL_INTERP));
191   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "qdata", q_data_size, CEED_EVAL_NONE));
192   PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_mass, "v", 5, CEED_EVAL_INTERP));
193   PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_mass, "Grad_v", 5 * dim, CEED_EVAL_GRAD));
194 
195   PetscCallCeed(ceed, CeedOperatorCreate(ceed, qf_mass, NULL, NULL, op_mass));
196   PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "q_dot", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE));
197   PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "q", elem_restr_q, basis_q, user->q_ceed));
198   PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "qdata", elem_restr_qd_i, CEED_BASIS_NONE, q_data));
199   PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "v", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE));
200   PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "Grad_v", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE));
201 
202   PetscCallCeed(ceed, CeedQFunctionContextDestroy(&qf_ctx));
203   PetscCallCeed(ceed, CeedQFunctionDestroy(&qf_mass));
204   PetscFunctionReturn(PETSC_SUCCESS);
205 }
206 
207 PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx, SimpleBC bc) {
208   SetupContext             setup_context;
209   User                     user   = *(User *)ctx;
210   CeedInt                  degree = user->app_ctx->degree;
211   StabilizationType        stab;
212   StateVariable            state_var;
213   MPI_Comm                 comm = user->comm;
214   Ceed                     ceed = user->ceed;
215   PetscBool                implicit;
216   PetscBool                unit_tests;
217   NewtonianIdealGasContext newtonian_ig_ctx;
218   CeedQFunctionContext     newtonian_ig_qfctx;
219 
220   PetscFunctionBeginUser;
221   PetscCall(PetscCalloc1(1, &setup_context));
222   PetscCall(PetscCalloc1(1, &newtonian_ig_ctx));
223 
224   // ------------------------------------------------------
225   //           Setup Generic Newtonian IG Problem
226   // ------------------------------------------------------
227   problem->jac_data_size_sur            = 11;
228   problem->compute_exact_solution_error = PETSC_FALSE;
229   problem->print_info                   = PRINT_NEWTONIAN;
230   problem->uses_newtonian               = PETSC_TRUE;
231 
232   // ------------------------------------------------------
233   //             Create the libCEED context
234   // ------------------------------------------------------
235   CeedScalar cv         = 717.;          // J/(kg K)
236   CeedScalar cp         = 1004.;         // J/(kg K)
237   CeedScalar g[3]       = {0, 0, 0};     // m/s^2
238   CeedScalar lambda     = -2. / 3.;      // -
239   CeedScalar mu         = 1.8e-5;        // Pa s, dynamic viscosity
240   CeedScalar k          = 0.02638;       // W/(m K)
241   CeedScalar c_tau      = 0.5 / degree;  // -
242   CeedScalar Ctau_t     = 1.0;           // -
243   CeedScalar Cv_func[3] = {36, 60, 128};
244   CeedScalar Ctau_v     = Cv_func[(CeedInt)Min(3, degree) - 1];
245   CeedScalar Ctau_C     = 0.25 / degree;
246   CeedScalar Ctau_M     = 0.25 / degree;
247   CeedScalar Ctau_E     = 0.125;
248   PetscReal  domain_min[3], domain_max[3], domain_size[3];
249   PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
250   for (PetscInt i = 0; i < 3; i++) domain_size[i] = domain_max[i] - domain_min[i];
251 
252   StatePrimitive reference      = {.pressure = 1.01e5, .velocity = {0}, .temperature = 288.15};
253   CeedScalar     idl_decay_time = -1, idl_start = 0, idl_length = 0, idl_pressure = reference.pressure;
254   PetscBool      idl_enable = PETSC_FALSE;
255 
256   // ------------------------------------------------------
257   //             Create the PETSc context
258   // ------------------------------------------------------
259   PetscScalar meter    = 1;  // 1 meter in scaled length units
260   PetscScalar kilogram = 1;  // 1 kilogram in scaled mass units
261   PetscScalar second   = 1;  // 1 second in scaled time units
262   PetscScalar Kelvin   = 1;  // 1 Kelvin in scaled temperature units
263   PetscScalar W_per_m_K, Pascal, J_per_kg_K, m_per_squared_s;
264 
265   // ------------------------------------------------------
266   //              Command line Options
267   // ------------------------------------------------------
268   PetscBool given_option = PETSC_FALSE;
269   PetscOptionsBegin(comm, NULL, "Options for Newtonian Ideal Gas based problem", NULL);
270   // -- Conservative vs Primitive variables
271   PetscCall(PetscOptionsEnum("-state_var", "State variables used", NULL, StateVariables, (PetscEnum)(state_var = STATEVAR_CONSERVATIVE),
272                              (PetscEnum *)&state_var, NULL));
273 
274   switch (state_var) {
275     case STATEVAR_CONSERVATIVE:
276       problem->ics.qf_func_ptr                   = ICsNewtonianIG_Conserv;
277       problem->ics.qf_loc                        = ICsNewtonianIG_Conserv_loc;
278       problem->apply_vol_rhs.qf_func_ptr         = RHSFunction_Newtonian;
279       problem->apply_vol_rhs.qf_loc              = RHSFunction_Newtonian_loc;
280       problem->apply_vol_ifunction.qf_func_ptr   = IFunction_Newtonian_Conserv;
281       problem->apply_vol_ifunction.qf_loc        = IFunction_Newtonian_Conserv_loc;
282       problem->apply_vol_ijacobian.qf_func_ptr   = IJacobian_Newtonian_Conserv;
283       problem->apply_vol_ijacobian.qf_loc        = IJacobian_Newtonian_Conserv_loc;
284       problem->apply_inflow.qf_func_ptr          = BoundaryIntegral_Conserv;
285       problem->apply_inflow.qf_loc               = BoundaryIntegral_Conserv_loc;
286       problem->apply_inflow_jacobian.qf_func_ptr = BoundaryIntegral_Jacobian_Conserv;
287       problem->apply_inflow_jacobian.qf_loc      = BoundaryIntegral_Jacobian_Conserv_loc;
288       break;
289     case STATEVAR_PRIMITIVE:
290       problem->ics.qf_func_ptr                   = ICsNewtonianIG_Prim;
291       problem->ics.qf_loc                        = ICsNewtonianIG_Prim_loc;
292       problem->apply_vol_ifunction.qf_func_ptr   = IFunction_Newtonian_Prim;
293       problem->apply_vol_ifunction.qf_loc        = IFunction_Newtonian_Prim_loc;
294       problem->apply_vol_ijacobian.qf_func_ptr   = IJacobian_Newtonian_Prim;
295       problem->apply_vol_ijacobian.qf_loc        = IJacobian_Newtonian_Prim_loc;
296       problem->apply_inflow.qf_func_ptr          = BoundaryIntegral_Prim;
297       problem->apply_inflow.qf_loc               = BoundaryIntegral_Prim_loc;
298       problem->apply_inflow_jacobian.qf_func_ptr = BoundaryIntegral_Jacobian_Prim;
299       problem->apply_inflow_jacobian.qf_loc      = BoundaryIntegral_Jacobian_Prim_loc;
300       break;
301     case STATEVAR_ENTROPY:
302       problem->ics.qf_func_ptr                   = ICsNewtonianIG_Entropy;
303       problem->ics.qf_loc                        = ICsNewtonianIG_Entropy_loc;
304       problem->apply_vol_ifunction.qf_func_ptr   = IFunction_Newtonian_Entropy;
305       problem->apply_vol_ifunction.qf_loc        = IFunction_Newtonian_Entropy_loc;
306       problem->apply_vol_ijacobian.qf_func_ptr   = IJacobian_Newtonian_Entropy;
307       problem->apply_vol_ijacobian.qf_loc        = IJacobian_Newtonian_Entropy_loc;
308       problem->apply_inflow.qf_func_ptr          = BoundaryIntegral_Entropy;
309       problem->apply_inflow.qf_loc               = BoundaryIntegral_Entropy_loc;
310       problem->apply_inflow_jacobian.qf_func_ptr = BoundaryIntegral_Jacobian_Entropy;
311       problem->apply_inflow_jacobian.qf_loc      = BoundaryIntegral_Jacobian_Entropy_loc;
312       break;
313   }
314 
315   // -- Physics
316   PetscCall(PetscOptionsScalar("-cv", "Heat capacity at constant volume", NULL, cv, &cv, NULL));
317   PetscCall(PetscOptionsScalar("-cp", "Heat capacity at constant pressure", NULL, cp, &cp, NULL));
318   PetscCall(PetscOptionsScalar("-lambda", "Stokes hypothesis second viscosity coefficient", NULL, lambda, &lambda, NULL));
319   PetscCall(PetscOptionsScalar("-mu", "Shear dynamic viscosity coefficient", NULL, mu, &mu, NULL));
320   PetscCall(PetscOptionsScalar("-k", "Thermal conductivity", NULL, k, &k, NULL));
321 
322   PetscInt dim = 3;
323   PetscCall(PetscOptionsDeprecated("-g", "-gravity", "libCEED 0.11.1", NULL));
324   PetscCall(PetscOptionsRealArray("-gravity", "Gravitational acceleration vector", NULL, g, &dim, &given_option));
325   if (given_option) PetscCheck(dim == 3, comm, PETSC_ERR_ARG_SIZ, "Gravity vector must be size 3, %" PetscInt_FMT " values given", dim);
326 
327   PetscCall(PetscOptionsEnum("-stab", "Stabilization method", NULL, StabilizationTypes, (PetscEnum)(stab = STAB_NONE), (PetscEnum *)&stab, NULL));
328   PetscCall(PetscOptionsScalar("-c_tau", "Stabilization constant", NULL, c_tau, &c_tau, NULL));
329   PetscCall(PetscOptionsScalar("-Ctau_t", "Stabilization time constant", NULL, Ctau_t, &Ctau_t, NULL));
330   PetscCall(PetscOptionsScalar("-Ctau_v", "Stabilization viscous constant", NULL, Ctau_v, &Ctau_v, NULL));
331   PetscCall(PetscOptionsScalar("-Ctau_C", "Stabilization continuity constant", NULL, Ctau_C, &Ctau_C, NULL));
332   PetscCall(PetscOptionsScalar("-Ctau_M", "Stabilization momentum constant", NULL, Ctau_M, &Ctau_M, NULL));
333   PetscCall(PetscOptionsScalar("-Ctau_E", "Stabilization energy constant", NULL, Ctau_E, &Ctau_E, NULL));
334   PetscCall(PetscOptionsBool("-implicit", "Use implicit (IFunction) formulation", NULL, implicit = PETSC_FALSE, &implicit, NULL));
335   PetscCall(PetscOptionsBool("-newtonian_unit_tests", "Run Newtonian unit tests", NULL, unit_tests = PETSC_FALSE, &unit_tests, NULL));
336 
337   dim = 3;
338   PetscCall(PetscOptionsScalar("-reference_pressure", "Reference/initial pressure", NULL, reference.pressure, &reference.pressure, NULL));
339   PetscCall(PetscOptionsScalarArray("-reference_velocity", "Reference/initial velocity", NULL, reference.velocity, &dim, NULL));
340   PetscCall(PetscOptionsScalar("-reference_temperature", "Reference/initial temperature", NULL, reference.temperature, &reference.temperature, NULL));
341 
342   // -- Units
343   PetscCall(PetscOptionsScalar("-units_meter", "1 meter in scaled length units", NULL, meter, &meter, NULL));
344   meter = fabs(meter);
345   PetscCall(PetscOptionsScalar("-units_kilogram", "1 kilogram in scaled mass units", NULL, kilogram, &kilogram, NULL));
346   kilogram = fabs(kilogram);
347   PetscCall(PetscOptionsScalar("-units_second", "1 second in scaled time units", NULL, second, &second, NULL));
348   second = fabs(second);
349   PetscCall(PetscOptionsScalar("-units_Kelvin", "1 Kelvin in scaled temperature units", NULL, Kelvin, &Kelvin, NULL));
350   Kelvin = fabs(Kelvin);
351 
352   // -- Warnings
353   PetscCheck(!(state_var == STATEVAR_PRIMITIVE && !implicit), comm, PETSC_ERR_SUP,
354              "RHSFunction is not provided for primitive variables (use -state_var primitive only with -implicit)\n");
355 
356   PetscCall(PetscOptionsScalar("-idl_decay_time", "Characteristic timescale of the pressure deviance decay. The timestep is good starting point",
357                                NULL, idl_decay_time, &idl_decay_time, &idl_enable));
358   PetscCheck(!(idl_enable && idl_decay_time == 0), comm, PETSC_ERR_SUP, "idl_decay_time may not be equal to zero.");
359   if (idl_decay_time < 0) idl_enable = PETSC_FALSE;
360   PetscCall(PetscOptionsScalar("-idl_start", "Start of IDL in the x direction", NULL, idl_start, &idl_start, NULL));
361   PetscCall(PetscOptionsScalar("-idl_length", "Length of IDL in the positive x direction", NULL, idl_length, &idl_length, NULL));
362   idl_pressure = reference.pressure;
363   PetscCall(PetscOptionsScalar("-idl_pressure", "Pressure IDL uses as reference (default is `-reference_pressure`)", NULL, idl_pressure,
364                                &idl_pressure, NULL));
365   PetscOptionsEnd();
366 
367   if (stab == STAB_SUPG && !implicit) problem->create_mass_operator = CreateKSPMassOperator_NewtonianStabilized;
368 
369   // ------------------------------------------------------
370   //           Set up the PETSc context
371   // ------------------------------------------------------
372   // -- Define derived units
373   Pascal          = kilogram / (meter * PetscSqr(second));
374   J_per_kg_K      = PetscSqr(meter) / (PetscSqr(second) * Kelvin);
375   m_per_squared_s = meter / PetscSqr(second);
376   W_per_m_K       = kilogram * meter / (pow(second, 3) * Kelvin);
377 
378   user->units->meter           = meter;
379   user->units->kilogram        = kilogram;
380   user->units->second          = second;
381   user->units->Kelvin          = Kelvin;
382   user->units->Pascal          = Pascal;
383   user->units->J_per_kg_K      = J_per_kg_K;
384   user->units->m_per_squared_s = m_per_squared_s;
385   user->units->W_per_m_K       = W_per_m_K;
386 
387   // ------------------------------------------------------
388   //           Set up the libCEED context
389   // ------------------------------------------------------
390   // -- Scale variables to desired units
391   cv *= J_per_kg_K;
392   cp *= J_per_kg_K;
393   mu *= Pascal * second;
394   k *= W_per_m_K;
395   for (PetscInt i = 0; i < 3; i++) domain_size[i] *= meter;
396   for (PetscInt i = 0; i < 3; i++) g[i] *= m_per_squared_s;
397   reference.pressure *= Pascal;
398   for (PetscInt i = 0; i < 3; i++) reference.velocity[i] *= meter / second;
399   reference.temperature *= Kelvin;
400 
401   // -- Solver Settings
402   user->phys->implicit  = implicit;
403   user->phys->state_var = state_var;
404 
405   // -- QFunction Context
406   newtonian_ig_ctx->lambda        = lambda;
407   newtonian_ig_ctx->mu            = mu;
408   newtonian_ig_ctx->k             = k;
409   newtonian_ig_ctx->cv            = cv;
410   newtonian_ig_ctx->cp            = cp;
411   newtonian_ig_ctx->c_tau         = c_tau;
412   newtonian_ig_ctx->Ctau_t        = Ctau_t;
413   newtonian_ig_ctx->Ctau_v        = Ctau_v;
414   newtonian_ig_ctx->Ctau_C        = Ctau_C;
415   newtonian_ig_ctx->Ctau_M        = Ctau_M;
416   newtonian_ig_ctx->Ctau_E        = Ctau_E;
417   newtonian_ig_ctx->stabilization = stab;
418   newtonian_ig_ctx->is_implicit   = implicit;
419   newtonian_ig_ctx->state_var     = state_var;
420   newtonian_ig_ctx->idl_enable    = idl_enable;
421   newtonian_ig_ctx->idl_amplitude = 1 / (idl_decay_time * second);
422   newtonian_ig_ctx->idl_start     = idl_start * meter;
423   newtonian_ig_ctx->idl_length    = idl_length * meter;
424   newtonian_ig_ctx->idl_pressure  = idl_pressure;
425   PetscCall(PetscArraycpy(newtonian_ig_ctx->g, g, 3));
426 
427   // -- Setup Context
428   setup_context->reference = reference;
429   setup_context->gas       = *newtonian_ig_ctx;
430   setup_context->lx        = domain_size[0];
431   setup_context->ly        = domain_size[1];
432   setup_context->lz        = domain_size[2];
433   setup_context->time      = 0;
434 
435   PetscCallCeed(ceed, CeedQFunctionContextCreate(user->ceed, &problem->ics.qfctx));
436   PetscCallCeed(ceed, CeedQFunctionContextSetData(problem->ics.qfctx, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*setup_context), setup_context));
437   PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(problem->ics.qfctx, CEED_MEM_HOST, FreeContextPetsc));
438   PetscCallCeed(
439       ceed, CeedQFunctionContextRegisterDouble(problem->ics.qfctx, "evaluation time", offsetof(struct SetupContext_, time), 1, "Time of evaluation"));
440 
441   PetscCallCeed(ceed, CeedQFunctionContextCreate(user->ceed, &newtonian_ig_qfctx));
442   PetscCallCeed(ceed, CeedQFunctionContextSetData(newtonian_ig_qfctx, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*newtonian_ig_ctx), newtonian_ig_ctx));
443   PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(newtonian_ig_qfctx, CEED_MEM_HOST, FreeContextPetsc));
444   PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(newtonian_ig_qfctx, "timestep size", offsetof(struct NewtonianIdealGasContext_, dt), 1,
445                                                          "Size of timestep, delta t"));
446   PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(newtonian_ig_qfctx, "ijacobian time shift",
447                                                          offsetof(struct NewtonianIdealGasContext_, ijacobian_time_shift), 1,
448                                                          "Shift for mass matrix in IJacobian"));
449   PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(newtonian_ig_qfctx, "solution time", offsetof(struct NewtonianIdealGasContext_, time), 1,
450                                                          "Current solution time"));
451 
452   problem->apply_vol_rhs.qfctx = newtonian_ig_qfctx;
453   PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(newtonian_ig_qfctx, &problem->apply_vol_ifunction.qfctx));
454   PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(newtonian_ig_qfctx, &problem->apply_vol_ijacobian.qfctx));
455   PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(newtonian_ig_qfctx, &problem->apply_inflow.qfctx));
456   PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(newtonian_ig_qfctx, &problem->apply_inflow_jacobian.qfctx));
457 
458   if (bc->num_freestream > 0) PetscCall(FreestreamBCSetup(problem, dm, ctx, newtonian_ig_ctx, &reference));
459   if (bc->num_outflow > 0) PetscCall(OutflowBCSetup(problem, dm, ctx, newtonian_ig_ctx, &reference));
460   if (bc->num_slip > 0) PetscCall(SlipBCSetup(problem, dm, ctx, newtonian_ig_qfctx));
461 
462   if (unit_tests) {
463     PetscCall(UnitTests_Newtonian(user, newtonian_ig_ctx));
464   }
465   PetscFunctionReturn(PETSC_SUCCESS);
466 }
467 
468 PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData problem, AppCtx app_ctx) {
469   MPI_Comm                 comm = user->comm;
470   Ceed                     ceed = user->ceed;
471   NewtonianIdealGasContext newtonian_ctx;
472 
473   PetscFunctionBeginUser;
474   PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->apply_vol_rhs.qfctx, CEED_MEM_HOST, &newtonian_ctx));
475   PetscCall(PetscPrintf(comm,
476                         "  Problem:\n"
477                         "    Problem Name                       : %s\n"
478                         "    Stabilization                      : %s\n",
479                         app_ctx->problem_name, StabilizationTypes[newtonian_ctx->stabilization]));
480   PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfctx, &newtonian_ctx));
481   PetscFunctionReturn(PETSC_SUCCESS);
482 }
483