xref: /petsc/src/ts/tutorials/ex9.c (revision 48a46eb9bd028bec07ec0f396b1a3abb43f14558)
1c4762a1bSJed Brown static const char help[] = "1D periodic Finite Volume solver in slope-limiter form with semidiscrete time stepping.\n"
2c4762a1bSJed Brown                            "Solves scalar and vector problems, choose the physical model with -physics\n"
3c4762a1bSJed Brown                            "  advection   - Constant coefficient scalar advection\n"
4c4762a1bSJed Brown                            "                u_t       + (a*u)_x               = 0\n"
5c4762a1bSJed Brown                            "  burgers     - Burgers equation\n"
6c4762a1bSJed Brown                            "                u_t       + (u^2/2)_x             = 0\n"
7c4762a1bSJed Brown                            "  traffic     - Traffic equation\n"
8c4762a1bSJed Brown                            "                u_t       + (u*(1-u))_x           = 0\n"
9c4762a1bSJed Brown                            "  acoustics   - Acoustic wave propagation\n"
10c4762a1bSJed Brown                            "                u_t       + (c*z*v)_x             = 0\n"
11c4762a1bSJed Brown                            "                v_t       + (c/z*u)_x             = 0\n"
12c4762a1bSJed Brown                            "  isogas      - Isothermal gas dynamics\n"
13c4762a1bSJed Brown                            "                rho_t     + (rho*u)_x             = 0\n"
14c4762a1bSJed Brown                            "                (rho*u)_t + (rho*u^2 + c^2*rho)_x = 0\n"
15c4762a1bSJed Brown                            "  shallow     - Shallow water equations\n"
16c4762a1bSJed Brown                            "                h_t       + (h*u)_x               = 0\n"
17c4762a1bSJed Brown                            "                (h*u)_t   + (h*u^2 + g*h^2/2)_x   = 0\n"
18c4762a1bSJed Brown                            "Some of these physical models have multiple Riemann solvers, select these with -physics_xxx_riemann\n"
19c4762a1bSJed Brown                            "  exact       - Exact Riemann solver which usually needs to perform a Newton iteration to connect\n"
20c4762a1bSJed Brown                            "                the states across shocks and rarefactions\n"
21c4762a1bSJed Brown                            "  roe         - Linearized scheme, usually with an entropy fix inside sonic rarefactions\n"
22c4762a1bSJed Brown                            "The systems provide a choice of reconstructions with -physics_xxx_reconstruct\n"
23c4762a1bSJed Brown                            "  characteristic - Limit the characteristic variables, this is usually preferred (default)\n"
24c4762a1bSJed Brown                            "  conservative   - Limit the conservative variables directly, can cause undesired interaction of waves\n\n"
25c4762a1bSJed Brown                            "A variety of limiters for high-resolution TVD limiters are available with -limit\n"
26c4762a1bSJed Brown                            "  upwind,minmod,superbee,mc,vanleer,vanalbada,koren,cada-torillhon (last two are nominally third order)\n"
27c4762a1bSJed Brown                            "  and non-TVD schemes lax-wendroff,beam-warming,fromm\n\n"
28c4762a1bSJed Brown                            "To preserve the TVD property, one should time step with a strong stability preserving method.\n"
29c4762a1bSJed Brown                            "The optimal high order explicit Runge-Kutta methods in TSSSP are recommended for non-stiff problems.\n\n"
30c4762a1bSJed Brown                            "Several initial conditions can be chosen with -initial N\n\n"
31c4762a1bSJed Brown                            "The problem size should be set with -da_grid_x M\n\n";
32c4762a1bSJed Brown 
33c4762a1bSJed Brown #include <petscts.h>
34c4762a1bSJed Brown #include <petscdm.h>
35c4762a1bSJed Brown #include <petscdmda.h>
36c4762a1bSJed Brown #include <petscdraw.h>
37c4762a1bSJed Brown 
38c4762a1bSJed Brown #include <petsc/private/kernels/blockinvert.h> /* For the Kernel_*_gets_* stuff for BAIJ */
39c4762a1bSJed Brown 
409371c9d4SSatish Balay static inline PetscReal Sgn(PetscReal a) {
419371c9d4SSatish Balay   return (a < 0) ? -1 : 1;
429371c9d4SSatish Balay }
439371c9d4SSatish Balay static inline PetscReal Abs(PetscReal a) {
449371c9d4SSatish Balay   return (a < 0) ? 0 : a;
459371c9d4SSatish Balay }
469371c9d4SSatish Balay static inline PetscReal Sqr(PetscReal a) {
479371c9d4SSatish Balay   return a * a;
489371c9d4SSatish Balay }
499371c9d4SSatish Balay static inline PetscReal MaxAbs(PetscReal a, PetscReal b) {
509371c9d4SSatish Balay   return (PetscAbs(a) > PetscAbs(b)) ? a : b;
519371c9d4SSatish Balay }
529371c9d4SSatish Balay PETSC_UNUSED static inline PetscReal MinAbs(PetscReal a, PetscReal b) {
539371c9d4SSatish Balay   return (PetscAbs(a) < PetscAbs(b)) ? a : b;
549371c9d4SSatish Balay }
559371c9d4SSatish Balay static inline PetscReal MinMod2(PetscReal a, PetscReal b) {
569371c9d4SSatish Balay   return (a * b < 0) ? 0 : Sgn(a) * PetscMin(PetscAbs(a), PetscAbs(b));
579371c9d4SSatish Balay }
589371c9d4SSatish Balay static inline PetscReal MaxMod2(PetscReal a, PetscReal b) {
599371c9d4SSatish Balay   return (a * b < 0) ? 0 : Sgn(a) * PetscMax(PetscAbs(a), PetscAbs(b));
609371c9d4SSatish Balay }
619371c9d4SSatish Balay static inline PetscReal MinMod3(PetscReal a, PetscReal b, PetscReal c) {
629371c9d4SSatish Balay   return (a * b < 0 || a * c < 0) ? 0 : Sgn(a) * PetscMin(PetscAbs(a), PetscMin(PetscAbs(b), PetscAbs(c)));
639371c9d4SSatish Balay }
64c4762a1bSJed Brown 
659371c9d4SSatish Balay static inline PetscReal RangeMod(PetscReal a, PetscReal xmin, PetscReal xmax) {
669371c9d4SSatish Balay   PetscReal range = xmax - xmin;
679371c9d4SSatish Balay   return xmin + PetscFmodReal(range + PetscFmodReal(a, range), range);
689371c9d4SSatish Balay }
69c4762a1bSJed Brown 
70c4762a1bSJed Brown /* ----------------------- Lots of limiters, these could go in a separate library ------------------------- */
71c4762a1bSJed Brown typedef struct _LimitInfo {
72c4762a1bSJed Brown   PetscReal hx;
73c4762a1bSJed Brown   PetscInt  m;
74c4762a1bSJed Brown } * LimitInfo;
759371c9d4SSatish Balay static void Limit_Upwind(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
76c4762a1bSJed Brown   PetscInt i;
77c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = 0;
78c4762a1bSJed Brown }
799371c9d4SSatish Balay static void Limit_LaxWendroff(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
80c4762a1bSJed Brown   PetscInt i;
81c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = jR[i];
82c4762a1bSJed Brown }
839371c9d4SSatish Balay static void Limit_BeamWarming(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
84c4762a1bSJed Brown   PetscInt i;
85c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = jL[i];
86c4762a1bSJed Brown }
879371c9d4SSatish Balay static void Limit_Fromm(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
88c4762a1bSJed Brown   PetscInt i;
89c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = 0.5 * (jL[i] + jR[i]);
90c4762a1bSJed Brown }
919371c9d4SSatish Balay static void Limit_Minmod(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
92c4762a1bSJed Brown   PetscInt i;
93c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = MinMod2(jL[i], jR[i]);
94c4762a1bSJed Brown }
959371c9d4SSatish Balay static void Limit_Superbee(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
96c4762a1bSJed Brown   PetscInt i;
97c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = MaxMod2(MinMod2(jL[i], 2 * jR[i]), MinMod2(2 * jL[i], jR[i]));
98c4762a1bSJed Brown }
999371c9d4SSatish Balay static void Limit_MC(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
100c4762a1bSJed Brown   PetscInt i;
101c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = MinMod3(2 * jL[i], 0.5 * (jL[i] + jR[i]), 2 * jR[i]);
102c4762a1bSJed Brown }
1039371c9d4SSatish Balay static void Limit_VanLeer(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) { /* phi = (t + abs(t)) / (1 + abs(t)) */
104c4762a1bSJed Brown   PetscInt i;
105c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = (jL[i] * Abs(jR[i]) + Abs(jL[i]) * jR[i]) / (Abs(jL[i]) + Abs(jR[i]) + 1e-15);
106c4762a1bSJed Brown }
107c4762a1bSJed Brown static void Limit_VanAlbada(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) /* differentiable */
108c4762a1bSJed Brown {                                                                                                           /* phi = (t + t^2) / (1 + t^2) */
109c4762a1bSJed Brown   PetscInt i;
110c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = (jL[i] * Sqr(jR[i]) + Sqr(jL[i]) * jR[i]) / (Sqr(jL[i]) + Sqr(jR[i]) + 1e-15);
111c4762a1bSJed Brown }
1129371c9d4SSatish Balay static void Limit_VanAlbadaTVD(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) { /* phi = (t + t^2) / (1 + t^2) */
113c4762a1bSJed Brown   PetscInt i;
114c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = (jL[i] * jR[i] < 0) ? 0 : (jL[i] * Sqr(jR[i]) + Sqr(jL[i]) * jR[i]) / (Sqr(jL[i]) + Sqr(jR[i]) + 1e-15);
115c4762a1bSJed Brown }
116c4762a1bSJed Brown static void Limit_Koren(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) /* differentiable */
117c4762a1bSJed Brown {                                                                                                       /* phi = (t + 2*t^2) / (2 - t + 2*t^2) */
118c4762a1bSJed Brown   PetscInt i;
119c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = ((jL[i] * Sqr(jR[i]) + 2 * Sqr(jL[i]) * jR[i]) / (2 * Sqr(jL[i]) - jL[i] * jR[i] + 2 * Sqr(jR[i]) + 1e-15));
120c4762a1bSJed Brown }
121c4762a1bSJed Brown static void Limit_KorenSym(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) /* differentiable */
122c4762a1bSJed Brown {                                                                                                          /* Symmetric version of above */
123c4762a1bSJed Brown   PetscInt i;
124c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = (1.5 * (jL[i] * Sqr(jR[i]) + Sqr(jL[i]) * jR[i]) / (2 * Sqr(jL[i]) - jL[i] * jR[i] + 2 * Sqr(jR[i]) + 1e-15));
125c4762a1bSJed Brown }
1269371c9d4SSatish Balay static void Limit_Koren3(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) { /* Eq 11 of Cada-Torrilhon 2009 */
127c4762a1bSJed Brown   PetscInt i;
128c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = MinMod3(2 * jL[i], (jL[i] + 2 * jR[i]) / 3, 2 * jR[i]);
129c4762a1bSJed Brown }
1309371c9d4SSatish Balay static PetscReal CadaTorrilhonPhiHatR_Eq13(PetscReal L, PetscReal R) {
131c4762a1bSJed Brown   return PetscMax(0, PetscMin((L + 2 * R) / 3, PetscMax(-0.5 * L, PetscMin(2 * L, PetscMin((L + 2 * R) / 3, 1.6 * R)))));
132c4762a1bSJed Brown }
1339371c9d4SSatish Balay static void Limit_CadaTorrilhon2(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) { /* Cada-Torrilhon 2009, Eq 13 */
134c4762a1bSJed Brown   PetscInt i;
135c4762a1bSJed Brown   for (i = 0; i < info->m; i++) lmt[i] = CadaTorrilhonPhiHatR_Eq13(jL[i], jR[i]);
136c4762a1bSJed Brown }
1379371c9d4SSatish Balay static void Limit_CadaTorrilhon3R(PetscReal r, LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) { /* Cada-Torrilhon 2009, Eq 22 */
138c4762a1bSJed Brown   /* They recommend 0.001 < r < 1, but larger values are more accurate in smooth regions */
139c4762a1bSJed Brown   const PetscReal eps = 1e-7, hx = info->hx;
140c4762a1bSJed Brown   PetscInt        i;
141c4762a1bSJed Brown   for (i = 0; i < info->m; i++) {
142c4762a1bSJed Brown     const PetscReal eta = (Sqr(jL[i]) + Sqr(jR[i])) / Sqr(r * hx);
143c4762a1bSJed Brown     lmt[i] = ((eta < 1 - eps) ? (jL[i] + 2 * jR[i]) / 3 : ((eta > 1 + eps) ? CadaTorrilhonPhiHatR_Eq13(jL[i], jR[i]) : 0.5 * ((1 - (eta - 1) / eps) * (jL[i] + 2 * jR[i]) / 3 + (1 + (eta + 1) / eps) * CadaTorrilhonPhiHatR_Eq13(jL[i], jR[i]))));
144c4762a1bSJed Brown   }
145c4762a1bSJed Brown }
1469371c9d4SSatish Balay static void Limit_CadaTorrilhon3R0p1(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
147c4762a1bSJed Brown   Limit_CadaTorrilhon3R(0.1, info, jL, jR, lmt);
148c4762a1bSJed Brown }
1499371c9d4SSatish Balay static void Limit_CadaTorrilhon3R1(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
150c4762a1bSJed Brown   Limit_CadaTorrilhon3R(1, info, jL, jR, lmt);
151c4762a1bSJed Brown }
1529371c9d4SSatish Balay static void Limit_CadaTorrilhon3R10(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
153c4762a1bSJed Brown   Limit_CadaTorrilhon3R(10, info, jL, jR, lmt);
154c4762a1bSJed Brown }
1559371c9d4SSatish Balay static void Limit_CadaTorrilhon3R100(LimitInfo info, const PetscScalar *jL, const PetscScalar *jR, PetscScalar *lmt) {
156c4762a1bSJed Brown   Limit_CadaTorrilhon3R(100, info, jL, jR, lmt);
157c4762a1bSJed Brown }
158c4762a1bSJed Brown 
159c4762a1bSJed Brown /* --------------------------------- Finite Volume data structures ----------------------------------- */
160c4762a1bSJed Brown 
1619371c9d4SSatish Balay typedef enum {
1629371c9d4SSatish Balay   FVBC_PERIODIC,
1639371c9d4SSatish Balay   FVBC_OUTFLOW
1649371c9d4SSatish Balay } FVBCType;
165c4762a1bSJed Brown static const char *FVBCTypes[] = {"PERIODIC", "OUTFLOW", "FVBCType", "FVBC_", 0};
166c4762a1bSJed Brown typedef PetscErrorCode (*RiemannFunction)(void *, PetscInt, const PetscScalar *, const PetscScalar *, PetscScalar *, PetscReal *);
167c4762a1bSJed Brown typedef PetscErrorCode (*ReconstructFunction)(void *, PetscInt, const PetscScalar *, PetscScalar *, PetscScalar *, PetscReal *);
168c4762a1bSJed Brown 
169c4762a1bSJed Brown typedef struct {
170c4762a1bSJed Brown   PetscErrorCode (*sample)(void *, PetscInt, FVBCType, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal *);
171c4762a1bSJed Brown   RiemannFunction     riemann;
172c4762a1bSJed Brown   ReconstructFunction characteristic;
173c4762a1bSJed Brown   PetscErrorCode (*destroy)(void *);
174c4762a1bSJed Brown   void    *user;
175c4762a1bSJed Brown   PetscInt dof;
176c4762a1bSJed Brown   char    *fieldname[16];
177c4762a1bSJed Brown } PhysicsCtx;
178c4762a1bSJed Brown 
179c4762a1bSJed Brown typedef struct {
180c4762a1bSJed Brown   void (*limit)(LimitInfo, const PetscScalar *, const PetscScalar *, PetscScalar *);
181c4762a1bSJed Brown   PhysicsCtx physics;
182c4762a1bSJed Brown   MPI_Comm   comm;
183c4762a1bSJed Brown   char       prefix[256];
184c4762a1bSJed Brown 
185c4762a1bSJed Brown   /* Local work arrays */
186c4762a1bSJed Brown   PetscScalar *R, *Rinv; /* Characteristic basis, and it's inverse.  COLUMN-MAJOR */
187c4762a1bSJed Brown   PetscScalar *cjmpLR;   /* Jumps at left and right edge of cell, in characteristic basis, len=2*dof */
188c4762a1bSJed Brown   PetscScalar *cslope;   /* Limited slope, written in characteristic basis */
189c4762a1bSJed Brown   PetscScalar *uLR;      /* Solution at left and right of interface, conservative variables, len=2*dof */
190c4762a1bSJed Brown   PetscScalar *flux;     /* Flux across interface */
191c4762a1bSJed Brown   PetscReal   *speeds;   /* Speeds of each wave */
192c4762a1bSJed Brown 
193c4762a1bSJed Brown   PetscReal cfl_idt; /* Max allowable value of 1/Delta t */
194c4762a1bSJed Brown   PetscReal cfl;
195c4762a1bSJed Brown   PetscReal xmin, xmax;
196c4762a1bSJed Brown   PetscInt  initial;
197c4762a1bSJed Brown   PetscBool exact;
198c4762a1bSJed Brown   FVBCType  bctype;
199c4762a1bSJed Brown } FVCtx;
200c4762a1bSJed Brown 
2019371c9d4SSatish Balay PetscErrorCode RiemannListAdd(PetscFunctionList *flist, const char *name, RiemannFunction rsolve) {
202c4762a1bSJed Brown   PetscFunctionBeginUser;
2039566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(flist, name, rsolve));
204c4762a1bSJed Brown   PetscFunctionReturn(0);
205c4762a1bSJed Brown }
206c4762a1bSJed Brown 
2079371c9d4SSatish Balay PetscErrorCode RiemannListFind(PetscFunctionList flist, const char *name, RiemannFunction *rsolve) {
208c4762a1bSJed Brown   PetscFunctionBeginUser;
2099566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(flist, name, rsolve));
2103c633725SBarry Smith   PetscCheck(*rsolve, PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "Riemann solver \"%s\" could not be found", name);
211c4762a1bSJed Brown   PetscFunctionReturn(0);
212c4762a1bSJed Brown }
213c4762a1bSJed Brown 
2149371c9d4SSatish Balay PetscErrorCode ReconstructListAdd(PetscFunctionList *flist, const char *name, ReconstructFunction r) {
215c4762a1bSJed Brown   PetscFunctionBeginUser;
2169566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(flist, name, r));
217c4762a1bSJed Brown   PetscFunctionReturn(0);
218c4762a1bSJed Brown }
219c4762a1bSJed Brown 
2209371c9d4SSatish Balay PetscErrorCode ReconstructListFind(PetscFunctionList flist, const char *name, ReconstructFunction *r) {
221c4762a1bSJed Brown   PetscFunctionBeginUser;
2229566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(flist, name, r));
2233c633725SBarry Smith   PetscCheck(*r, PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "Reconstruction \"%s\" could not be found", name);
224c4762a1bSJed Brown   PetscFunctionReturn(0);
225c4762a1bSJed Brown }
226c4762a1bSJed Brown 
227c4762a1bSJed Brown /* --------------------------------- Physics ----------------------------------- */
2280e3d61c9SBarry Smith /*
2290e3d61c9SBarry Smith   Each physical model consists of Riemann solver and a function to determine the basis to use for reconstruction.  These
2300e3d61c9SBarry Smith   are set with the PhysicsCreate_XXX function which allocates private storage and sets these methods as well as the
2310e3d61c9SBarry Smith   number of fields and their names, and a function to deallocate private storage.
2320e3d61c9SBarry Smith */
233c4762a1bSJed Brown 
234c4762a1bSJed Brown /* First a few functions useful to several different physics */
2359371c9d4SSatish Balay static PetscErrorCode PhysicsCharacteristic_Conservative(void *vctx, PetscInt m, const PetscScalar *u, PetscScalar *X, PetscScalar *Xi, PetscReal *speeds) {
236c4762a1bSJed Brown   PetscInt i, j;
237c4762a1bSJed Brown 
238c4762a1bSJed Brown   PetscFunctionBeginUser;
239c4762a1bSJed Brown   for (i = 0; i < m; i++) {
240c4762a1bSJed Brown     for (j = 0; j < m; j++) Xi[i * m + j] = X[i * m + j] = (PetscScalar)(i == j);
241c4762a1bSJed Brown     speeds[i] = PETSC_MAX_REAL; /* Indicates invalid */
242c4762a1bSJed Brown   }
243c4762a1bSJed Brown   PetscFunctionReturn(0);
244c4762a1bSJed Brown }
245c4762a1bSJed Brown 
2469371c9d4SSatish Balay static PetscErrorCode PhysicsDestroy_SimpleFree(void *vctx) {
247c4762a1bSJed Brown   PetscFunctionBeginUser;
2489566063dSJacob Faibussowitsch   PetscCall(PetscFree(vctx));
249c4762a1bSJed Brown   PetscFunctionReturn(0);
250c4762a1bSJed Brown }
251c4762a1bSJed Brown 
252c4762a1bSJed Brown /* --------------------------------- Advection ----------------------------------- */
253c4762a1bSJed Brown 
254c4762a1bSJed Brown typedef struct {
255c4762a1bSJed Brown   PetscReal a; /* advective velocity */
256c4762a1bSJed Brown } AdvectCtx;
257c4762a1bSJed Brown 
2589371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Advect(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
259c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx *)vctx;
260c4762a1bSJed Brown   PetscReal  speed;
261c4762a1bSJed Brown 
262c4762a1bSJed Brown   PetscFunctionBeginUser;
263c4762a1bSJed Brown   speed     = ctx->a;
264c4762a1bSJed Brown   flux[0]   = PetscMax(0, speed) * uL[0] + PetscMin(0, speed) * uR[0];
265c4762a1bSJed Brown   *maxspeed = speed;
266c4762a1bSJed Brown   PetscFunctionReturn(0);
267c4762a1bSJed Brown }
268c4762a1bSJed Brown 
2699371c9d4SSatish Balay static PetscErrorCode PhysicsCharacteristic_Advect(void *vctx, PetscInt m, const PetscScalar *u, PetscScalar *X, PetscScalar *Xi, PetscReal *speeds) {
270c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx *)vctx;
271c4762a1bSJed Brown 
272c4762a1bSJed Brown   PetscFunctionBeginUser;
273c4762a1bSJed Brown   X[0]      = 1.;
274c4762a1bSJed Brown   Xi[0]     = 1.;
275c4762a1bSJed Brown   speeds[0] = ctx->a;
276c4762a1bSJed Brown   PetscFunctionReturn(0);
277c4762a1bSJed Brown }
278c4762a1bSJed Brown 
2799371c9d4SSatish Balay static PetscErrorCode PhysicsSample_Advect(void *vctx, PetscInt initial, FVBCType bctype, PetscReal xmin, PetscReal xmax, PetscReal t, PetscReal x, PetscReal *u) {
280c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx *)vctx;
281c4762a1bSJed Brown   PetscReal  a   = ctx->a, x0;
282c4762a1bSJed Brown 
283c4762a1bSJed Brown   PetscFunctionBeginUser;
284c4762a1bSJed Brown   switch (bctype) {
285c4762a1bSJed Brown   case FVBC_OUTFLOW: x0 = x - a * t; break;
286c4762a1bSJed Brown   case FVBC_PERIODIC: x0 = RangeMod(x - a * t, xmin, xmax); break;
287c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown BCType");
288c4762a1bSJed Brown   }
289c4762a1bSJed Brown   switch (initial) {
290c4762a1bSJed Brown   case 0: u[0] = (x0 < 0) ? 1 : -1; break;
291c4762a1bSJed Brown   case 1: u[0] = (x0 < 0) ? -1 : 1; break;
292c4762a1bSJed Brown   case 2: u[0] = (0 < x0 && x0 < 1) ? 1 : 0; break;
293c4762a1bSJed Brown   case 3: u[0] = PetscSinReal(2 * PETSC_PI * x0); break;
294c4762a1bSJed Brown   case 4: u[0] = PetscAbs(x0); break;
295c4762a1bSJed Brown   case 5: u[0] = (x0 < 0 || x0 > 0.5) ? 0 : PetscSqr(PetscSinReal(2 * PETSC_PI * x0)); break;
296c4762a1bSJed Brown   case 6: u[0] = (x0 < 0) ? 0 : ((x0 < 1) ? x0 : ((x0 < 2) ? 2 - x0 : 0)); break;
297c4762a1bSJed Brown   case 7: u[0] = PetscPowReal(PetscSinReal(PETSC_PI * x0), 10.0); break;
298c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown initial condition");
299c4762a1bSJed Brown   }
300c4762a1bSJed Brown   PetscFunctionReturn(0);
301c4762a1bSJed Brown }
302c4762a1bSJed Brown 
3039371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_Advect(FVCtx *ctx) {
304c4762a1bSJed Brown   AdvectCtx *user;
305c4762a1bSJed Brown 
306c4762a1bSJed Brown   PetscFunctionBeginUser;
3079566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
308c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Advect;
309c4762a1bSJed Brown   ctx->physics.riemann        = PhysicsRiemann_Advect;
310c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Advect;
311c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
312c4762a1bSJed Brown   ctx->physics.user           = user;
313c4762a1bSJed Brown   ctx->physics.dof            = 1;
3149566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("u", &ctx->physics.fieldname[0]));
315c4762a1bSJed Brown   user->a = 1;
316d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for advection", "");
3179371c9d4SSatish Balay   { PetscCall(PetscOptionsReal("-physics_advect_a", "Speed", "", user->a, &user->a, NULL)); }
318d0609cedSBarry Smith   PetscOptionsEnd();
319c4762a1bSJed Brown   PetscFunctionReturn(0);
320c4762a1bSJed Brown }
321c4762a1bSJed Brown 
322c4762a1bSJed Brown /* --------------------------------- Burgers ----------------------------------- */
323c4762a1bSJed Brown 
324c4762a1bSJed Brown typedef struct {
325c4762a1bSJed Brown   PetscReal lxf_speed;
326c4762a1bSJed Brown } BurgersCtx;
327c4762a1bSJed Brown 
3289371c9d4SSatish Balay static PetscErrorCode PhysicsSample_Burgers(void *vctx, PetscInt initial, FVBCType bctype, PetscReal xmin, PetscReal xmax, PetscReal t, PetscReal x, PetscReal *u) {
329c4762a1bSJed Brown   PetscFunctionBeginUser;
3303c633725SBarry Smith   PetscCheck(bctype != FVBC_PERIODIC || t <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Exact solution not implemented for periodic");
331c4762a1bSJed Brown   switch (initial) {
332c4762a1bSJed Brown   case 0: u[0] = (x < 0) ? 1 : -1; break;
333c4762a1bSJed Brown   case 1:
334c4762a1bSJed Brown     if (x < -t) u[0] = -1;
335c4762a1bSJed Brown     else if (x < t) u[0] = x / t;
336c4762a1bSJed Brown     else u[0] = 1;
337c4762a1bSJed Brown     break;
338c4762a1bSJed Brown   case 2:
3390912c85aSBarry Smith     if (x <= 0) u[0] = 0;
3400912c85aSBarry Smith     else if (x < t) u[0] = x / t;
341c4762a1bSJed Brown     else if (x < 1 + 0.5 * t) u[0] = 1;
342c4762a1bSJed Brown     else u[0] = 0;
343c4762a1bSJed Brown     break;
344c4762a1bSJed Brown   case 3:
345c4762a1bSJed Brown     if (x < 0.2 * t) u[0] = 0.2;
346c4762a1bSJed Brown     else if (x < t) u[0] = x / t;
347c4762a1bSJed Brown     else u[0] = 1;
348c4762a1bSJed Brown     break;
349c4762a1bSJed Brown   case 4:
3503c633725SBarry Smith     PetscCheck(t <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Only initial condition available");
351c4762a1bSJed Brown     u[0] = 0.7 + 0.3 * PetscSinReal(2 * PETSC_PI * ((x - xmin) / (xmax - xmin)));
352c4762a1bSJed Brown     break;
353c4762a1bSJed Brown   case 5: /* Pure shock solution */
354c4762a1bSJed Brown     if (x < 0.5 * t) u[0] = 1;
355c4762a1bSJed Brown     else u[0] = 0;
356c4762a1bSJed Brown     break;
357c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown initial condition");
358c4762a1bSJed Brown   }
359c4762a1bSJed Brown   PetscFunctionReturn(0);
360c4762a1bSJed Brown }
361c4762a1bSJed Brown 
3629371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Burgers_Exact(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
363c4762a1bSJed Brown   PetscFunctionBeginUser;
364c4762a1bSJed Brown   if (uL[0] < uR[0]) {                /* rarefaction */
3659371c9d4SSatish Balay     flux[0] = (uL[0] * uR[0] < 0) ? 0 /* sonic rarefaction */
366c4762a1bSJed Brown                                   : 0.5 * PetscMin(PetscSqr(uL[0]), PetscSqr(uR[0]));
367c4762a1bSJed Brown   } else { /* shock */
368c4762a1bSJed Brown     flux[0] = 0.5 * PetscMax(PetscSqr(uL[0]), PetscSqr(uR[0]));
369c4762a1bSJed Brown   }
370c4762a1bSJed Brown   *maxspeed = (PetscAbs(uL[0]) > PetscAbs(uR[0])) ? uL[0] : uR[0];
371c4762a1bSJed Brown   PetscFunctionReturn(0);
372c4762a1bSJed Brown }
373c4762a1bSJed Brown 
3749371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Burgers_Roe(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
375c4762a1bSJed Brown   PetscReal speed;
376c4762a1bSJed Brown 
377c4762a1bSJed Brown   PetscFunctionBeginUser;
378c4762a1bSJed Brown   speed   = 0.5 * (uL[0] + uR[0]);
379c4762a1bSJed Brown   flux[0] = 0.25 * (PetscSqr(uL[0]) + PetscSqr(uR[0])) - 0.5 * PetscAbs(speed) * (uR[0] - uL[0]);
380c4762a1bSJed Brown   if (uL[0] <= 0 && 0 <= uR[0]) flux[0] = 0; /* Entropy fix for sonic rarefaction */
381c4762a1bSJed Brown   *maxspeed = speed;
382c4762a1bSJed Brown   PetscFunctionReturn(0);
383c4762a1bSJed Brown }
384c4762a1bSJed Brown 
3859371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Burgers_LxF(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
386c4762a1bSJed Brown   PetscReal   c;
387c4762a1bSJed Brown   PetscScalar fL, fR;
388c4762a1bSJed Brown 
389c4762a1bSJed Brown   PetscFunctionBeginUser;
390c4762a1bSJed Brown   c         = ((BurgersCtx *)vctx)->lxf_speed;
391c4762a1bSJed Brown   fL        = 0.5 * PetscSqr(uL[0]);
392c4762a1bSJed Brown   fR        = 0.5 * PetscSqr(uR[0]);
393c4762a1bSJed Brown   flux[0]   = 0.5 * (fL + fR) - 0.5 * c * (uR[0] - uL[0]);
394c4762a1bSJed Brown   *maxspeed = c;
395c4762a1bSJed Brown   PetscFunctionReturn(0);
396c4762a1bSJed Brown }
397c4762a1bSJed Brown 
3989371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Burgers_Rusanov(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
399c4762a1bSJed Brown   PetscReal   c;
400c4762a1bSJed Brown   PetscScalar fL, fR;
401c4762a1bSJed Brown 
402c4762a1bSJed Brown   PetscFunctionBeginUser;
403c4762a1bSJed Brown   c         = PetscMax(PetscAbs(uL[0]), PetscAbs(uR[0]));
404c4762a1bSJed Brown   fL        = 0.5 * PetscSqr(uL[0]);
405c4762a1bSJed Brown   fR        = 0.5 * PetscSqr(uR[0]);
406c4762a1bSJed Brown   flux[0]   = 0.5 * (fL + fR) - 0.5 * c * (uR[0] - uL[0]);
407c4762a1bSJed Brown   *maxspeed = c;
408c4762a1bSJed Brown   PetscFunctionReturn(0);
409c4762a1bSJed Brown }
410c4762a1bSJed Brown 
4119371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_Burgers(FVCtx *ctx) {
412c4762a1bSJed Brown   BurgersCtx       *user;
413c4762a1bSJed Brown   RiemannFunction   r;
414c4762a1bSJed Brown   PetscFunctionList rlist      = 0;
415c4762a1bSJed Brown   char              rname[256] = "exact";
416c4762a1bSJed Brown 
417c4762a1bSJed Brown   PetscFunctionBeginUser;
4189566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
419c4762a1bSJed Brown 
420c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Burgers;
421c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Conservative;
422c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
423c4762a1bSJed Brown   ctx->physics.user           = user;
424c4762a1bSJed Brown   ctx->physics.dof            = 1;
425c4762a1bSJed Brown 
4269566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("u", &ctx->physics.fieldname[0]));
4279566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "exact", PhysicsRiemann_Burgers_Exact));
4289566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "roe", PhysicsRiemann_Burgers_Roe));
4299566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "lxf", PhysicsRiemann_Burgers_LxF));
4309566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "rusanov", PhysicsRiemann_Burgers_Rusanov));
431d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for advection", "");
4329371c9d4SSatish Balay   { PetscCall(PetscOptionsFList("-physics_burgers_riemann", "Riemann solver", "", rlist, rname, rname, sizeof(rname), NULL)); }
433d0609cedSBarry Smith   PetscOptionsEnd();
4349566063dSJacob Faibussowitsch   PetscCall(RiemannListFind(rlist, rname, &r));
4359566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rlist));
436c4762a1bSJed Brown   ctx->physics.riemann = r;
437c4762a1bSJed Brown 
438c4762a1bSJed Brown   /* *
439c4762a1bSJed Brown   * Hack to deal with LxF in semi-discrete form
440c4762a1bSJed Brown   * max speed is 1 for the basic initial conditions (where |u| <= 1)
441c4762a1bSJed Brown   * */
442c4762a1bSJed Brown   if (r == PhysicsRiemann_Burgers_LxF) user->lxf_speed = 1;
443c4762a1bSJed Brown   PetscFunctionReturn(0);
444c4762a1bSJed Brown }
445c4762a1bSJed Brown 
446c4762a1bSJed Brown /* --------------------------------- Traffic ----------------------------------- */
447c4762a1bSJed Brown 
448c4762a1bSJed Brown typedef struct {
449c4762a1bSJed Brown   PetscReal lxf_speed;
450c4762a1bSJed Brown   PetscReal a;
451c4762a1bSJed Brown } TrafficCtx;
452c4762a1bSJed Brown 
4539371c9d4SSatish Balay static inline PetscScalar TrafficFlux(PetscScalar a, PetscScalar u) {
4549371c9d4SSatish Balay   return a * u * (1 - u);
4559371c9d4SSatish Balay }
456c4762a1bSJed Brown 
4579371c9d4SSatish Balay static PetscErrorCode PhysicsSample_Traffic(void *vctx, PetscInt initial, FVBCType bctype, PetscReal xmin, PetscReal xmax, PetscReal t, PetscReal x, PetscReal *u) {
458c4762a1bSJed Brown   PetscReal a = ((TrafficCtx *)vctx)->a;
459c4762a1bSJed Brown 
460c4762a1bSJed Brown   PetscFunctionBeginUser;
4613c633725SBarry Smith   PetscCheck(bctype != FVBC_PERIODIC || t <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Exact solution not implemented for periodic");
462c4762a1bSJed Brown   switch (initial) {
4639371c9d4SSatish Balay   case 0: u[0] = (-a * t < x) ? 2 : 0; break;
464c4762a1bSJed Brown   case 1:
465c4762a1bSJed Brown     if (x < PetscMin(2 * a * t, 0.5 + a * t)) u[0] = -1;
466c4762a1bSJed Brown     else if (x < 1) u[0] = 0;
467c4762a1bSJed Brown     else u[0] = 1;
468c4762a1bSJed Brown     break;
469c4762a1bSJed Brown   case 2:
4703c633725SBarry Smith     PetscCheck(t <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Only initial condition available");
471c4762a1bSJed Brown     u[0] = 0.7 + 0.3 * PetscSinReal(2 * PETSC_PI * ((x - xmin) / (xmax - xmin)));
472c4762a1bSJed Brown     break;
473c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown initial condition");
474c4762a1bSJed Brown   }
475c4762a1bSJed Brown   PetscFunctionReturn(0);
476c4762a1bSJed Brown }
477c4762a1bSJed Brown 
4789371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Traffic_Exact(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
479c4762a1bSJed Brown   PetscReal a = ((TrafficCtx *)vctx)->a;
480c4762a1bSJed Brown 
481c4762a1bSJed Brown   PetscFunctionBeginUser;
482c4762a1bSJed Brown   if (uL[0] < uR[0]) {
483c4762a1bSJed Brown     flux[0] = PetscMin(TrafficFlux(a, uL[0]), TrafficFlux(a, uR[0]));
484c4762a1bSJed Brown   } else {
485c4762a1bSJed Brown     flux[0] = (uR[0] < 0.5 && 0.5 < uL[0]) ? TrafficFlux(a, 0.5) : PetscMax(TrafficFlux(a, uL[0]), TrafficFlux(a, uR[0]));
486c4762a1bSJed Brown   }
487c4762a1bSJed Brown   *maxspeed = a * MaxAbs(1 - 2 * uL[0], 1 - 2 * uR[0]);
488c4762a1bSJed Brown   PetscFunctionReturn(0);
489c4762a1bSJed Brown }
490c4762a1bSJed Brown 
4919371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Traffic_Roe(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
492c4762a1bSJed Brown   PetscReal a = ((TrafficCtx *)vctx)->a;
493c4762a1bSJed Brown   PetscReal speed;
494c4762a1bSJed Brown 
495c4762a1bSJed Brown   PetscFunctionBeginUser;
496c4762a1bSJed Brown   speed     = a * (1 - (uL[0] + uR[0]));
497c4762a1bSJed Brown   flux[0]   = 0.5 * (TrafficFlux(a, uL[0]) + TrafficFlux(a, uR[0])) - 0.5 * PetscAbs(speed) * (uR[0] - uL[0]);
498c4762a1bSJed Brown   *maxspeed = speed;
499c4762a1bSJed Brown   PetscFunctionReturn(0);
500c4762a1bSJed Brown }
501c4762a1bSJed Brown 
5029371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Traffic_LxF(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
503c4762a1bSJed Brown   TrafficCtx *phys = (TrafficCtx *)vctx;
504c4762a1bSJed Brown   PetscReal   a    = phys->a;
505c4762a1bSJed Brown   PetscReal   speed;
506c4762a1bSJed Brown 
507c4762a1bSJed Brown   PetscFunctionBeginUser;
508c4762a1bSJed Brown   speed     = a * (1 - (uL[0] + uR[0]));
509c4762a1bSJed Brown   flux[0]   = 0.5 * (TrafficFlux(a, uL[0]) + TrafficFlux(a, uR[0])) - 0.5 * phys->lxf_speed * (uR[0] - uL[0]);
510c4762a1bSJed Brown   *maxspeed = speed;
511c4762a1bSJed Brown   PetscFunctionReturn(0);
512c4762a1bSJed Brown }
513c4762a1bSJed Brown 
5149371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Traffic_Rusanov(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
515c4762a1bSJed Brown   PetscReal a = ((TrafficCtx *)vctx)->a;
516c4762a1bSJed Brown   PetscReal speed;
517c4762a1bSJed Brown 
518c4762a1bSJed Brown   PetscFunctionBeginUser;
519c4762a1bSJed Brown   speed     = a * PetscMax(PetscAbs(1 - 2 * uL[0]), PetscAbs(1 - 2 * uR[0]));
520c4762a1bSJed Brown   flux[0]   = 0.5 * (TrafficFlux(a, uL[0]) + TrafficFlux(a, uR[0])) - 0.5 * speed * (uR[0] - uL[0]);
521c4762a1bSJed Brown   *maxspeed = speed;
522c4762a1bSJed Brown   PetscFunctionReturn(0);
523c4762a1bSJed Brown }
524c4762a1bSJed Brown 
5259371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_Traffic(FVCtx *ctx) {
526c4762a1bSJed Brown   TrafficCtx       *user;
527c4762a1bSJed Brown   RiemannFunction   r;
528c4762a1bSJed Brown   PetscFunctionList rlist      = 0;
529c4762a1bSJed Brown   char              rname[256] = "exact";
530c4762a1bSJed Brown 
531c4762a1bSJed Brown   PetscFunctionBeginUser;
5329566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
533c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Traffic;
534c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Conservative;
535c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
536c4762a1bSJed Brown   ctx->physics.user           = user;
537c4762a1bSJed Brown   ctx->physics.dof            = 1;
538c4762a1bSJed Brown 
5399566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("density", &ctx->physics.fieldname[0]));
540c4762a1bSJed Brown   user->a = 0.5;
5419566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "exact", PhysicsRiemann_Traffic_Exact));
5429566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "roe", PhysicsRiemann_Traffic_Roe));
5439566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "lxf", PhysicsRiemann_Traffic_LxF));
5449566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "rusanov", PhysicsRiemann_Traffic_Rusanov));
545d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for Traffic", "");
5469566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-physics_traffic_a", "Flux = a*u*(1-u)", "", user->a, &user->a, NULL));
5479566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics_traffic_riemann", "Riemann solver", "", rlist, rname, rname, sizeof(rname), NULL));
548d0609cedSBarry Smith   PetscOptionsEnd();
549c4762a1bSJed Brown 
5509566063dSJacob Faibussowitsch   PetscCall(RiemannListFind(rlist, rname, &r));
5519566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rlist));
552c4762a1bSJed Brown 
553c4762a1bSJed Brown   ctx->physics.riemann = r;
554c4762a1bSJed Brown 
555c4762a1bSJed Brown   /* *
556c4762a1bSJed Brown   * Hack to deal with LxF in semi-discrete form
557c4762a1bSJed Brown   * max speed is 3*a for the basic initial conditions (-1 <= u <= 2)
558c4762a1bSJed Brown   * */
559c4762a1bSJed Brown   if (r == PhysicsRiemann_Traffic_LxF) user->lxf_speed = 3 * user->a;
560c4762a1bSJed Brown   PetscFunctionReturn(0);
561c4762a1bSJed Brown }
562c4762a1bSJed Brown 
563c4762a1bSJed Brown /* --------------------------------- Linear Acoustics ----------------------------------- */
564c4762a1bSJed Brown 
565c4762a1bSJed Brown /* Flux: u_t + (A u)_x
566c4762a1bSJed Brown  * z = sqrt(rho*bulk), c = sqrt(rho/bulk)
567c4762a1bSJed Brown  * Spectral decomposition: A = R * D * Rinv
568c4762a1bSJed Brown  * [    cz] = [-z   z] [-c    ] [-1/2z  1/2]
569c4762a1bSJed Brown  * [c/z   ] = [ 1   1] [     c] [ 1/2z  1/2]
570c4762a1bSJed Brown  *
571c4762a1bSJed Brown  * We decompose this into the left-traveling waves Al = R * D^- Rinv
572c4762a1bSJed Brown  * and the right-traveling waves Ar = R * D^+ * Rinv
573c4762a1bSJed Brown  * Multiplying out these expressions produces the following two matrices
574c4762a1bSJed Brown  */
575c4762a1bSJed Brown 
576c4762a1bSJed Brown typedef struct {
577c4762a1bSJed Brown   PetscReal c; /* speed of sound: c = sqrt(bulk/rho) */
578c4762a1bSJed Brown   PetscReal z; /* impedence: z = sqrt(rho*bulk) */
579c4762a1bSJed Brown } AcousticsCtx;
580c4762a1bSJed Brown 
5819371c9d4SSatish Balay PETSC_UNUSED static inline void AcousticsFlux(AcousticsCtx *ctx, const PetscScalar *u, PetscScalar *f) {
582c4762a1bSJed Brown   f[0] = ctx->c * ctx->z * u[1];
583c4762a1bSJed Brown   f[1] = ctx->c / ctx->z * u[0];
584c4762a1bSJed Brown }
585c4762a1bSJed Brown 
5869371c9d4SSatish Balay static PetscErrorCode PhysicsCharacteristic_Acoustics(void *vctx, PetscInt m, const PetscScalar *u, PetscScalar *X, PetscScalar *Xi, PetscReal *speeds) {
587c4762a1bSJed Brown   AcousticsCtx *phys = (AcousticsCtx *)vctx;
588c4762a1bSJed Brown   PetscReal     z = phys->z, c = phys->c;
589c4762a1bSJed Brown 
590c4762a1bSJed Brown   PetscFunctionBeginUser;
591c4762a1bSJed Brown   X[0 * 2 + 0]  = -z;
592c4762a1bSJed Brown   X[0 * 2 + 1]  = z;
593c4762a1bSJed Brown   X[1 * 2 + 0]  = 1;
594c4762a1bSJed Brown   X[1 * 2 + 1]  = 1;
595c4762a1bSJed Brown   Xi[0 * 2 + 0] = -1. / (2 * z);
596c4762a1bSJed Brown   Xi[0 * 2 + 1] = 1. / 2;
597c4762a1bSJed Brown   Xi[1 * 2 + 0] = 1. / (2 * z);
598c4762a1bSJed Brown   Xi[1 * 2 + 1] = 1. / 2;
599c4762a1bSJed Brown   speeds[0]     = -c;
600c4762a1bSJed Brown   speeds[1]     = c;
601c4762a1bSJed Brown   PetscFunctionReturn(0);
602c4762a1bSJed Brown }
603c4762a1bSJed Brown 
6049371c9d4SSatish Balay static PetscErrorCode PhysicsSample_Acoustics_Initial(AcousticsCtx *phys, PetscInt initial, PetscReal xmin, PetscReal xmax, PetscReal x, PetscReal *u) {
605c4762a1bSJed Brown   PetscFunctionBeginUser;
606c4762a1bSJed Brown   switch (initial) {
607c4762a1bSJed Brown   case 0:
608c4762a1bSJed Brown     u[0] = (PetscAbs((x - xmin) / (xmax - xmin) - 0.2) < 0.1) ? 1 : 0.5;
609c4762a1bSJed Brown     u[1] = (PetscAbs((x - xmin) / (xmax - xmin) - 0.7) < 0.1) ? 1 : -0.5;
610c4762a1bSJed Brown     break;
611c4762a1bSJed Brown   case 1:
612c4762a1bSJed Brown     u[0] = PetscCosReal(3 * 2 * PETSC_PI * x / (xmax - xmin));
613c4762a1bSJed Brown     u[1] = PetscExpReal(-PetscSqr(x - (xmax + xmin) / 2) / (2 * PetscSqr(0.2 * (xmax - xmin)))) - 0.5;
614c4762a1bSJed Brown     break;
615c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown initial condition");
616c4762a1bSJed Brown   }
617c4762a1bSJed Brown   PetscFunctionReturn(0);
618c4762a1bSJed Brown }
619c4762a1bSJed Brown 
6209371c9d4SSatish Balay static PetscErrorCode PhysicsSample_Acoustics(void *vctx, PetscInt initial, FVBCType bctype, PetscReal xmin, PetscReal xmax, PetscReal t, PetscReal x, PetscReal *u) {
621c4762a1bSJed Brown   AcousticsCtx *phys = (AcousticsCtx *)vctx;
622c4762a1bSJed Brown   PetscReal     c    = phys->c;
623c4762a1bSJed Brown   PetscReal     x0a, x0b, u0a[2], u0b[2], tmp[2];
624c4762a1bSJed Brown   PetscReal     X[2][2], Xi[2][2], dummy[2];
625c4762a1bSJed Brown 
626c4762a1bSJed Brown   PetscFunctionBeginUser;
627c4762a1bSJed Brown   switch (bctype) {
628c4762a1bSJed Brown   case FVBC_OUTFLOW:
629c4762a1bSJed Brown     x0a = x + c * t;
630c4762a1bSJed Brown     x0b = x - c * t;
631c4762a1bSJed Brown     break;
632c4762a1bSJed Brown   case FVBC_PERIODIC:
633c4762a1bSJed Brown     x0a = RangeMod(x + c * t, xmin, xmax);
634c4762a1bSJed Brown     x0b = RangeMod(x - c * t, xmin, xmax);
635c4762a1bSJed Brown     break;
636c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown BCType");
637c4762a1bSJed Brown   }
6389566063dSJacob Faibussowitsch   PetscCall(PhysicsSample_Acoustics_Initial(phys, initial, xmin, xmax, x0a, u0a));
6399566063dSJacob Faibussowitsch   PetscCall(PhysicsSample_Acoustics_Initial(phys, initial, xmin, xmax, x0b, u0b));
6409566063dSJacob Faibussowitsch   PetscCall(PhysicsCharacteristic_Acoustics(vctx, 2, u, &X[0][0], &Xi[0][0], dummy));
641c4762a1bSJed Brown   tmp[0] = Xi[0][0] * u0a[0] + Xi[0][1] * u0a[1];
642c4762a1bSJed Brown   tmp[1] = Xi[1][0] * u0b[0] + Xi[1][1] * u0b[1];
643c4762a1bSJed Brown   u[0]   = X[0][0] * tmp[0] + X[0][1] * tmp[1];
644c4762a1bSJed Brown   u[1]   = X[1][0] * tmp[0] + X[1][1] * tmp[1];
645c4762a1bSJed Brown   PetscFunctionReturn(0);
646c4762a1bSJed Brown }
647c4762a1bSJed Brown 
6489371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Acoustics_Exact(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
649c4762a1bSJed Brown   AcousticsCtx *phys = (AcousticsCtx *)vctx;
650c4762a1bSJed Brown   PetscReal     c = phys->c, z = phys->z;
6519371c9d4SSatish Balay   PetscReal     Al[2][2] =
6529371c9d4SSatish Balay     {
6539371c9d4SSatish Balay       {-c / 2,      c * z / 2},
6549371c9d4SSatish Balay       {c / (2 * z), -c / 2   }
6559371c9d4SSatish Balay   },         /* Left traveling waves */
6569371c9d4SSatish Balay     Ar[2][2] = {{c / 2, c * z / 2}, {c / (2 * z), c / 2}}; /* Right traveling waves */
657c4762a1bSJed Brown 
658c4762a1bSJed Brown   PetscFunctionBeginUser;
659c4762a1bSJed Brown   flux[0]   = Al[0][0] * uR[0] + Al[0][1] * uR[1] + Ar[0][0] * uL[0] + Ar[0][1] * uL[1];
660c4762a1bSJed Brown   flux[1]   = Al[1][0] * uR[0] + Al[1][1] * uR[1] + Ar[1][0] * uL[0] + Ar[1][1] * uL[1];
661c4762a1bSJed Brown   *maxspeed = c;
662c4762a1bSJed Brown   PetscFunctionReturn(0);
663c4762a1bSJed Brown }
664c4762a1bSJed Brown 
6659371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_Acoustics(FVCtx *ctx) {
666c4762a1bSJed Brown   AcousticsCtx     *user;
667c4762a1bSJed Brown   PetscFunctionList rlist = 0, rclist = 0;
668c4762a1bSJed Brown   char              rname[256] = "exact", rcname[256] = "characteristic";
669c4762a1bSJed Brown 
670c4762a1bSJed Brown   PetscFunctionBeginUser;
6719566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
672c4762a1bSJed Brown   ctx->physics.sample  = PhysicsSample_Acoustics;
673c4762a1bSJed Brown   ctx->physics.destroy = PhysicsDestroy_SimpleFree;
674c4762a1bSJed Brown   ctx->physics.user    = user;
675c4762a1bSJed Brown   ctx->physics.dof     = 2;
676c4762a1bSJed Brown 
6779566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("u", &ctx->physics.fieldname[0]));
6789566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("v", &ctx->physics.fieldname[1]));
679c4762a1bSJed Brown 
680c4762a1bSJed Brown   user->c = 1;
681c4762a1bSJed Brown   user->z = 1;
682c4762a1bSJed Brown 
6839566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "exact", PhysicsRiemann_Acoustics_Exact));
6849566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "characteristic", PhysicsCharacteristic_Acoustics));
6859566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "conservative", PhysicsCharacteristic_Conservative));
686d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for linear Acoustics", "");
687c4762a1bSJed Brown   {
6889566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-physics_acoustics_c", "c = sqrt(bulk/rho)", "", user->c, &user->c, NULL));
6899566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-physics_acoustics_z", "z = sqrt(bulk*rho)", "", user->z, &user->z, NULL));
6909566063dSJacob Faibussowitsch     PetscCall(PetscOptionsFList("-physics_acoustics_riemann", "Riemann solver", "", rlist, rname, rname, sizeof(rname), NULL));
6919566063dSJacob Faibussowitsch     PetscCall(PetscOptionsFList("-physics_acoustics_reconstruct", "Reconstruction", "", rclist, rcname, rcname, sizeof(rcname), NULL));
692c4762a1bSJed Brown   }
693d0609cedSBarry Smith   PetscOptionsEnd();
6949566063dSJacob Faibussowitsch   PetscCall(RiemannListFind(rlist, rname, &ctx->physics.riemann));
6959566063dSJacob Faibussowitsch   PetscCall(ReconstructListFind(rclist, rcname, &ctx->physics.characteristic));
6969566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rlist));
6979566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rclist));
698c4762a1bSJed Brown   PetscFunctionReturn(0);
699c4762a1bSJed Brown }
700c4762a1bSJed Brown 
701c4762a1bSJed Brown /* --------------------------------- Isothermal Gas Dynamics ----------------------------------- */
702c4762a1bSJed Brown 
703c4762a1bSJed Brown typedef struct {
704c4762a1bSJed Brown   PetscReal acoustic_speed;
705c4762a1bSJed Brown } IsoGasCtx;
706c4762a1bSJed Brown 
7079371c9d4SSatish Balay static inline void IsoGasFlux(PetscReal c, const PetscScalar *u, PetscScalar *f) {
708c4762a1bSJed Brown   f[0] = u[1];
709c4762a1bSJed Brown   f[1] = PetscSqr(u[1]) / u[0] + c * c * u[0];
710c4762a1bSJed Brown }
711c4762a1bSJed Brown 
7129371c9d4SSatish Balay static PetscErrorCode PhysicsSample_IsoGas(void *vctx, PetscInt initial, FVBCType bctype, PetscReal xmin, PetscReal xmax, PetscReal t, PetscReal x, PetscReal *u) {
713c4762a1bSJed Brown   PetscFunctionBeginUser;
7143c633725SBarry Smith   PetscCheck(t <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Exact solutions not implemented for t > 0");
715c4762a1bSJed Brown   switch (initial) {
716c4762a1bSJed Brown   case 0:
717c4762a1bSJed Brown     u[0] = (x < 0) ? 1 : 0.5;
718c4762a1bSJed Brown     u[1] = (x < 0) ? 1 : 0.7;
719c4762a1bSJed Brown     break;
720c4762a1bSJed Brown   case 1:
721c4762a1bSJed Brown     u[0] = 1 + 0.5 * PetscSinReal(2 * PETSC_PI * x);
722c4762a1bSJed Brown     u[1] = 1 * u[0];
723c4762a1bSJed Brown     break;
724c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "unknown initial condition");
725c4762a1bSJed Brown   }
726c4762a1bSJed Brown   PetscFunctionReturn(0);
727c4762a1bSJed Brown }
728c4762a1bSJed Brown 
7299371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_IsoGas_Roe(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
730c4762a1bSJed Brown   IsoGasCtx  *phys = (IsoGasCtx *)vctx;
731c4762a1bSJed Brown   PetscReal   c    = phys->acoustic_speed;
732c4762a1bSJed Brown   PetscScalar ubar, du[2], a[2], fL[2], fR[2], lam[2], ustar[2], R[2][2];
733c4762a1bSJed Brown   PetscInt    i;
734c4762a1bSJed Brown 
735c4762a1bSJed Brown   PetscFunctionBeginUser;
736c4762a1bSJed Brown   ubar    = (uL[1] / PetscSqrtScalar(uL[0]) + uR[1] / PetscSqrtScalar(uR[0])) / (PetscSqrtScalar(uL[0]) + PetscSqrtScalar(uR[0]));
737c4762a1bSJed Brown   /* write fluxuations in characteristic basis */
738c4762a1bSJed Brown   du[0]   = uR[0] - uL[0];
739c4762a1bSJed Brown   du[1]   = uR[1] - uL[1];
740c4762a1bSJed Brown   a[0]    = (1 / (2 * c)) * ((ubar + c) * du[0] - du[1]);
741c4762a1bSJed Brown   a[1]    = (1 / (2 * c)) * ((-ubar + c) * du[0] + du[1]);
742c4762a1bSJed Brown   /* wave speeds */
743c4762a1bSJed Brown   lam[0]  = ubar - c;
744c4762a1bSJed Brown   lam[1]  = ubar + c;
745c4762a1bSJed Brown   /* Right eigenvectors */
7469371c9d4SSatish Balay   R[0][0] = 1;
7479371c9d4SSatish Balay   R[0][1] = ubar - c;
7489371c9d4SSatish Balay   R[1][0] = 1;
7499371c9d4SSatish Balay   R[1][1] = ubar + c;
750c4762a1bSJed Brown   /* Compute state in star region (between the 1-wave and 2-wave) */
751c4762a1bSJed Brown   for (i = 0; i < 2; i++) ustar[i] = uL[i] + a[0] * R[0][i];
752c4762a1bSJed Brown   if (uL[1] / uL[0] < c && c < ustar[1] / ustar[0]) { /* 1-wave is sonic rarefaction */
753c4762a1bSJed Brown     PetscScalar ufan[2];
754c4762a1bSJed Brown     ufan[0] = uL[0] * PetscExpScalar(uL[1] / (uL[0] * c) - 1);
755c4762a1bSJed Brown     ufan[1] = c * ufan[0];
756c4762a1bSJed Brown     IsoGasFlux(c, ufan, flux);
757c4762a1bSJed Brown   } else if (ustar[1] / ustar[0] < -c && -c < uR[1] / uR[0]) { /* 2-wave is sonic rarefaction */
758c4762a1bSJed Brown     PetscScalar ufan[2];
759c4762a1bSJed Brown     ufan[0] = uR[0] * PetscExpScalar(-uR[1] / (uR[0] * c) - 1);
760c4762a1bSJed Brown     ufan[1] = -c * ufan[0];
761c4762a1bSJed Brown     IsoGasFlux(c, ufan, flux);
762c4762a1bSJed Brown   } else { /* Centered form */
763c4762a1bSJed Brown     IsoGasFlux(c, uL, fL);
764c4762a1bSJed Brown     IsoGasFlux(c, uR, fR);
765c4762a1bSJed Brown     for (i = 0; i < 2; i++) {
766c4762a1bSJed Brown       PetscScalar absdu = PetscAbsScalar(lam[0]) * a[0] * R[0][i] + PetscAbsScalar(lam[1]) * a[1] * R[1][i];
767c4762a1bSJed Brown       flux[i]           = 0.5 * (fL[i] + fR[i]) - 0.5 * absdu;
768c4762a1bSJed Brown     }
769c4762a1bSJed Brown   }
770c4762a1bSJed Brown   *maxspeed = MaxAbs(lam[0], lam[1]);
771c4762a1bSJed Brown   PetscFunctionReturn(0);
772c4762a1bSJed Brown }
773c4762a1bSJed Brown 
7749371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_IsoGas_Exact(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
775c4762a1bSJed Brown   IsoGasCtx  *phys = (IsoGasCtx *)vctx;
776c4762a1bSJed Brown   PetscReal   c    = phys->acoustic_speed;
777c4762a1bSJed Brown   PetscScalar ustar[2];
7789371c9d4SSatish Balay   struct {
7799371c9d4SSatish Balay     PetscScalar rho, u;
7809371c9d4SSatish Balay   } L = {uL[0], uL[1] / uL[0]}, R = {uR[0], uR[1] / uR[0]}, star;
781c4762a1bSJed Brown   PetscInt i;
782c4762a1bSJed Brown 
783c4762a1bSJed Brown   PetscFunctionBeginUser;
7843c633725SBarry Smith   PetscCheck((L.rho > 0 && R.rho > 0), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Reconstructed density is negative");
785c4762a1bSJed Brown   {
786c4762a1bSJed Brown     /* Solve for star state */
787c4762a1bSJed Brown     PetscScalar res, tmp, rho = 0.5 * (L.rho + R.rho); /* initial guess */
788c4762a1bSJed Brown     for (i = 0; i < 20; i++) {
789c4762a1bSJed Brown       PetscScalar fr, fl, dfr, dfl;
7909371c9d4SSatish Balay       fl  = (L.rho < rho) ? (rho - L.rho) / PetscSqrtScalar(L.rho * rho) /* shock */
791c4762a1bSJed Brown                           : PetscLogScalar(rho) - PetscLogScalar(L.rho); /* rarefaction */
7929371c9d4SSatish Balay       fr  = (R.rho < rho) ? (rho - R.rho) / PetscSqrtScalar(R.rho * rho) /* shock */
793c4762a1bSJed Brown                           : PetscLogScalar(rho) - PetscLogScalar(R.rho); /* rarefaction */
794c4762a1bSJed Brown       res = R.u - L.u + c * (fr + fl);
7953c633725SBarry Smith       PetscCheck(!PetscIsInfOrNanScalar(res), PETSC_COMM_SELF, PETSC_ERR_FP, "Infinity or Not-a-Number generated in computation");
796c4762a1bSJed Brown       if (PetscAbsScalar(res) < 1e-10) {
797c4762a1bSJed Brown         star.rho = rho;
798c4762a1bSJed Brown         star.u   = L.u - c * fl;
799c4762a1bSJed Brown         goto converged;
800c4762a1bSJed Brown       }
801c4762a1bSJed Brown       dfl = (L.rho < rho) ? 1 / PetscSqrtScalar(L.rho * rho) * (1 - 0.5 * (rho - L.rho) / rho) : 1 / rho;
802c4762a1bSJed Brown       dfr = (R.rho < rho) ? 1 / PetscSqrtScalar(R.rho * rho) * (1 - 0.5 * (rho - R.rho) / rho) : 1 / rho;
803c4762a1bSJed Brown       tmp = rho - res / (c * (dfr + dfl));
804c4762a1bSJed Brown       if (tmp <= 0) rho /= 2; /* Guard against Newton shooting off to a negative density */
805c4762a1bSJed Brown       else rho = tmp;
8063c633725SBarry Smith       PetscCheck(((rho > 0) && PetscIsNormalScalar(rho)), PETSC_COMM_SELF, PETSC_ERR_FP, "non-normal iterate rho=%g", (double)PetscRealPart(rho));
807c4762a1bSJed Brown     }
80863a3b9bcSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_CONV_FAILED, "Newton iteration for star.rho diverged after %" PetscInt_FMT " iterations", i);
809c4762a1bSJed Brown   }
810c4762a1bSJed Brown converged:
811c4762a1bSJed Brown   if (L.u - c < 0 && 0 < star.u - c) { /* 1-wave is sonic rarefaction */
812c4762a1bSJed Brown     PetscScalar ufan[2];
813c4762a1bSJed Brown     ufan[0] = L.rho * PetscExpScalar(L.u / c - 1);
814c4762a1bSJed Brown     ufan[1] = c * ufan[0];
815c4762a1bSJed Brown     IsoGasFlux(c, ufan, flux);
816c4762a1bSJed Brown   } else if (star.u + c < 0 && 0 < R.u + c) { /* 2-wave is sonic rarefaction */
817c4762a1bSJed Brown     PetscScalar ufan[2];
818c4762a1bSJed Brown     ufan[0] = R.rho * PetscExpScalar(-R.u / c - 1);
819c4762a1bSJed Brown     ufan[1] = -c * ufan[0];
820c4762a1bSJed Brown     IsoGasFlux(c, ufan, flux);
821c4762a1bSJed Brown   } else if ((L.rho >= star.rho && L.u - c >= 0) || (L.rho < star.rho && (star.rho * star.u - L.rho * L.u) / (star.rho - L.rho) > 0)) {
822c4762a1bSJed Brown     /* 1-wave is supersonic rarefaction, or supersonic shock */
823c4762a1bSJed Brown     IsoGasFlux(c, uL, flux);
824c4762a1bSJed Brown   } else if ((star.rho <= R.rho && R.u + c <= 0) || (star.rho > R.rho && (R.rho * R.u - star.rho * star.u) / (R.rho - star.rho) < 0)) {
825c4762a1bSJed Brown     /* 2-wave is supersonic rarefaction or supersonic shock */
826c4762a1bSJed Brown     IsoGasFlux(c, uR, flux);
827c4762a1bSJed Brown   } else {
828c4762a1bSJed Brown     ustar[0] = star.rho;
829c4762a1bSJed Brown     ustar[1] = star.rho * star.u;
830c4762a1bSJed Brown     IsoGasFlux(c, ustar, flux);
831c4762a1bSJed Brown   }
832c4762a1bSJed Brown   *maxspeed = MaxAbs(MaxAbs(star.u - c, star.u + c), MaxAbs(L.u - c, R.u + c));
833c4762a1bSJed Brown   PetscFunctionReturn(0);
834c4762a1bSJed Brown }
835c4762a1bSJed Brown 
8369371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_IsoGas_Rusanov(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
837c4762a1bSJed Brown   IsoGasCtx  *phys = (IsoGasCtx *)vctx;
838c4762a1bSJed Brown   PetscScalar c    = phys->acoustic_speed, fL[2], fR[2], s;
8399371c9d4SSatish Balay   struct {
8409371c9d4SSatish Balay     PetscScalar rho, u;
8419371c9d4SSatish Balay   } L = {uL[0], uL[1] / uL[0]}, R = {uR[0], uR[1] / uR[0]};
842c4762a1bSJed Brown 
843c4762a1bSJed Brown   PetscFunctionBeginUser;
8443c633725SBarry Smith   PetscCheck((L.rho > 0 && R.rho > 0), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Reconstructed density is negative");
845c4762a1bSJed Brown   IsoGasFlux(c, uL, fL);
846c4762a1bSJed Brown   IsoGasFlux(c, uR, fR);
847c4762a1bSJed Brown   s         = PetscMax(PetscAbs(L.u), PetscAbs(R.u)) + c;
848c4762a1bSJed Brown   flux[0]   = 0.5 * (fL[0] + fR[0]) + 0.5 * s * (uL[0] - uR[0]);
849c4762a1bSJed Brown   flux[1]   = 0.5 * (fL[1] + fR[1]) + 0.5 * s * (uL[1] - uR[1]);
850c4762a1bSJed Brown   *maxspeed = s;
851c4762a1bSJed Brown   PetscFunctionReturn(0);
852c4762a1bSJed Brown }
853c4762a1bSJed Brown 
8549371c9d4SSatish Balay static PetscErrorCode PhysicsCharacteristic_IsoGas(void *vctx, PetscInt m, const PetscScalar *u, PetscScalar *X, PetscScalar *Xi, PetscReal *speeds) {
855c4762a1bSJed Brown   IsoGasCtx *phys = (IsoGasCtx *)vctx;
856c4762a1bSJed Brown   PetscReal  c    = phys->acoustic_speed;
857c4762a1bSJed Brown 
858c4762a1bSJed Brown   PetscFunctionBeginUser;
859c4762a1bSJed Brown   speeds[0]    = u[1] / u[0] - c;
860c4762a1bSJed Brown   speeds[1]    = u[1] / u[0] + c;
861c4762a1bSJed Brown   X[0 * 2 + 0] = 1;
862c4762a1bSJed Brown   X[0 * 2 + 1] = speeds[0];
863c4762a1bSJed Brown   X[1 * 2 + 0] = 1;
864c4762a1bSJed Brown   X[1 * 2 + 1] = speeds[1];
8659566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(Xi, X, 4));
8669566063dSJacob Faibussowitsch   PetscCall(PetscKernel_A_gets_inverse_A_2(Xi, 0, PETSC_FALSE, NULL));
867c4762a1bSJed Brown   PetscFunctionReturn(0);
868c4762a1bSJed Brown }
869c4762a1bSJed Brown 
8709371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_IsoGas(FVCtx *ctx) {
871c4762a1bSJed Brown   IsoGasCtx        *user;
872c4762a1bSJed Brown   PetscFunctionList rlist = 0, rclist = 0;
873c4762a1bSJed Brown   char              rname[256] = "exact", rcname[256] = "characteristic";
874c4762a1bSJed Brown 
875c4762a1bSJed Brown   PetscFunctionBeginUser;
8769566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
877c4762a1bSJed Brown   ctx->physics.sample  = PhysicsSample_IsoGas;
878c4762a1bSJed Brown   ctx->physics.destroy = PhysicsDestroy_SimpleFree;
879c4762a1bSJed Brown   ctx->physics.user    = user;
880c4762a1bSJed Brown   ctx->physics.dof     = 2;
881c4762a1bSJed Brown 
8829566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("density", &ctx->physics.fieldname[0]));
8839566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("momentum", &ctx->physics.fieldname[1]));
884c4762a1bSJed Brown 
885c4762a1bSJed Brown   user->acoustic_speed = 1;
886c4762a1bSJed Brown 
8879566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "exact", PhysicsRiemann_IsoGas_Exact));
8889566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "roe", PhysicsRiemann_IsoGas_Roe));
8899566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "rusanov", PhysicsRiemann_IsoGas_Rusanov));
8909566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "characteristic", PhysicsCharacteristic_IsoGas));
8919566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "conservative", PhysicsCharacteristic_Conservative));
892d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for IsoGas", "");
8939566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-physics_isogas_acoustic_speed", "Acoustic speed", "", user->acoustic_speed, &user->acoustic_speed, NULL));
8949566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics_isogas_riemann", "Riemann solver", "", rlist, rname, rname, sizeof(rname), NULL));
8959566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics_isogas_reconstruct", "Reconstruction", "", rclist, rcname, rcname, sizeof(rcname), NULL));
896d0609cedSBarry Smith   PetscOptionsEnd();
8979566063dSJacob Faibussowitsch   PetscCall(RiemannListFind(rlist, rname, &ctx->physics.riemann));
8989566063dSJacob Faibussowitsch   PetscCall(ReconstructListFind(rclist, rcname, &ctx->physics.characteristic));
8999566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rlist));
9009566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rclist));
901c4762a1bSJed Brown   PetscFunctionReturn(0);
902c4762a1bSJed Brown }
903c4762a1bSJed Brown 
904c4762a1bSJed Brown /* --------------------------------- Shallow Water ----------------------------------- */
905c4762a1bSJed Brown typedef struct {
906c4762a1bSJed Brown   PetscReal gravity;
907c4762a1bSJed Brown } ShallowCtx;
908c4762a1bSJed Brown 
9099371c9d4SSatish Balay static inline void ShallowFlux(ShallowCtx *phys, const PetscScalar *u, PetscScalar *f) {
910c4762a1bSJed Brown   f[0] = u[1];
911c4762a1bSJed Brown   f[1] = PetscSqr(u[1]) / u[0] + 0.5 * phys->gravity * PetscSqr(u[0]);
912c4762a1bSJed Brown }
913c4762a1bSJed Brown 
9149371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Shallow_Exact(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
915c4762a1bSJed Brown   ShallowCtx *phys = (ShallowCtx *)vctx;
916c4762a1bSJed Brown   PetscScalar g    = phys->gravity, ustar[2], cL, cR, c, cstar;
9179371c9d4SSatish Balay   struct {
9189371c9d4SSatish Balay     PetscScalar h, u;
9199371c9d4SSatish Balay   } L = {uL[0], uL[1] / uL[0]}, R = {uR[0], uR[1] / uR[0]}, star;
920c4762a1bSJed Brown   PetscInt i;
921c4762a1bSJed Brown 
922c4762a1bSJed Brown   PetscFunctionBeginUser;
9233c633725SBarry Smith   PetscCheck((L.h > 0 && R.h > 0), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Reconstructed thickness is negative");
924c4762a1bSJed Brown   cL = PetscSqrtScalar(g * L.h);
925c4762a1bSJed Brown   cR = PetscSqrtScalar(g * R.h);
926c4762a1bSJed Brown   c  = PetscMax(cL, cR);
927c4762a1bSJed Brown   {
928c4762a1bSJed Brown     /* Solve for star state */
929c4762a1bSJed Brown     const PetscInt maxits = 50;
930c4762a1bSJed Brown     PetscScalar    tmp, res, res0 = 0, h0, h = 0.5 * (L.h + R.h); /* initial guess */
931c4762a1bSJed Brown     h0 = h;
932c4762a1bSJed Brown     for (i = 0; i < maxits; i++) {
933c4762a1bSJed Brown       PetscScalar fr, fl, dfr, dfl;
9349371c9d4SSatish Balay       fl  = (L.h < h) ? PetscSqrtScalar(0.5 * g * (h * h - L.h * L.h) * (1 / L.h - 1 / h)) /* shock */
935c4762a1bSJed Brown                       : 2 * PetscSqrtScalar(g * h) - 2 * PetscSqrtScalar(g * L.h);         /* rarefaction */
9369371c9d4SSatish Balay       fr  = (R.h < h) ? PetscSqrtScalar(0.5 * g * (h * h - R.h * R.h) * (1 / R.h - 1 / h)) /* shock */
937c4762a1bSJed Brown                       : 2 * PetscSqrtScalar(g * h) - 2 * PetscSqrtScalar(g * R.h);         /* rarefaction */
938c4762a1bSJed Brown       res = R.u - L.u + fr + fl;
9393c633725SBarry Smith       PetscCheck(!PetscIsInfOrNanScalar(res), PETSC_COMM_SELF, PETSC_ERR_FP, "Infinity or Not-a-Number generated in computation");
940c4762a1bSJed Brown       if (PetscAbsScalar(res) < 1e-8 || (i > 0 && PetscAbsScalar(h - h0) < 1e-8)) {
941c4762a1bSJed Brown         star.h = h;
942c4762a1bSJed Brown         star.u = L.u - fl;
943c4762a1bSJed Brown         goto converged;
944c4762a1bSJed Brown       } else if (i > 0 && PetscAbsScalar(res) >= PetscAbsScalar(res0)) { /* Line search */
945c4762a1bSJed Brown         h = 0.8 * h0 + 0.2 * h;
946c4762a1bSJed Brown         continue;
947c4762a1bSJed Brown       }
948c4762a1bSJed Brown       /* Accept the last step and take another */
949c4762a1bSJed Brown       res0 = res;
950c4762a1bSJed Brown       h0   = h;
951c4762a1bSJed Brown       dfl  = (L.h < h) ? 0.5 / fl * 0.5 * g * (-L.h * L.h / (h * h) - 1 + 2 * h / L.h) : PetscSqrtScalar(g / h);
952c4762a1bSJed Brown       dfr  = (R.h < h) ? 0.5 / fr * 0.5 * g * (-R.h * R.h / (h * h) - 1 + 2 * h / R.h) : PetscSqrtScalar(g / h);
953c4762a1bSJed Brown       tmp  = h - res / (dfr + dfl);
954c4762a1bSJed Brown       if (tmp <= 0) h /= 2; /* Guard against Newton shooting off to a negative thickness */
955c4762a1bSJed Brown       else h = tmp;
9563c633725SBarry Smith       PetscCheck(((h > 0) && PetscIsNormalScalar(h)), PETSC_COMM_SELF, PETSC_ERR_FP, "non-normal iterate h=%g", (double)h);
957c4762a1bSJed Brown     }
95863a3b9bcSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_CONV_FAILED, "Newton iteration for star.h diverged after %" PetscInt_FMT " iterations", i);
959c4762a1bSJed Brown   }
960c4762a1bSJed Brown converged:
961c4762a1bSJed Brown   cstar = PetscSqrtScalar(g * star.h);
962c4762a1bSJed Brown   if (L.u - cL < 0 && 0 < star.u - cstar) { /* 1-wave is sonic rarefaction */
963c4762a1bSJed Brown     PetscScalar ufan[2];
964c4762a1bSJed Brown     ufan[0] = 1 / g * PetscSqr(L.u / 3 + 2. / 3 * cL);
965c4762a1bSJed Brown     ufan[1] = PetscSqrtScalar(g * ufan[0]) * ufan[0];
966c4762a1bSJed Brown     ShallowFlux(phys, ufan, flux);
967c4762a1bSJed Brown   } else if (star.u + cstar < 0 && 0 < R.u + cR) { /* 2-wave is sonic rarefaction */
968c4762a1bSJed Brown     PetscScalar ufan[2];
969c4762a1bSJed Brown     ufan[0] = 1 / g * PetscSqr(R.u / 3 - 2. / 3 * cR);
970c4762a1bSJed Brown     ufan[1] = -PetscSqrtScalar(g * ufan[0]) * ufan[0];
971c4762a1bSJed Brown     ShallowFlux(phys, ufan, flux);
972c4762a1bSJed Brown   } else if ((L.h >= star.h && L.u - c >= 0) || (L.h < star.h && (star.h * star.u - L.h * L.u) / (star.h - L.h) > 0)) {
973c4762a1bSJed Brown     /* 1-wave is right-travelling shock (supersonic) */
974c4762a1bSJed Brown     ShallowFlux(phys, uL, flux);
975c4762a1bSJed Brown   } else if ((star.h <= R.h && R.u + c <= 0) || (star.h > R.h && (R.h * R.u - star.h * star.h) / (R.h - star.h) < 0)) {
976c4762a1bSJed Brown     /* 2-wave is left-travelling shock (supersonic) */
977c4762a1bSJed Brown     ShallowFlux(phys, uR, flux);
978c4762a1bSJed Brown   } else {
979c4762a1bSJed Brown     ustar[0] = star.h;
980c4762a1bSJed Brown     ustar[1] = star.h * star.u;
981c4762a1bSJed Brown     ShallowFlux(phys, ustar, flux);
982c4762a1bSJed Brown   }
983c4762a1bSJed Brown   *maxspeed = MaxAbs(MaxAbs(star.u - cstar, star.u + cstar), MaxAbs(L.u - cL, R.u + cR));
984c4762a1bSJed Brown   PetscFunctionReturn(0);
985c4762a1bSJed Brown }
986c4762a1bSJed Brown 
9879371c9d4SSatish Balay static PetscErrorCode PhysicsRiemann_Shallow_Rusanov(void *vctx, PetscInt m, const PetscScalar *uL, const PetscScalar *uR, PetscScalar *flux, PetscReal *maxspeed) {
988c4762a1bSJed Brown   ShallowCtx *phys = (ShallowCtx *)vctx;
989c4762a1bSJed Brown   PetscScalar g    = phys->gravity, fL[2], fR[2], s;
9909371c9d4SSatish Balay   struct {
9919371c9d4SSatish Balay     PetscScalar h, u;
9929371c9d4SSatish Balay   } L = {uL[0], uL[1] / uL[0]}, R = {uR[0], uR[1] / uR[0]};
993c4762a1bSJed Brown 
994c4762a1bSJed Brown   PetscFunctionBeginUser;
9953c633725SBarry Smith   PetscCheck((L.h > 0 && R.h > 0), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Reconstructed thickness is negative");
996c4762a1bSJed Brown   ShallowFlux(phys, uL, fL);
997c4762a1bSJed Brown   ShallowFlux(phys, uR, fR);
998c4762a1bSJed Brown   s         = PetscMax(PetscAbs(L.u) + PetscSqrtScalar(g * L.h), PetscAbs(R.u) + PetscSqrtScalar(g * R.h));
999c4762a1bSJed Brown   flux[0]   = 0.5 * (fL[0] + fR[0]) + 0.5 * s * (uL[0] - uR[0]);
1000c4762a1bSJed Brown   flux[1]   = 0.5 * (fL[1] + fR[1]) + 0.5 * s * (uL[1] - uR[1]);
1001c4762a1bSJed Brown   *maxspeed = s;
1002c4762a1bSJed Brown   PetscFunctionReturn(0);
1003c4762a1bSJed Brown }
1004c4762a1bSJed Brown 
10059371c9d4SSatish Balay static PetscErrorCode PhysicsCharacteristic_Shallow(void *vctx, PetscInt m, const PetscScalar *u, PetscScalar *X, PetscScalar *Xi, PetscReal *speeds) {
1006c4762a1bSJed Brown   ShallowCtx *phys = (ShallowCtx *)vctx;
1007c4762a1bSJed Brown   PetscReal   c;
1008c4762a1bSJed Brown 
1009c4762a1bSJed Brown   PetscFunctionBeginUser;
1010c4762a1bSJed Brown   c            = PetscSqrtScalar(u[0] * phys->gravity);
1011c4762a1bSJed Brown   speeds[0]    = u[1] / u[0] - c;
1012c4762a1bSJed Brown   speeds[1]    = u[1] / u[0] + c;
1013c4762a1bSJed Brown   X[0 * 2 + 0] = 1;
1014c4762a1bSJed Brown   X[0 * 2 + 1] = speeds[0];
1015c4762a1bSJed Brown   X[1 * 2 + 0] = 1;
1016c4762a1bSJed Brown   X[1 * 2 + 1] = speeds[1];
10179566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(Xi, X, 4));
10189566063dSJacob Faibussowitsch   PetscCall(PetscKernel_A_gets_inverse_A_2(Xi, 0, PETSC_FALSE, NULL));
1019c4762a1bSJed Brown   PetscFunctionReturn(0);
1020c4762a1bSJed Brown }
1021c4762a1bSJed Brown 
10229371c9d4SSatish Balay static PetscErrorCode PhysicsCreate_Shallow(FVCtx *ctx) {
1023c4762a1bSJed Brown   ShallowCtx       *user;
1024c4762a1bSJed Brown   PetscFunctionList rlist = 0, rclist = 0;
1025c4762a1bSJed Brown   char              rname[256] = "exact", rcname[256] = "characteristic";
1026c4762a1bSJed Brown 
1027c4762a1bSJed Brown   PetscFunctionBeginUser;
10289566063dSJacob Faibussowitsch   PetscCall(PetscNew(&user));
1029c4762a1bSJed Brown   /* Shallow water and Isothermal Gas dynamics are similar so we reuse initial conditions for now */
1030c4762a1bSJed Brown   ctx->physics.sample  = PhysicsSample_IsoGas;
1031c4762a1bSJed Brown   ctx->physics.destroy = PhysicsDestroy_SimpleFree;
1032c4762a1bSJed Brown   ctx->physics.user    = user;
1033c4762a1bSJed Brown   ctx->physics.dof     = 2;
1034c4762a1bSJed Brown 
10359566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("density", &ctx->physics.fieldname[0]));
10369566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("momentum", &ctx->physics.fieldname[1]));
1037c4762a1bSJed Brown 
1038c4762a1bSJed Brown   user->gravity = 1;
1039c4762a1bSJed Brown 
10409566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "exact", PhysicsRiemann_Shallow_Exact));
10419566063dSJacob Faibussowitsch   PetscCall(RiemannListAdd(&rlist, "rusanov", PhysicsRiemann_Shallow_Rusanov));
10429566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "characteristic", PhysicsCharacteristic_Shallow));
10439566063dSJacob Faibussowitsch   PetscCall(ReconstructListAdd(&rclist, "conservative", PhysicsCharacteristic_Conservative));
1044d0609cedSBarry Smith   PetscOptionsBegin(ctx->comm, ctx->prefix, "Options for Shallow", "");
10459566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-physics_shallow_gravity", "Gravity", "", user->gravity, &user->gravity, NULL));
10469566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics_shallow_riemann", "Riemann solver", "", rlist, rname, rname, sizeof(rname), NULL));
10479566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics_shallow_reconstruct", "Reconstruction", "", rclist, rcname, rcname, sizeof(rcname), NULL));
1048d0609cedSBarry Smith   PetscOptionsEnd();
10499566063dSJacob Faibussowitsch   PetscCall(RiemannListFind(rlist, rname, &ctx->physics.riemann));
10509566063dSJacob Faibussowitsch   PetscCall(ReconstructListFind(rclist, rcname, &ctx->physics.characteristic));
10519566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rlist));
10529566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&rclist));
1053c4762a1bSJed Brown   PetscFunctionReturn(0);
1054c4762a1bSJed Brown }
1055c4762a1bSJed Brown 
1056c4762a1bSJed Brown /* --------------------------------- Finite Volume Solver ----------------------------------- */
1057c4762a1bSJed Brown 
10589371c9d4SSatish Balay static PetscErrorCode FVRHSFunction(TS ts, PetscReal time, Vec X, Vec F, void *vctx) {
1059c4762a1bSJed Brown   FVCtx       *ctx = (FVCtx *)vctx;
1060c4762a1bSJed Brown   PetscInt     i, j, k, Mx, dof, xs, xm;
1061c4762a1bSJed Brown   PetscReal    hx, cfl_idt = 0;
1062c4762a1bSJed Brown   PetscScalar *x, *f, *slope;
1063c4762a1bSJed Brown   Vec          Xloc;
1064c4762a1bSJed Brown   DM           da;
1065c4762a1bSJed Brown 
1066c4762a1bSJed Brown   PetscFunctionBeginUser;
10679566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &da));
10689566063dSJacob Faibussowitsch   PetscCall(DMGetLocalVector(da, &Xloc));
10699566063dSJacob Faibussowitsch   PetscCall(DMDAGetInfo(da, 0, &Mx, 0, 0, 0, 0, 0, &dof, 0, 0, 0, 0, 0));
1070c4762a1bSJed Brown   hx = (ctx->xmax - ctx->xmin) / Mx;
10719566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(da, X, INSERT_VALUES, Xloc));
10729566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(da, X, INSERT_VALUES, Xloc));
1073c4762a1bSJed Brown 
10749566063dSJacob Faibussowitsch   PetscCall(VecZeroEntries(F));
1075c4762a1bSJed Brown 
10769566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArray(da, Xloc, &x));
10779566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArray(da, F, &f));
10789566063dSJacob Faibussowitsch   PetscCall(DMDAGetArray(da, PETSC_TRUE, &slope));
1079c4762a1bSJed Brown 
10809566063dSJacob Faibussowitsch   PetscCall(DMDAGetCorners(da, &xs, 0, 0, &xm, 0, 0));
1081c4762a1bSJed Brown 
1082c4762a1bSJed Brown   if (ctx->bctype == FVBC_OUTFLOW) {
1083c4762a1bSJed Brown     for (i = xs - 2; i < 0; i++) {
1084c4762a1bSJed Brown       for (j = 0; j < dof; j++) x[i * dof + j] = x[j];
1085c4762a1bSJed Brown     }
1086c4762a1bSJed Brown     for (i = Mx; i < xs + xm + 2; i++) {
1087c4762a1bSJed Brown       for (j = 0; j < dof; j++) x[i * dof + j] = x[(xs + xm - 1) * dof + j];
1088c4762a1bSJed Brown     }
1089c4762a1bSJed Brown   }
1090c4762a1bSJed Brown   for (i = xs - 1; i < xs + xm + 1; i++) {
1091c4762a1bSJed Brown     struct _LimitInfo info;
1092c4762a1bSJed Brown     PetscScalar      *cjmpL, *cjmpR;
1093c4762a1bSJed Brown     /* Determine the right eigenvectors R, where A = R \Lambda R^{-1} */
10949566063dSJacob Faibussowitsch     PetscCall((*ctx->physics.characteristic)(ctx->physics.user, dof, &x[i * dof], ctx->R, ctx->Rinv, ctx->speeds));
1095c4762a1bSJed Brown     /* Evaluate jumps across interfaces (i-1, i) and (i, i+1), put in characteristic basis */
10969566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(ctx->cjmpLR, 2 * dof));
1097c4762a1bSJed Brown     cjmpL = &ctx->cjmpLR[0];
1098c4762a1bSJed Brown     cjmpR = &ctx->cjmpLR[dof];
1099c4762a1bSJed Brown     for (j = 0; j < dof; j++) {
1100c4762a1bSJed Brown       PetscScalar jmpL, jmpR;
1101c4762a1bSJed Brown       jmpL = x[(i + 0) * dof + j] - x[(i - 1) * dof + j];
1102c4762a1bSJed Brown       jmpR = x[(i + 1) * dof + j] - x[(i + 0) * dof + j];
1103c4762a1bSJed Brown       for (k = 0; k < dof; k++) {
1104c4762a1bSJed Brown         cjmpL[k] += ctx->Rinv[k + j * dof] * jmpL;
1105c4762a1bSJed Brown         cjmpR[k] += ctx->Rinv[k + j * dof] * jmpR;
1106c4762a1bSJed Brown       }
1107c4762a1bSJed Brown     }
1108c4762a1bSJed Brown     /* Apply limiter to the left and right characteristic jumps */
1109c4762a1bSJed Brown     info.m  = dof;
1110c4762a1bSJed Brown     info.hx = hx;
1111c4762a1bSJed Brown     (*ctx->limit)(&info, cjmpL, cjmpR, ctx->cslope);
1112c4762a1bSJed Brown     for (j = 0; j < dof; j++) ctx->cslope[j] /= hx; /* rescale to a slope */
1113c4762a1bSJed Brown     for (j = 0; j < dof; j++) {
1114c4762a1bSJed Brown       PetscScalar tmp = 0;
1115c4762a1bSJed Brown       for (k = 0; k < dof; k++) tmp += ctx->R[j + k * dof] * ctx->cslope[k];
1116c4762a1bSJed Brown       slope[i * dof + j] = tmp;
1117c4762a1bSJed Brown     }
1118c4762a1bSJed Brown   }
1119c4762a1bSJed Brown 
1120c4762a1bSJed Brown   for (i = xs; i < xs + xm + 1; i++) {
1121c4762a1bSJed Brown     PetscReal    maxspeed;
1122c4762a1bSJed Brown     PetscScalar *uL, *uR;
1123c4762a1bSJed Brown     uL = &ctx->uLR[0];
1124c4762a1bSJed Brown     uR = &ctx->uLR[dof];
1125c4762a1bSJed Brown     for (j = 0; j < dof; j++) {
1126c4762a1bSJed Brown       uL[j] = x[(i - 1) * dof + j] + slope[(i - 1) * dof + j] * hx / 2;
1127c4762a1bSJed Brown       uR[j] = x[(i - 0) * dof + j] - slope[(i - 0) * dof + j] * hx / 2;
1128c4762a1bSJed Brown     }
11299566063dSJacob Faibussowitsch     PetscCall((*ctx->physics.riemann)(ctx->physics.user, dof, uL, uR, ctx->flux, &maxspeed));
1130c4762a1bSJed Brown     cfl_idt = PetscMax(cfl_idt, PetscAbsScalar(maxspeed / hx)); /* Max allowable value of 1/Delta t */
1131c4762a1bSJed Brown 
1132c4762a1bSJed Brown     if (i > xs) {
1133c4762a1bSJed Brown       for (j = 0; j < dof; j++) f[(i - 1) * dof + j] -= ctx->flux[j] / hx;
1134c4762a1bSJed Brown     }
1135c4762a1bSJed Brown     if (i < xs + xm) {
1136c4762a1bSJed Brown       for (j = 0; j < dof; j++) f[i * dof + j] += ctx->flux[j] / hx;
1137c4762a1bSJed Brown     }
1138c4762a1bSJed Brown   }
1139c4762a1bSJed Brown 
11409566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArray(da, Xloc, &x));
11419566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArray(da, F, &f));
11429566063dSJacob Faibussowitsch   PetscCall(DMDARestoreArray(da, PETSC_TRUE, &slope));
11439566063dSJacob Faibussowitsch   PetscCall(DMRestoreLocalVector(da, &Xloc));
1144c4762a1bSJed Brown 
11459566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&cfl_idt, &ctx->cfl_idt, 1, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject)da)));
1146c4762a1bSJed Brown   if (0) {
1147c4762a1bSJed Brown     /* We need to a way to inform the TS of a CFL constraint, this is a debugging fragment */
1148c4762a1bSJed Brown     PetscReal dt, tnow;
11499566063dSJacob Faibussowitsch     PetscCall(TSGetTimeStep(ts, &dt));
11509566063dSJacob Faibussowitsch     PetscCall(TSGetTime(ts, &tnow));
1151*48a46eb9SPierre Jolivet     if (dt > 0.5 / ctx->cfl_idt) PetscCall(PetscPrintf(ctx->comm, "Stability constraint exceeded at t=%g, dt %g > %g\n", (double)tnow, (double)dt, (double)(0.5 / ctx->cfl_idt)));
1152c4762a1bSJed Brown   }
1153c4762a1bSJed Brown   PetscFunctionReturn(0);
1154c4762a1bSJed Brown }
1155c4762a1bSJed Brown 
11569371c9d4SSatish Balay static PetscErrorCode SmallMatMultADB(PetscScalar *C, PetscInt bs, const PetscScalar *A, const PetscReal *D, const PetscScalar *B) {
1157c4762a1bSJed Brown   PetscInt i, j, k;
1158c4762a1bSJed Brown 
1159c4762a1bSJed Brown   PetscFunctionBeginUser;
1160c4762a1bSJed Brown   for (i = 0; i < bs; i++) {
1161c4762a1bSJed Brown     for (j = 0; j < bs; j++) {
1162c4762a1bSJed Brown       PetscScalar tmp = 0;
1163c4762a1bSJed Brown       for (k = 0; k < bs; k++) tmp += A[i * bs + k] * D[k] * B[k * bs + j];
1164c4762a1bSJed Brown       C[i * bs + j] = tmp;
1165c4762a1bSJed Brown     }
1166c4762a1bSJed Brown   }
1167c4762a1bSJed Brown   PetscFunctionReturn(0);
1168c4762a1bSJed Brown }
1169c4762a1bSJed Brown 
11709371c9d4SSatish Balay static PetscErrorCode FVIJacobian(TS ts, PetscReal t, Vec X, Vec Xdot, PetscReal shift, Mat A, Mat B, void *vctx) {
1171c4762a1bSJed Brown   FVCtx             *ctx = (FVCtx *)vctx;
1172c4762a1bSJed Brown   PetscInt           i, j, dof = ctx->physics.dof;
1173c4762a1bSJed Brown   PetscScalar       *J;
1174c4762a1bSJed Brown   const PetscScalar *x;
1175c4762a1bSJed Brown   PetscReal          hx;
1176c4762a1bSJed Brown   DM                 da;
1177c4762a1bSJed Brown   DMDALocalInfo      dainfo;
1178c4762a1bSJed Brown 
1179c4762a1bSJed Brown   PetscFunctionBeginUser;
11809566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &da));
11819566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArrayRead(da, X, (void *)&x));
11829566063dSJacob Faibussowitsch   PetscCall(DMDAGetLocalInfo(da, &dainfo));
1183c4762a1bSJed Brown   hx = (ctx->xmax - ctx->xmin) / dainfo.mx;
11849566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(dof * dof, &J));
1185c4762a1bSJed Brown   for (i = dainfo.xs; i < dainfo.xs + dainfo.xm; i++) {
11869566063dSJacob Faibussowitsch     PetscCall((*ctx->physics.characteristic)(ctx->physics.user, dof, &x[i * dof], ctx->R, ctx->Rinv, ctx->speeds));
1187c4762a1bSJed Brown     for (j = 0; j < dof; j++) ctx->speeds[j] = PetscAbs(ctx->speeds[j]);
11889566063dSJacob Faibussowitsch     PetscCall(SmallMatMultADB(J, dof, ctx->R, ctx->speeds, ctx->Rinv));
1189c4762a1bSJed Brown     for (j = 0; j < dof * dof; j++) J[j] = J[j] / hx + shift * (j / dof == j % dof);
11909566063dSJacob Faibussowitsch     PetscCall(MatSetValuesBlocked(B, 1, &i, 1, &i, J, INSERT_VALUES));
1191c4762a1bSJed Brown   }
11929566063dSJacob Faibussowitsch   PetscCall(PetscFree(J));
11939566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArrayRead(da, X, (void *)&x));
1194c4762a1bSJed Brown 
11959566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(B, MAT_FINAL_ASSEMBLY));
11969566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(B, MAT_FINAL_ASSEMBLY));
1197c4762a1bSJed Brown   if (A != B) {
11989566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(A, MAT_FINAL_ASSEMBLY));
11999566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(A, MAT_FINAL_ASSEMBLY));
1200c4762a1bSJed Brown   }
1201c4762a1bSJed Brown   PetscFunctionReturn(0);
1202c4762a1bSJed Brown }
1203c4762a1bSJed Brown 
12049371c9d4SSatish Balay static PetscErrorCode FVSample(FVCtx *ctx, DM da, PetscReal time, Vec U) {
1205c4762a1bSJed Brown   PetscScalar *u, *uj;
1206c4762a1bSJed Brown   PetscInt     i, j, k, dof, xs, xm, Mx;
1207c4762a1bSJed Brown 
1208c4762a1bSJed Brown   PetscFunctionBeginUser;
12093c633725SBarry Smith   PetscCheck(ctx->physics.sample, PETSC_COMM_SELF, PETSC_ERR_SUP, "Physics has not provided a sampling function");
12109566063dSJacob Faibussowitsch   PetscCall(DMDAGetInfo(da, 0, &Mx, 0, 0, 0, 0, 0, &dof, 0, 0, 0, 0, 0));
12119566063dSJacob Faibussowitsch   PetscCall(DMDAGetCorners(da, &xs, 0, 0, &xm, 0, 0));
12129566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArray(da, U, &u));
12139566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(dof, &uj));
1214c4762a1bSJed Brown   for (i = xs; i < xs + xm; i++) {
1215c4762a1bSJed Brown     const PetscReal h = (ctx->xmax - ctx->xmin) / Mx, xi = ctx->xmin + h / 2 + i * h;
1216c4762a1bSJed Brown     const PetscInt  N = 200;
1217c4762a1bSJed Brown     /* Integrate over cell i using trapezoid rule with N points. */
1218c4762a1bSJed Brown     for (k = 0; k < dof; k++) u[i * dof + k] = 0;
1219c4762a1bSJed Brown     for (j = 0; j < N + 1; j++) {
1220c4762a1bSJed Brown       PetscScalar xj = xi + h * (j - N / 2) / (PetscReal)N;
12219566063dSJacob Faibussowitsch       PetscCall((*ctx->physics.sample)(ctx->physics.user, ctx->initial, ctx->bctype, ctx->xmin, ctx->xmax, time, xj, uj));
1222c4762a1bSJed Brown       for (k = 0; k < dof; k++) u[i * dof + k] += ((j == 0 || j == N) ? 0.5 : 1.0) * uj[k] / N;
1223c4762a1bSJed Brown     }
1224c4762a1bSJed Brown   }
12259566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArray(da, U, &u));
12269566063dSJacob Faibussowitsch   PetscCall(PetscFree(uj));
1227c4762a1bSJed Brown   PetscFunctionReturn(0);
1228c4762a1bSJed Brown }
1229c4762a1bSJed Brown 
12309371c9d4SSatish Balay static PetscErrorCode SolutionStatsView(DM da, Vec X, PetscViewer viewer) {
1231c4762a1bSJed Brown   PetscReal          xmin, xmax;
1232c4762a1bSJed Brown   PetscScalar        sum, tvsum, tvgsum;
1233c4762a1bSJed Brown   const PetscScalar *x;
1234c4762a1bSJed Brown   PetscInt           imin, imax, Mx, i, j, xs, xm, dof;
1235c4762a1bSJed Brown   Vec                Xloc;
1236c4762a1bSJed Brown   PetscBool          iascii;
1237c4762a1bSJed Brown 
1238c4762a1bSJed Brown   PetscFunctionBeginUser;
12399566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1240c4762a1bSJed Brown   if (iascii) {
1241c4762a1bSJed Brown     /* PETSc lacks a function to compute total variation norm (difficult in multiple dimensions), we do it here */
12429566063dSJacob Faibussowitsch     PetscCall(DMGetLocalVector(da, &Xloc));
12439566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalBegin(da, X, INSERT_VALUES, Xloc));
12449566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalEnd(da, X, INSERT_VALUES, Xloc));
12459566063dSJacob Faibussowitsch     PetscCall(DMDAVecGetArrayRead(da, Xloc, (void *)&x));
12469566063dSJacob Faibussowitsch     PetscCall(DMDAGetCorners(da, &xs, 0, 0, &xm, 0, 0));
12479566063dSJacob Faibussowitsch     PetscCall(DMDAGetInfo(da, 0, &Mx, 0, 0, 0, 0, 0, &dof, 0, 0, 0, 0, 0));
1248c4762a1bSJed Brown     tvsum = 0;
1249c4762a1bSJed Brown     for (i = xs; i < xs + xm; i++) {
1250c4762a1bSJed Brown       for (j = 0; j < dof; j++) tvsum += PetscAbsScalar(x[i * dof + j] - x[(i - 1) * dof + j]);
1251c4762a1bSJed Brown     }
12529566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&tvsum, &tvgsum, 1, MPIU_REAL, MPIU_SUM, PetscObjectComm((PetscObject)da)));
12539566063dSJacob Faibussowitsch     PetscCall(DMDAVecRestoreArrayRead(da, Xloc, (void *)&x));
12549566063dSJacob Faibussowitsch     PetscCall(DMRestoreLocalVector(da, &Xloc));
1255c4762a1bSJed Brown 
12569566063dSJacob Faibussowitsch     PetscCall(VecMin(X, &imin, &xmin));
12579566063dSJacob Faibussowitsch     PetscCall(VecMax(X, &imax, &xmax));
12589566063dSJacob Faibussowitsch     PetscCall(VecSum(X, &sum));
125963a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Solution range [%8.5f,%8.5f] with extrema at %" PetscInt_FMT " and %" PetscInt_FMT ", mean %8.5f, ||x||_TV %8.5f\n", (double)xmin, (double)xmax, imin, imax, (double)(sum / Mx), (double)(tvgsum / Mx)));
1260c4762a1bSJed Brown   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Viewer type not supported");
1261c4762a1bSJed Brown   PetscFunctionReturn(0);
1262c4762a1bSJed Brown }
1263c4762a1bSJed Brown 
12649371c9d4SSatish Balay static PetscErrorCode SolutionErrorNorms(FVCtx *ctx, DM da, PetscReal t, Vec X, PetscReal *nrm1, PetscReal *nrmsup) {
1265c4762a1bSJed Brown   Vec      Y;
1266c4762a1bSJed Brown   PetscInt Mx;
1267c4762a1bSJed Brown 
1268c4762a1bSJed Brown   PetscFunctionBeginUser;
12699566063dSJacob Faibussowitsch   PetscCall(VecGetSize(X, &Mx));
12709566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(X, &Y));
12719566063dSJacob Faibussowitsch   PetscCall(FVSample(ctx, da, t, Y));
12729566063dSJacob Faibussowitsch   PetscCall(VecAYPX(Y, -1, X));
12739566063dSJacob Faibussowitsch   PetscCall(VecNorm(Y, NORM_1, nrm1));
12749566063dSJacob Faibussowitsch   PetscCall(VecNorm(Y, NORM_INFINITY, nrmsup));
1275c4762a1bSJed Brown   *nrm1 /= Mx;
12769566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Y));
1277c4762a1bSJed Brown   PetscFunctionReturn(0);
1278c4762a1bSJed Brown }
1279c4762a1bSJed Brown 
12809371c9d4SSatish Balay int main(int argc, char *argv[]) {
1281c4762a1bSJed Brown   char              lname[256] = "mc", physname[256] = "advect", final_fname[256] = "solution.m";
1282c4762a1bSJed Brown   PetscFunctionList limiters = 0, physics = 0;
1283c4762a1bSJed Brown   MPI_Comm          comm;
1284c4762a1bSJed Brown   TS                ts;
1285c4762a1bSJed Brown   DM                da;
1286c4762a1bSJed Brown   Vec               X, X0, R;
1287c4762a1bSJed Brown   Mat               B;
1288c4762a1bSJed Brown   FVCtx             ctx;
1289c4762a1bSJed Brown   PetscInt          i, dof, xs, xm, Mx, draw = 0;
1290c4762a1bSJed Brown   PetscBool         view_final = PETSC_FALSE;
1291c4762a1bSJed Brown   PetscReal         ptime;
1292c4762a1bSJed Brown 
1293327415f7SBarry Smith   PetscFunctionBeginUser;
12949566063dSJacob Faibussowitsch   PetscCall(PetscInitialize(&argc, &argv, 0, help));
1295c4762a1bSJed Brown   comm = PETSC_COMM_WORLD;
12969566063dSJacob Faibussowitsch   PetscCall(PetscMemzero(&ctx, sizeof(ctx)));
1297c4762a1bSJed Brown 
1298c4762a1bSJed Brown   /* Register limiters to be available on the command line */
12999566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "upwind", Limit_Upwind));
13009566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "lax-wendroff", Limit_LaxWendroff));
13019566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "beam-warming", Limit_BeamWarming));
13029566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "fromm", Limit_Fromm));
13039566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "minmod", Limit_Minmod));
13049566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "superbee", Limit_Superbee));
13059566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "mc", Limit_MC));
13069566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "vanleer", Limit_VanLeer));
13079566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "vanalbada", Limit_VanAlbada));
13089566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "vanalbadatvd", Limit_VanAlbadaTVD));
13099566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "koren", Limit_Koren));
13109566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "korensym", Limit_KorenSym));
13119566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "koren3", Limit_Koren3));
13129566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "cada-torrilhon2", Limit_CadaTorrilhon2));
13139566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "cada-torrilhon3-r0p1", Limit_CadaTorrilhon3R0p1));
13149566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "cada-torrilhon3-r1", Limit_CadaTorrilhon3R1));
13159566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "cada-torrilhon3-r10", Limit_CadaTorrilhon3R10));
13169566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&limiters, "cada-torrilhon3-r100", Limit_CadaTorrilhon3R100));
1317c4762a1bSJed Brown 
1318c4762a1bSJed Brown   /* Register physical models to be available on the command line */
13199566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "advect", PhysicsCreate_Advect));
13209566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "burgers", PhysicsCreate_Burgers));
13219566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "traffic", PhysicsCreate_Traffic));
13229566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "acoustics", PhysicsCreate_Acoustics));
13239566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "isogas", PhysicsCreate_IsoGas));
13249566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&physics, "shallow", PhysicsCreate_Shallow));
1325c4762a1bSJed Brown 
1326c4762a1bSJed Brown   ctx.comm   = comm;
13279371c9d4SSatish Balay   ctx.cfl    = 0.9;
13289371c9d4SSatish Balay   ctx.bctype = FVBC_PERIODIC;
13299371c9d4SSatish Balay   ctx.xmin   = -1;
13309371c9d4SSatish Balay   ctx.xmax   = 1;
1331d0609cedSBarry Smith   PetscOptionsBegin(comm, NULL, "Finite Volume solver options", "");
13329566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-xmin", "X min", "", ctx.xmin, &ctx.xmin, NULL));
13339566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-xmax", "X max", "", ctx.xmax, &ctx.xmax, NULL));
13349566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-limit", "Name of flux limiter to use", "", limiters, lname, lname, sizeof(lname), NULL));
13359566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-physics", "Name of physics (Riemann solver and characteristics) to use", "", physics, physname, physname, sizeof(physname), NULL));
13369566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-draw", "Draw solution vector, bitwise OR of (1=initial,2=final,4=final error)", "", draw, &draw, NULL));
13379566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-view_final", "Write final solution in ASCII MATLAB format to given file name", "", final_fname, final_fname, sizeof(final_fname), &view_final));
13389566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-initial", "Initial condition (depends on the physics)", "", ctx.initial, &ctx.initial, NULL));
13399566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-exact", "Compare errors with exact solution", "", ctx.exact, &ctx.exact, NULL));
13409566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-cfl", "CFL number to time step at", "", ctx.cfl, &ctx.cfl, NULL));
13419566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-bc_type", "Boundary condition", "", FVBCTypes, (PetscEnum)ctx.bctype, (PetscEnum *)&ctx.bctype, NULL));
1342d0609cedSBarry Smith   PetscOptionsEnd();
1343c4762a1bSJed Brown 
1344c4762a1bSJed Brown   /* Choose the limiter from the list of registered limiters */
13459566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(limiters, lname, &ctx.limit));
13463c633725SBarry Smith   PetscCheck(ctx.limit, PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "Limiter '%s' not found", lname);
1347c4762a1bSJed Brown 
1348c4762a1bSJed Brown   /* Choose the physics from the list of registered models */
1349c4762a1bSJed Brown   {
1350c4762a1bSJed Brown     PetscErrorCode (*r)(FVCtx *);
13519566063dSJacob Faibussowitsch     PetscCall(PetscFunctionListFind(physics, physname, &r));
13523c633725SBarry Smith     PetscCheck(r, PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE, "Physics '%s' not found", physname);
1353c4762a1bSJed Brown     /* Create the physics, will set the number of fields and their names */
13549566063dSJacob Faibussowitsch     PetscCall((*r)(&ctx));
1355c4762a1bSJed Brown   }
1356c4762a1bSJed Brown 
1357c4762a1bSJed Brown   /* Create a DMDA to manage the parallel grid */
13589566063dSJacob Faibussowitsch   PetscCall(DMDACreate1d(comm, DM_BOUNDARY_PERIODIC, 50, ctx.physics.dof, 2, NULL, &da));
13599566063dSJacob Faibussowitsch   PetscCall(DMSetFromOptions(da));
13609566063dSJacob Faibussowitsch   PetscCall(DMSetUp(da));
1361c4762a1bSJed Brown   /* Inform the DMDA of the field names provided by the physics. */
1362c4762a1bSJed Brown   /* The names will be shown in the title bars when run with -ts_monitor_draw_solution */
1363*48a46eb9SPierre Jolivet   for (i = 0; i < ctx.physics.dof; i++) PetscCall(DMDASetFieldName(da, i, ctx.physics.fieldname[i]));
13649566063dSJacob Faibussowitsch   PetscCall(DMDAGetInfo(da, 0, &Mx, 0, 0, 0, 0, 0, &dof, 0, 0, 0, 0, 0));
13659566063dSJacob Faibussowitsch   PetscCall(DMDAGetCorners(da, &xs, 0, 0, &xm, 0, 0));
1366c4762a1bSJed Brown 
1367c4762a1bSJed Brown   /* Set coordinates of cell centers */
13689566063dSJacob Faibussowitsch   PetscCall(DMDASetUniformCoordinates(da, ctx.xmin + 0.5 * (ctx.xmax - ctx.xmin) / Mx, ctx.xmax + 0.5 * (ctx.xmax - ctx.xmin) / Mx, 0, 0, 0, 0));
1369c4762a1bSJed Brown 
1370c4762a1bSJed Brown   /* Allocate work space for the Finite Volume solver (so it doesn't have to be reallocated on each function evaluation) */
13719566063dSJacob Faibussowitsch   PetscCall(PetscMalloc4(dof * dof, &ctx.R, dof * dof, &ctx.Rinv, 2 * dof, &ctx.cjmpLR, 1 * dof, &ctx.cslope));
13729566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(2 * dof, &ctx.uLR, dof, &ctx.flux, dof, &ctx.speeds));
1373c4762a1bSJed Brown 
1374c4762a1bSJed Brown   /* Create a vector to store the solution and to save the initial state */
13759566063dSJacob Faibussowitsch   PetscCall(DMCreateGlobalVector(da, &X));
13769566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(X, &X0));
13779566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(X, &R));
1378c4762a1bSJed Brown 
13799566063dSJacob Faibussowitsch   PetscCall(DMCreateMatrix(da, &B));
1380c4762a1bSJed Brown 
1381c4762a1bSJed Brown   /* Create a time-stepping object */
13829566063dSJacob Faibussowitsch   PetscCall(TSCreate(comm, &ts));
13839566063dSJacob Faibussowitsch   PetscCall(TSSetDM(ts, da));
13849566063dSJacob Faibussowitsch   PetscCall(TSSetRHSFunction(ts, R, FVRHSFunction, &ctx));
13859566063dSJacob Faibussowitsch   PetscCall(TSSetIJacobian(ts, B, B, FVIJacobian, &ctx));
13869566063dSJacob Faibussowitsch   PetscCall(TSSetType(ts, TSSSP));
13879566063dSJacob Faibussowitsch   PetscCall(TSSetMaxTime(ts, 10));
13889566063dSJacob Faibussowitsch   PetscCall(TSSetExactFinalTime(ts, TS_EXACTFINALTIME_STEPOVER));
1389c4762a1bSJed Brown 
1390c4762a1bSJed Brown   /* Compute initial conditions and starting time step */
13919566063dSJacob Faibussowitsch   PetscCall(FVSample(&ctx, da, 0, X0));
13929566063dSJacob Faibussowitsch   PetscCall(FVRHSFunction(ts, 0, X0, X, (void *)&ctx)); /* Initial function evaluation, only used to determine max speed */
13939566063dSJacob Faibussowitsch   PetscCall(VecCopy(X0, X));                            /* The function value was not used so we set X=X0 again */
13949566063dSJacob Faibussowitsch   PetscCall(TSSetTimeStep(ts, ctx.cfl / ctx.cfl_idt));
13959566063dSJacob Faibussowitsch   PetscCall(TSSetFromOptions(ts)); /* Take runtime options */
13969566063dSJacob Faibussowitsch   PetscCall(SolutionStatsView(da, X, PETSC_VIEWER_STDOUT_WORLD));
1397c4762a1bSJed Brown   {
1398c4762a1bSJed Brown     PetscReal nrm1, nrmsup;
1399c4762a1bSJed Brown     PetscInt  steps;
1400c4762a1bSJed Brown 
14019566063dSJacob Faibussowitsch     PetscCall(TSSolve(ts, X));
14029566063dSJacob Faibussowitsch     PetscCall(TSGetSolveTime(ts, &ptime));
14039566063dSJacob Faibussowitsch     PetscCall(TSGetStepNumber(ts, &steps));
1404c4762a1bSJed Brown 
140563a3b9bcSJacob Faibussowitsch     PetscCall(PetscPrintf(comm, "Final time %8.5f, steps %" PetscInt_FMT "\n", (double)ptime, steps));
1406c4762a1bSJed Brown     if (ctx.exact) {
14079566063dSJacob Faibussowitsch       PetscCall(SolutionErrorNorms(&ctx, da, ptime, X, &nrm1, &nrmsup));
14089566063dSJacob Faibussowitsch       PetscCall(PetscPrintf(comm, "Error ||x-x_e||_1 %8.4e  ||x-x_e||_sup %8.4e\n", (double)nrm1, (double)nrmsup));
1409c4762a1bSJed Brown     }
1410c4762a1bSJed Brown   }
1411c4762a1bSJed Brown 
14129566063dSJacob Faibussowitsch   PetscCall(SolutionStatsView(da, X, PETSC_VIEWER_STDOUT_WORLD));
14139566063dSJacob Faibussowitsch   if (draw & 0x1) PetscCall(VecView(X0, PETSC_VIEWER_DRAW_WORLD));
14149566063dSJacob Faibussowitsch   if (draw & 0x2) PetscCall(VecView(X, PETSC_VIEWER_DRAW_WORLD));
1415c4762a1bSJed Brown   if (draw & 0x4) {
1416c4762a1bSJed Brown     Vec Y;
14179566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(X, &Y));
14189566063dSJacob Faibussowitsch     PetscCall(FVSample(&ctx, da, ptime, Y));
14199566063dSJacob Faibussowitsch     PetscCall(VecAYPX(Y, -1, X));
14209566063dSJacob Faibussowitsch     PetscCall(VecView(Y, PETSC_VIEWER_DRAW_WORLD));
14219566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&Y));
1422c4762a1bSJed Brown   }
1423c4762a1bSJed Brown 
1424c4762a1bSJed Brown   if (view_final) {
1425c4762a1bSJed Brown     PetscViewer viewer;
14269566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIOpen(PETSC_COMM_WORLD, final_fname, &viewer));
14279566063dSJacob Faibussowitsch     PetscCall(PetscViewerPushFormat(viewer, PETSC_VIEWER_ASCII_MATLAB));
14289566063dSJacob Faibussowitsch     PetscCall(VecView(X, viewer));
14299566063dSJacob Faibussowitsch     PetscCall(PetscViewerPopFormat(viewer));
14309566063dSJacob Faibussowitsch     PetscCall(PetscViewerDestroy(&viewer));
1431c4762a1bSJed Brown   }
1432c4762a1bSJed Brown 
1433c4762a1bSJed Brown   /* Clean up */
14349566063dSJacob Faibussowitsch   PetscCall((*ctx.physics.destroy)(ctx.physics.user));
14359566063dSJacob Faibussowitsch   for (i = 0; i < ctx.physics.dof; i++) PetscCall(PetscFree(ctx.physics.fieldname[i]));
14369566063dSJacob Faibussowitsch   PetscCall(PetscFree4(ctx.R, ctx.Rinv, ctx.cjmpLR, ctx.cslope));
14379566063dSJacob Faibussowitsch   PetscCall(PetscFree3(ctx.uLR, ctx.flux, ctx.speeds));
14389566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&X));
14399566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&X0));
14409566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&R));
14419566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
14429566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&da));
14439566063dSJacob Faibussowitsch   PetscCall(TSDestroy(&ts));
14449566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&limiters));
14459566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListDestroy(&physics));
14469566063dSJacob Faibussowitsch   PetscCall(PetscFinalize());
1447b122ec5aSJacob Faibussowitsch   return 0;
1448c4762a1bSJed Brown }
1449c4762a1bSJed Brown 
1450c4762a1bSJed Brown /*TEST
1451c4762a1bSJed Brown 
1452c4762a1bSJed Brown     build:
1453f56ea12dSJed Brown       requires: !complex
1454c4762a1bSJed Brown 
1455c4762a1bSJed Brown     test:
1456c4762a1bSJed Brown       args: -da_grid_x 100 -initial 1 -xmin -2 -xmax 5 -exact -limit mc
1457c4762a1bSJed Brown       requires: !complex !single
1458c4762a1bSJed Brown 
1459c4762a1bSJed Brown     test:
1460c4762a1bSJed Brown       suffix: 2
1461c4762a1bSJed Brown       args: -da_grid_x 100 -initial 2 -xmin -2 -xmax 2 -exact -limit mc -physics burgers -bc_type outflow -ts_max_time 1
1462c4762a1bSJed Brown       filter:  sed "s/at 48/at 0/g"
1463c4762a1bSJed Brown       requires: !complex !single
1464c4762a1bSJed Brown 
1465c4762a1bSJed Brown     test:
1466c4762a1bSJed Brown       suffix: 3
1467c4762a1bSJed Brown       args: -da_grid_x 100 -initial 2 -xmin -2 -xmax 2 -exact -limit mc -physics burgers -bc_type outflow -ts_max_time 1
1468c4762a1bSJed Brown       nsize: 3
1469c4762a1bSJed Brown       filter:  sed "s/at 48/at 0/g"
1470c4762a1bSJed Brown       requires: !complex !single
1471c4762a1bSJed Brown 
1472c4762a1bSJed Brown TEST*/
1473