xref: /petsc/src/ts/tutorials/ex9.c (revision 5f80ce2ab25dff0f4601e710601cbbcecf323266)
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 
409fbee547SJacob Faibussowitsch static inline PetscReal Sgn(PetscReal a) { return (a<0) ? -1 : 1; }
419fbee547SJacob Faibussowitsch static inline PetscReal Abs(PetscReal a) { return (a<0) ? 0 : a; }
429fbee547SJacob Faibussowitsch static inline PetscReal Sqr(PetscReal a) { return a*a; }
439fbee547SJacob Faibussowitsch static inline PetscReal MaxAbs(PetscReal a,PetscReal b) { return (PetscAbs(a) > PetscAbs(b)) ? a : b; }
449fbee547SJacob Faibussowitsch PETSC_UNUSED static inline PetscReal MinAbs(PetscReal a,PetscReal b) { return (PetscAbs(a) < PetscAbs(b)) ? a : b; }
459fbee547SJacob Faibussowitsch static inline PetscReal MinMod2(PetscReal a,PetscReal b) { return (a*b<0) ? 0 : Sgn(a)*PetscMin(PetscAbs(a),PetscAbs(b)); }
469fbee547SJacob Faibussowitsch static inline PetscReal MaxMod2(PetscReal a,PetscReal b) { return (a*b<0) ? 0 : Sgn(a)*PetscMax(PetscAbs(a),PetscAbs(b)); }
479fbee547SJacob Faibussowitsch static inline PetscReal MinMod3(PetscReal a,PetscReal b,PetscReal c) {return (a*b<0 || a*c<0) ? 0 : Sgn(a)*PetscMin(PetscAbs(a),PetscMin(PetscAbs(b),PetscAbs(c))); }
48c4762a1bSJed Brown 
499fbee547SJacob Faibussowitsch static inline PetscReal RangeMod(PetscReal a,PetscReal xmin,PetscReal xmax) { PetscReal range = xmax-xmin; return xmin +PetscFmodReal(range+PetscFmodReal(a,range),range); }
50c4762a1bSJed Brown 
51c4762a1bSJed Brown /* ----------------------- Lots of limiters, these could go in a separate library ------------------------- */
52c4762a1bSJed Brown typedef struct _LimitInfo {
53c4762a1bSJed Brown   PetscReal hx;
54c4762a1bSJed Brown   PetscInt  m;
55c4762a1bSJed Brown } *LimitInfo;
56c4762a1bSJed Brown static void Limit_Upwind(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
57c4762a1bSJed Brown {
58c4762a1bSJed Brown   PetscInt i;
59c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = 0;
60c4762a1bSJed Brown }
61c4762a1bSJed Brown static void Limit_LaxWendroff(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
62c4762a1bSJed Brown {
63c4762a1bSJed Brown   PetscInt i;
64c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = jR[i];
65c4762a1bSJed Brown }
66c4762a1bSJed Brown static void Limit_BeamWarming(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
67c4762a1bSJed Brown {
68c4762a1bSJed Brown   PetscInt i;
69c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = jL[i];
70c4762a1bSJed Brown }
71c4762a1bSJed Brown static void Limit_Fromm(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
72c4762a1bSJed Brown {
73c4762a1bSJed Brown   PetscInt i;
74c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = 0.5*(jL[i] + jR[i]);
75c4762a1bSJed Brown }
76c4762a1bSJed Brown static void Limit_Minmod(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
77c4762a1bSJed Brown {
78c4762a1bSJed Brown   PetscInt i;
79c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = MinMod2(jL[i],jR[i]);
80c4762a1bSJed Brown }
81c4762a1bSJed Brown static void Limit_Superbee(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
82c4762a1bSJed Brown {
83c4762a1bSJed Brown   PetscInt i;
84c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = MaxMod2(MinMod2(jL[i],2*jR[i]),MinMod2(2*jL[i],jR[i]));
85c4762a1bSJed Brown }
86c4762a1bSJed Brown static void Limit_MC(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
87c4762a1bSJed Brown {
88c4762a1bSJed Brown   PetscInt i;
89c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = MinMod3(2*jL[i],0.5*(jL[i]+jR[i]),2*jR[i]);
90c4762a1bSJed Brown }
91c4762a1bSJed Brown static void Limit_VanLeer(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
92c4762a1bSJed Brown { /* phi = (t + abs(t)) / (1 + abs(t)) */
93c4762a1bSJed Brown   PetscInt i;
94c4762a1bSJed 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);
95c4762a1bSJed Brown }
96c4762a1bSJed Brown static void Limit_VanAlbada(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt) /* differentiable */
97c4762a1bSJed Brown { /* phi = (t + t^2) / (1 + t^2) */
98c4762a1bSJed Brown   PetscInt i;
99c4762a1bSJed 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);
100c4762a1bSJed Brown }
101c4762a1bSJed Brown static void Limit_VanAlbadaTVD(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
102c4762a1bSJed Brown { /* phi = (t + t^2) / (1 + t^2) */
103c4762a1bSJed Brown   PetscInt i;
104c4762a1bSJed 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);
105c4762a1bSJed Brown }
106c4762a1bSJed Brown static void Limit_Koren(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt) /* differentiable */
107c4762a1bSJed Brown { /* phi = (t + 2*t^2) / (2 - t + 2*t^2) */
108c4762a1bSJed Brown   PetscInt i;
109c4762a1bSJed 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));
110c4762a1bSJed Brown }
111c4762a1bSJed Brown static void Limit_KorenSym(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt) /* differentiable */
112c4762a1bSJed Brown { /* Symmetric version of above */
113c4762a1bSJed Brown   PetscInt i;
114c4762a1bSJed 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));
115c4762a1bSJed Brown }
116c4762a1bSJed Brown static void Limit_Koren3(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
117c4762a1bSJed Brown { /* Eq 11 of Cada-Torrilhon 2009 */
118c4762a1bSJed Brown   PetscInt i;
119c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = MinMod3(2*jL[i],(jL[i]+2*jR[i])/3,2*jR[i]);
120c4762a1bSJed Brown }
121c4762a1bSJed Brown static PetscReal CadaTorrilhonPhiHatR_Eq13(PetscReal L,PetscReal R)
122c4762a1bSJed Brown {
123c4762a1bSJed Brown   return PetscMax(0,PetscMin((L+2*R)/3,PetscMax(-0.5*L,PetscMin(2*L,PetscMin((L+2*R)/3,1.6*R)))));
124c4762a1bSJed Brown }
125c4762a1bSJed Brown static void Limit_CadaTorrilhon2(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
126c4762a1bSJed Brown { /* Cada-Torrilhon 2009, Eq 13 */
127c4762a1bSJed Brown   PetscInt i;
128c4762a1bSJed Brown   for (i=0; i<info->m; i++) lmt[i] = CadaTorrilhonPhiHatR_Eq13(jL[i],jR[i]);
129c4762a1bSJed Brown }
130c4762a1bSJed Brown static void Limit_CadaTorrilhon3R(PetscReal r,LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
131c4762a1bSJed Brown { /* Cada-Torrilhon 2009, Eq 22 */
132c4762a1bSJed Brown   /* They recommend 0.001 < r < 1, but larger values are more accurate in smooth regions */
133c4762a1bSJed Brown   const PetscReal eps = 1e-7,hx = info->hx;
134c4762a1bSJed Brown   PetscInt        i;
135c4762a1bSJed Brown   for (i=0; i<info->m; i++) {
136c4762a1bSJed Brown     const PetscReal eta = (Sqr(jL[i]) + Sqr(jR[i])) / Sqr(r*hx);
137c4762a1bSJed 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]))));
138c4762a1bSJed Brown   }
139c4762a1bSJed Brown }
140c4762a1bSJed Brown static void Limit_CadaTorrilhon3R0p1(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
141c4762a1bSJed Brown {
142c4762a1bSJed Brown   Limit_CadaTorrilhon3R(0.1,info,jL,jR,lmt);
143c4762a1bSJed Brown }
144c4762a1bSJed Brown static void Limit_CadaTorrilhon3R1(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
145c4762a1bSJed Brown {
146c4762a1bSJed Brown   Limit_CadaTorrilhon3R(1,info,jL,jR,lmt);
147c4762a1bSJed Brown }
148c4762a1bSJed Brown static void Limit_CadaTorrilhon3R10(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
149c4762a1bSJed Brown {
150c4762a1bSJed Brown   Limit_CadaTorrilhon3R(10,info,jL,jR,lmt);
151c4762a1bSJed Brown }
152c4762a1bSJed Brown static void Limit_CadaTorrilhon3R100(LimitInfo info,const PetscScalar *jL,const PetscScalar *jR,PetscScalar *lmt)
153c4762a1bSJed Brown {
154c4762a1bSJed Brown   Limit_CadaTorrilhon3R(100,info,jL,jR,lmt);
155c4762a1bSJed Brown }
156c4762a1bSJed Brown 
157c4762a1bSJed Brown /* --------------------------------- Finite Volume data structures ----------------------------------- */
158c4762a1bSJed Brown 
159c4762a1bSJed Brown typedef enum {FVBC_PERIODIC, FVBC_OUTFLOW} FVBCType;
160c4762a1bSJed Brown static const char *FVBCTypes[] = {"PERIODIC","OUTFLOW","FVBCType","FVBC_",0};
161c4762a1bSJed Brown typedef PetscErrorCode (*RiemannFunction)(void*,PetscInt,const PetscScalar*,const PetscScalar*,PetscScalar*,PetscReal*);
162c4762a1bSJed Brown typedef PetscErrorCode (*ReconstructFunction)(void*,PetscInt,const PetscScalar*,PetscScalar*,PetscScalar*,PetscReal*);
163c4762a1bSJed Brown 
164c4762a1bSJed Brown typedef struct {
165c4762a1bSJed Brown   PetscErrorCode      (*sample)(void*,PetscInt,FVBCType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal*);
166c4762a1bSJed Brown   RiemannFunction     riemann;
167c4762a1bSJed Brown   ReconstructFunction characteristic;
168c4762a1bSJed Brown   PetscErrorCode      (*destroy)(void*);
169c4762a1bSJed Brown   void                *user;
170c4762a1bSJed Brown   PetscInt            dof;
171c4762a1bSJed Brown   char                *fieldname[16];
172c4762a1bSJed Brown } PhysicsCtx;
173c4762a1bSJed Brown 
174c4762a1bSJed Brown typedef struct {
175c4762a1bSJed Brown   void        (*limit)(LimitInfo,const PetscScalar*,const PetscScalar*,PetscScalar*);
176c4762a1bSJed Brown   PhysicsCtx  physics;
177c4762a1bSJed Brown   MPI_Comm    comm;
178c4762a1bSJed Brown   char        prefix[256];
179c4762a1bSJed Brown 
180c4762a1bSJed Brown   /* Local work arrays */
181c4762a1bSJed Brown   PetscScalar *R,*Rinv;         /* Characteristic basis, and it's inverse.  COLUMN-MAJOR */
182c4762a1bSJed Brown   PetscScalar *cjmpLR;          /* Jumps at left and right edge of cell, in characteristic basis, len=2*dof */
183c4762a1bSJed Brown   PetscScalar *cslope;          /* Limited slope, written in characteristic basis */
184c4762a1bSJed Brown   PetscScalar *uLR;             /* Solution at left and right of interface, conservative variables, len=2*dof */
185c4762a1bSJed Brown   PetscScalar *flux;            /* Flux across interface */
186c4762a1bSJed Brown   PetscReal   *speeds;          /* Speeds of each wave */
187c4762a1bSJed Brown 
188c4762a1bSJed Brown   PetscReal   cfl_idt;            /* Max allowable value of 1/Delta t */
189c4762a1bSJed Brown   PetscReal   cfl;
190c4762a1bSJed Brown   PetscReal   xmin,xmax;
191c4762a1bSJed Brown   PetscInt    initial;
192c4762a1bSJed Brown   PetscBool   exact;
193c4762a1bSJed Brown   FVBCType    bctype;
194c4762a1bSJed Brown } FVCtx;
195c4762a1bSJed Brown 
196c4762a1bSJed Brown PetscErrorCode RiemannListAdd(PetscFunctionList *flist,const char *name,RiemannFunction rsolve)
197c4762a1bSJed Brown {
198c4762a1bSJed Brown   PetscFunctionBeginUser;
199*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(flist,name,rsolve));
200c4762a1bSJed Brown   PetscFunctionReturn(0);
201c4762a1bSJed Brown }
202c4762a1bSJed Brown 
203c4762a1bSJed Brown PetscErrorCode RiemannListFind(PetscFunctionList flist,const char *name,RiemannFunction *rsolve)
204c4762a1bSJed Brown {
205c4762a1bSJed Brown   PetscFunctionBeginUser;
206*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListFind(flist,name,rsolve));
2073c633725SBarry Smith   PetscCheck(*rsolve,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Riemann solver \"%s\" could not be found",name);
208c4762a1bSJed Brown   PetscFunctionReturn(0);
209c4762a1bSJed Brown }
210c4762a1bSJed Brown 
211c4762a1bSJed Brown PetscErrorCode ReconstructListAdd(PetscFunctionList *flist,const char *name,ReconstructFunction r)
212c4762a1bSJed Brown {
213c4762a1bSJed Brown   PetscFunctionBeginUser;
214*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(flist,name,r));
215c4762a1bSJed Brown   PetscFunctionReturn(0);
216c4762a1bSJed Brown }
217c4762a1bSJed Brown 
218c4762a1bSJed Brown PetscErrorCode ReconstructListFind(PetscFunctionList flist,const char *name,ReconstructFunction *r)
219c4762a1bSJed Brown {
220c4762a1bSJed Brown   PetscFunctionBeginUser;
221*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListFind(flist,name,r));
2223c633725SBarry Smith   PetscCheck(*r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Reconstruction \"%s\" could not be found",name);
223c4762a1bSJed Brown   PetscFunctionReturn(0);
224c4762a1bSJed Brown }
225c4762a1bSJed Brown 
226c4762a1bSJed Brown /* --------------------------------- Physics ----------------------------------- */
2270e3d61c9SBarry Smith /*
2280e3d61c9SBarry Smith   Each physical model consists of Riemann solver and a function to determine the basis to use for reconstruction.  These
2290e3d61c9SBarry Smith   are set with the PhysicsCreate_XXX function which allocates private storage and sets these methods as well as the
2300e3d61c9SBarry Smith   number of fields and their names, and a function to deallocate private storage.
2310e3d61c9SBarry Smith */
232c4762a1bSJed Brown 
233c4762a1bSJed Brown /* First a few functions useful to several different physics */
234c4762a1bSJed Brown static PetscErrorCode PhysicsCharacteristic_Conservative(void *vctx,PetscInt m,const PetscScalar *u,PetscScalar *X,PetscScalar *Xi,PetscReal *speeds)
235c4762a1bSJed Brown {
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 
246c4762a1bSJed Brown static PetscErrorCode PhysicsDestroy_SimpleFree(void *vctx)
247c4762a1bSJed Brown {
248c4762a1bSJed Brown   PetscFunctionBeginUser;
249*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(vctx));
250c4762a1bSJed Brown   PetscFunctionReturn(0);
251c4762a1bSJed Brown }
252c4762a1bSJed Brown 
253c4762a1bSJed Brown /* --------------------------------- Advection ----------------------------------- */
254c4762a1bSJed Brown 
255c4762a1bSJed Brown typedef struct {
256c4762a1bSJed Brown   PetscReal a;                  /* advective velocity */
257c4762a1bSJed Brown } AdvectCtx;
258c4762a1bSJed Brown 
259c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Advect(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
260c4762a1bSJed Brown {
261c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx*)vctx;
262c4762a1bSJed Brown   PetscReal speed;
263c4762a1bSJed Brown 
264c4762a1bSJed Brown   PetscFunctionBeginUser;
265c4762a1bSJed Brown   speed     = ctx->a;
266c4762a1bSJed Brown   flux[0]   = PetscMax(0,speed)*uL[0] + PetscMin(0,speed)*uR[0];
267c4762a1bSJed Brown   *maxspeed = speed;
268c4762a1bSJed Brown   PetscFunctionReturn(0);
269c4762a1bSJed Brown }
270c4762a1bSJed Brown 
271c4762a1bSJed Brown static PetscErrorCode PhysicsCharacteristic_Advect(void *vctx,PetscInt m,const PetscScalar *u,PetscScalar *X,PetscScalar *Xi,PetscReal *speeds)
272c4762a1bSJed Brown {
273c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx*)vctx;
274c4762a1bSJed Brown 
275c4762a1bSJed Brown   PetscFunctionBeginUser;
276c4762a1bSJed Brown   X[0]      = 1.;
277c4762a1bSJed Brown   Xi[0]     = 1.;
278c4762a1bSJed Brown   speeds[0] = ctx->a;
279c4762a1bSJed Brown   PetscFunctionReturn(0);
280c4762a1bSJed Brown }
281c4762a1bSJed Brown 
282c4762a1bSJed Brown static PetscErrorCode PhysicsSample_Advect(void *vctx,PetscInt initial,FVBCType bctype,PetscReal xmin,PetscReal xmax,PetscReal t,PetscReal x,PetscReal *u)
283c4762a1bSJed Brown {
284c4762a1bSJed Brown   AdvectCtx *ctx = (AdvectCtx*)vctx;
285c4762a1bSJed Brown   PetscReal a    = ctx->a,x0;
286c4762a1bSJed Brown 
287c4762a1bSJed Brown   PetscFunctionBeginUser;
288c4762a1bSJed Brown   switch (bctype) {
289c4762a1bSJed Brown     case FVBC_OUTFLOW:   x0 = x-a*t; break;
290c4762a1bSJed Brown     case FVBC_PERIODIC: x0 = RangeMod(x-a*t,xmin,xmax); break;
291c4762a1bSJed Brown     default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown BCType");
292c4762a1bSJed Brown   }
293c4762a1bSJed Brown   switch (initial) {
294c4762a1bSJed Brown     case 0: u[0] = (x0 < 0) ? 1 : -1; break;
295c4762a1bSJed Brown     case 1: u[0] = (x0 < 0) ? -1 : 1; break;
296c4762a1bSJed Brown     case 2: u[0] = (0 < x0 && x0 < 1) ? 1 : 0; break;
297c4762a1bSJed Brown     case 3: u[0] = PetscSinReal(2*PETSC_PI*x0); break;
298c4762a1bSJed Brown     case 4: u[0] = PetscAbs(x0); break;
299c4762a1bSJed Brown     case 5: u[0] = (x0 < 0 || x0 > 0.5) ? 0 : PetscSqr(PetscSinReal(2*PETSC_PI*x0)); break;
300c4762a1bSJed Brown     case 6: u[0] = (x0 < 0) ? 0 : ((x0 < 1) ? x0 : ((x0 < 2) ? 2-x0 : 0)); break;
301c4762a1bSJed Brown     case 7: u[0] = PetscPowReal(PetscSinReal(PETSC_PI*x0),10.0);break;
302c4762a1bSJed Brown     default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown initial condition");
303c4762a1bSJed Brown   }
304c4762a1bSJed Brown   PetscFunctionReturn(0);
305c4762a1bSJed Brown }
306c4762a1bSJed Brown 
307c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_Advect(FVCtx *ctx)
308c4762a1bSJed Brown {
309c4762a1bSJed Brown   PetscErrorCode ierr;
310c4762a1bSJed Brown   AdvectCtx      *user;
311c4762a1bSJed Brown 
312c4762a1bSJed Brown   PetscFunctionBeginUser;
313*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
314c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Advect;
315c4762a1bSJed Brown   ctx->physics.riemann        = PhysicsRiemann_Advect;
316c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Advect;
317c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
318c4762a1bSJed Brown   ctx->physics.user           = user;
319c4762a1bSJed Brown   ctx->physics.dof            = 1;
320*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("u",&ctx->physics.fieldname[0]));
321c4762a1bSJed Brown   user->a = 1;
322c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for advection","");CHKERRQ(ierr);
323c4762a1bSJed Brown   {
324*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_advect_a","Speed","",user->a,&user->a,NULL));
325c4762a1bSJed Brown   }
326c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
327c4762a1bSJed Brown   PetscFunctionReturn(0);
328c4762a1bSJed Brown }
329c4762a1bSJed Brown 
330c4762a1bSJed Brown /* --------------------------------- Burgers ----------------------------------- */
331c4762a1bSJed Brown 
332c4762a1bSJed Brown typedef struct {
333c4762a1bSJed Brown   PetscReal lxf_speed;
334c4762a1bSJed Brown } BurgersCtx;
335c4762a1bSJed Brown 
336c4762a1bSJed Brown static PetscErrorCode PhysicsSample_Burgers(void *vctx,PetscInt initial,FVBCType bctype,PetscReal xmin,PetscReal xmax,PetscReal t,PetscReal x,PetscReal *u)
337c4762a1bSJed Brown {
338c4762a1bSJed Brown   PetscFunctionBeginUser;
3393c633725SBarry Smith   PetscCheck(bctype != FVBC_PERIODIC || t <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Exact solution not implemented for periodic");
340c4762a1bSJed Brown   switch (initial) {
341c4762a1bSJed Brown     case 0: u[0] = (x < 0) ? 1 : -1; break;
342c4762a1bSJed Brown     case 1:
343c4762a1bSJed Brown       if       (x < -t) u[0] = -1;
344c4762a1bSJed Brown       else if  (x < t)  u[0] = x/t;
345c4762a1bSJed Brown       else              u[0] = 1;
346c4762a1bSJed Brown       break;
347c4762a1bSJed Brown     case 2:
3480912c85aSBarry Smith       if      (x <= 0)      u[0] = 0;
3490912c85aSBarry Smith       else if (x < t)       u[0] = x/t;
350c4762a1bSJed Brown       else if (x < 1+0.5*t) u[0] = 1;
351c4762a1bSJed Brown       else                  u[0] = 0;
352c4762a1bSJed Brown       break;
353c4762a1bSJed Brown     case 3:
354c4762a1bSJed Brown       if       (x < 0.2*t) u[0] = 0.2;
355c4762a1bSJed Brown       else if  (x < t) u[0] = x/t;
356c4762a1bSJed Brown       else             u[0] = 1;
357c4762a1bSJed Brown       break;
358c4762a1bSJed Brown     case 4:
3593c633725SBarry Smith       PetscCheck(t <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Only initial condition available");
360c4762a1bSJed Brown       u[0] = 0.7 + 0.3*PetscSinReal(2*PETSC_PI*((x-xmin)/(xmax-xmin)));
361c4762a1bSJed Brown       break;
362c4762a1bSJed Brown     case 5:                     /* Pure shock solution */
363c4762a1bSJed Brown       if (x < 0.5*t) u[0] = 1;
364c4762a1bSJed Brown       else u[0] = 0;
365c4762a1bSJed Brown       break;
366c4762a1bSJed Brown     default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown initial condition");
367c4762a1bSJed Brown   }
368c4762a1bSJed Brown   PetscFunctionReturn(0);
369c4762a1bSJed Brown }
370c4762a1bSJed Brown 
371c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Burgers_Exact(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
372c4762a1bSJed Brown {
373c4762a1bSJed Brown   PetscFunctionBeginUser;
374c4762a1bSJed Brown   if (uL[0] < uR[0]) {          /* rarefaction */
375c4762a1bSJed Brown     flux[0] = (uL[0]*uR[0] < 0)
376c4762a1bSJed Brown       ? 0                       /* sonic rarefaction */
377c4762a1bSJed Brown       : 0.5*PetscMin(PetscSqr(uL[0]),PetscSqr(uR[0]));
378c4762a1bSJed Brown   } else {                      /* shock */
379c4762a1bSJed Brown     flux[0] = 0.5*PetscMax(PetscSqr(uL[0]),PetscSqr(uR[0]));
380c4762a1bSJed Brown   }
381c4762a1bSJed Brown   *maxspeed = (PetscAbs(uL[0]) > PetscAbs(uR[0])) ? uL[0] : uR[0];
382c4762a1bSJed Brown   PetscFunctionReturn(0);
383c4762a1bSJed Brown }
384c4762a1bSJed Brown 
385c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Burgers_Roe(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
386c4762a1bSJed Brown {
387c4762a1bSJed Brown   PetscReal speed;
388c4762a1bSJed Brown 
389c4762a1bSJed Brown   PetscFunctionBeginUser;
390c4762a1bSJed Brown   speed   = 0.5*(uL[0] + uR[0]);
391c4762a1bSJed Brown   flux[0] = 0.25*(PetscSqr(uL[0]) + PetscSqr(uR[0])) - 0.5*PetscAbs(speed)*(uR[0]-uL[0]);
392c4762a1bSJed Brown   if (uL[0] <= 0 && 0 <= uR[0]) flux[0] = 0; /* Entropy fix for sonic rarefaction */
393c4762a1bSJed Brown   *maxspeed = speed;
394c4762a1bSJed Brown   PetscFunctionReturn(0);
395c4762a1bSJed Brown }
396c4762a1bSJed Brown 
397c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Burgers_LxF(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
398c4762a1bSJed Brown {
399c4762a1bSJed Brown   PetscReal   c;
400c4762a1bSJed Brown   PetscScalar fL,fR;
401c4762a1bSJed Brown 
402c4762a1bSJed Brown   PetscFunctionBeginUser;
403c4762a1bSJed Brown   c         = ((BurgersCtx*)vctx)->lxf_speed;
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 
411c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Burgers_Rusanov(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
412c4762a1bSJed Brown {
413c4762a1bSJed Brown   PetscReal   c;
414c4762a1bSJed Brown   PetscScalar fL,fR;
415c4762a1bSJed Brown 
416c4762a1bSJed Brown   PetscFunctionBeginUser;
417c4762a1bSJed Brown   c         = PetscMax(PetscAbs(uL[0]),PetscAbs(uR[0]));
418c4762a1bSJed Brown   fL        = 0.5*PetscSqr(uL[0]);
419c4762a1bSJed Brown   fR        = 0.5*PetscSqr(uR[0]);
420c4762a1bSJed Brown   flux[0]   = 0.5*(fL + fR) - 0.5*c*(uR[0] - uL[0]);
421c4762a1bSJed Brown   *maxspeed = c;
422c4762a1bSJed Brown   PetscFunctionReturn(0);
423c4762a1bSJed Brown }
424c4762a1bSJed Brown 
425c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_Burgers(FVCtx *ctx)
426c4762a1bSJed Brown {
427c4762a1bSJed Brown   BurgersCtx        *user;
428c4762a1bSJed Brown   PetscErrorCode    ierr;
429c4762a1bSJed Brown   RiemannFunction   r;
430c4762a1bSJed Brown   PetscFunctionList rlist      = 0;
431c4762a1bSJed Brown   char              rname[256] = "exact";
432c4762a1bSJed Brown 
433c4762a1bSJed Brown   PetscFunctionBeginUser;
434*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
435c4762a1bSJed Brown 
436c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Burgers;
437c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Conservative;
438c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
439c4762a1bSJed Brown   ctx->physics.user           = user;
440c4762a1bSJed Brown   ctx->physics.dof            = 1;
441c4762a1bSJed Brown 
442*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("u",&ctx->physics.fieldname[0]));
443*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"exact",  PhysicsRiemann_Burgers_Exact));
444*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"roe",    PhysicsRiemann_Burgers_Roe));
445*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"lxf",    PhysicsRiemann_Burgers_LxF));
446*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"rusanov",PhysicsRiemann_Burgers_Rusanov));
447c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for advection","");CHKERRQ(ierr);
448c4762a1bSJed Brown   {
449*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_burgers_riemann","Riemann solver","",rlist,rname,rname,sizeof(rname),NULL));
450c4762a1bSJed Brown   }
451c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
452*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListFind(rlist,rname,&r));
453*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rlist));
454c4762a1bSJed Brown   ctx->physics.riemann = r;
455c4762a1bSJed Brown 
456c4762a1bSJed Brown   /* *
457c4762a1bSJed Brown   * Hack to deal with LxF in semi-discrete form
458c4762a1bSJed Brown   * max speed is 1 for the basic initial conditions (where |u| <= 1)
459c4762a1bSJed Brown   * */
460c4762a1bSJed Brown   if (r == PhysicsRiemann_Burgers_LxF) user->lxf_speed = 1;
461c4762a1bSJed Brown   PetscFunctionReturn(0);
462c4762a1bSJed Brown }
463c4762a1bSJed Brown 
464c4762a1bSJed Brown /* --------------------------------- Traffic ----------------------------------- */
465c4762a1bSJed Brown 
466c4762a1bSJed Brown typedef struct {
467c4762a1bSJed Brown   PetscReal lxf_speed;
468c4762a1bSJed Brown   PetscReal a;
469c4762a1bSJed Brown } TrafficCtx;
470c4762a1bSJed Brown 
4719fbee547SJacob Faibussowitsch static inline PetscScalar TrafficFlux(PetscScalar a,PetscScalar u) { return a*u*(1-u); }
472c4762a1bSJed Brown 
473c4762a1bSJed Brown static PetscErrorCode PhysicsSample_Traffic(void *vctx,PetscInt initial,FVBCType bctype,PetscReal xmin,PetscReal xmax,PetscReal t,PetscReal x,PetscReal *u)
474c4762a1bSJed Brown {
475c4762a1bSJed Brown   PetscReal a = ((TrafficCtx*)vctx)->a;
476c4762a1bSJed Brown 
477c4762a1bSJed Brown   PetscFunctionBeginUser;
4783c633725SBarry Smith   PetscCheck(bctype != FVBC_PERIODIC || t <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Exact solution not implemented for periodic");
479c4762a1bSJed Brown   switch (initial) {
480c4762a1bSJed Brown     case 0:
481c4762a1bSJed Brown       u[0] = (-a*t < x) ? 2 : 0; break;
482c4762a1bSJed Brown     case 1:
483c4762a1bSJed Brown       if      (x < PetscMin(2*a*t,0.5+a*t)) u[0] = -1;
484c4762a1bSJed Brown       else if (x < 1)                       u[0] = 0;
485c4762a1bSJed Brown       else                                  u[0] = 1;
486c4762a1bSJed Brown       break;
487c4762a1bSJed Brown     case 2:
4883c633725SBarry Smith       PetscCheck(t <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Only initial condition available");
489c4762a1bSJed Brown       u[0] = 0.7 + 0.3*PetscSinReal(2*PETSC_PI*((x-xmin)/(xmax-xmin)));
490c4762a1bSJed Brown       break;
491c4762a1bSJed Brown     default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown initial condition");
492c4762a1bSJed Brown   }
493c4762a1bSJed Brown   PetscFunctionReturn(0);
494c4762a1bSJed Brown }
495c4762a1bSJed Brown 
496c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Traffic_Exact(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
497c4762a1bSJed Brown {
498c4762a1bSJed Brown   PetscReal a = ((TrafficCtx*)vctx)->a;
499c4762a1bSJed Brown 
500c4762a1bSJed Brown   PetscFunctionBeginUser;
501c4762a1bSJed Brown   if (uL[0] < uR[0]) {
502c4762a1bSJed Brown     flux[0] = PetscMin(TrafficFlux(a,uL[0]),TrafficFlux(a,uR[0]));
503c4762a1bSJed Brown   } else {
504c4762a1bSJed Brown     flux[0] = (uR[0] < 0.5 && 0.5 < uL[0]) ? TrafficFlux(a,0.5) : PetscMax(TrafficFlux(a,uL[0]),TrafficFlux(a,uR[0]));
505c4762a1bSJed Brown   }
506c4762a1bSJed Brown   *maxspeed = a*MaxAbs(1-2*uL[0],1-2*uR[0]);
507c4762a1bSJed Brown   PetscFunctionReturn(0);
508c4762a1bSJed Brown }
509c4762a1bSJed Brown 
510c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Traffic_Roe(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
511c4762a1bSJed Brown {
512c4762a1bSJed Brown   PetscReal a = ((TrafficCtx*)vctx)->a;
513c4762a1bSJed Brown   PetscReal speed;
514c4762a1bSJed Brown 
515c4762a1bSJed Brown   PetscFunctionBeginUser;
516c4762a1bSJed Brown   speed = a*(1 - (uL[0] + uR[0]));
517c4762a1bSJed Brown   flux[0] = 0.5*(TrafficFlux(a,uL[0]) + TrafficFlux(a,uR[0])) - 0.5*PetscAbs(speed)*(uR[0]-uL[0]);
518c4762a1bSJed Brown   *maxspeed = speed;
519c4762a1bSJed Brown   PetscFunctionReturn(0);
520c4762a1bSJed Brown }
521c4762a1bSJed Brown 
522c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Traffic_LxF(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
523c4762a1bSJed Brown {
524c4762a1bSJed Brown   TrafficCtx *phys = (TrafficCtx*)vctx;
525c4762a1bSJed Brown   PetscReal  a     = phys->a;
526c4762a1bSJed Brown   PetscReal  speed;
527c4762a1bSJed Brown 
528c4762a1bSJed Brown   PetscFunctionBeginUser;
529c4762a1bSJed Brown   speed     = a*(1 - (uL[0] + uR[0]));
530c4762a1bSJed Brown   flux[0]   = 0.5*(TrafficFlux(a,uL[0]) + TrafficFlux(a,uR[0])) - 0.5*phys->lxf_speed*(uR[0]-uL[0]);
531c4762a1bSJed Brown   *maxspeed = speed;
532c4762a1bSJed Brown   PetscFunctionReturn(0);
533c4762a1bSJed Brown }
534c4762a1bSJed Brown 
535c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Traffic_Rusanov(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
536c4762a1bSJed Brown {
537c4762a1bSJed Brown   PetscReal a = ((TrafficCtx*)vctx)->a;
538c4762a1bSJed Brown   PetscReal speed;
539c4762a1bSJed Brown 
540c4762a1bSJed Brown   PetscFunctionBeginUser;
541c4762a1bSJed Brown   speed     = a*PetscMax(PetscAbs(1-2*uL[0]),PetscAbs(1-2*uR[0]));
542c4762a1bSJed Brown   flux[0]   = 0.5*(TrafficFlux(a,uL[0]) + TrafficFlux(a,uR[0])) - 0.5*speed*(uR[0]-uL[0]);
543c4762a1bSJed Brown   *maxspeed = speed;
544c4762a1bSJed Brown   PetscFunctionReturn(0);
545c4762a1bSJed Brown }
546c4762a1bSJed Brown 
547c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_Traffic(FVCtx *ctx)
548c4762a1bSJed Brown {
549c4762a1bSJed Brown   PetscErrorCode    ierr;
550c4762a1bSJed Brown   TrafficCtx        *user;
551c4762a1bSJed Brown   RiemannFunction   r;
552c4762a1bSJed Brown   PetscFunctionList rlist      = 0;
553c4762a1bSJed Brown   char              rname[256] = "exact";
554c4762a1bSJed Brown 
555c4762a1bSJed Brown   PetscFunctionBeginUser;
556*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
557c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Traffic;
558c4762a1bSJed Brown   ctx->physics.characteristic = PhysicsCharacteristic_Conservative;
559c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
560c4762a1bSJed Brown   ctx->physics.user           = user;
561c4762a1bSJed Brown   ctx->physics.dof            = 1;
562c4762a1bSJed Brown 
563*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("density",&ctx->physics.fieldname[0]));
564c4762a1bSJed Brown   user->a = 0.5;
565*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"exact",  PhysicsRiemann_Traffic_Exact));
566*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"roe",    PhysicsRiemann_Traffic_Roe));
567*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"lxf",    PhysicsRiemann_Traffic_LxF));
568*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"rusanov",PhysicsRiemann_Traffic_Rusanov));
569c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for Traffic","");CHKERRQ(ierr);
570*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_traffic_a","Flux = a*u*(1-u)","",user->a,&user->a,NULL));
571*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_traffic_riemann","Riemann solver","",rlist,rname,rname,sizeof(rname),NULL));
572c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
573c4762a1bSJed Brown 
574*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListFind(rlist,rname,&r));
575*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rlist));
576c4762a1bSJed Brown 
577c4762a1bSJed Brown   ctx->physics.riemann = r;
578c4762a1bSJed Brown 
579c4762a1bSJed Brown   /* *
580c4762a1bSJed Brown   * Hack to deal with LxF in semi-discrete form
581c4762a1bSJed Brown   * max speed is 3*a for the basic initial conditions (-1 <= u <= 2)
582c4762a1bSJed Brown   * */
583c4762a1bSJed Brown   if (r == PhysicsRiemann_Traffic_LxF) user->lxf_speed = 3*user->a;
584c4762a1bSJed Brown   PetscFunctionReturn(0);
585c4762a1bSJed Brown }
586c4762a1bSJed Brown 
587c4762a1bSJed Brown /* --------------------------------- Linear Acoustics ----------------------------------- */
588c4762a1bSJed Brown 
589c4762a1bSJed Brown /* Flux: u_t + (A u)_x
590c4762a1bSJed Brown  * z = sqrt(rho*bulk), c = sqrt(rho/bulk)
591c4762a1bSJed Brown  * Spectral decomposition: A = R * D * Rinv
592c4762a1bSJed Brown  * [    cz] = [-z   z] [-c    ] [-1/2z  1/2]
593c4762a1bSJed Brown  * [c/z   ] = [ 1   1] [     c] [ 1/2z  1/2]
594c4762a1bSJed Brown  *
595c4762a1bSJed Brown  * We decompose this into the left-traveling waves Al = R * D^- Rinv
596c4762a1bSJed Brown  * and the right-traveling waves Ar = R * D^+ * Rinv
597c4762a1bSJed Brown  * Multiplying out these expressions produces the following two matrices
598c4762a1bSJed Brown  */
599c4762a1bSJed Brown 
600c4762a1bSJed Brown typedef struct {
601c4762a1bSJed Brown   PetscReal c;                  /* speed of sound: c = sqrt(bulk/rho) */
602c4762a1bSJed Brown   PetscReal z;                  /* impedence: z = sqrt(rho*bulk) */
603c4762a1bSJed Brown } AcousticsCtx;
604c4762a1bSJed Brown 
6059fbee547SJacob Faibussowitsch PETSC_UNUSED static inline void AcousticsFlux(AcousticsCtx *ctx,const PetscScalar *u,PetscScalar *f)
606c4762a1bSJed Brown {
607c4762a1bSJed Brown   f[0] = ctx->c*ctx->z*u[1];
608c4762a1bSJed Brown   f[1] = ctx->c/ctx->z*u[0];
609c4762a1bSJed Brown }
610c4762a1bSJed Brown 
611c4762a1bSJed Brown static PetscErrorCode PhysicsCharacteristic_Acoustics(void *vctx,PetscInt m,const PetscScalar *u,PetscScalar *X,PetscScalar *Xi,PetscReal *speeds)
612c4762a1bSJed Brown {
613c4762a1bSJed Brown   AcousticsCtx *phys = (AcousticsCtx*)vctx;
614c4762a1bSJed Brown   PetscReal    z     = phys->z,c = phys->c;
615c4762a1bSJed Brown 
616c4762a1bSJed Brown   PetscFunctionBeginUser;
617c4762a1bSJed Brown   X[0*2+0]  = -z;
618c4762a1bSJed Brown   X[0*2+1]  = z;
619c4762a1bSJed Brown   X[1*2+0]  = 1;
620c4762a1bSJed Brown   X[1*2+1]  = 1;
621c4762a1bSJed Brown   Xi[0*2+0] = -1./(2*z);
622c4762a1bSJed Brown   Xi[0*2+1] = 1./2;
623c4762a1bSJed Brown   Xi[1*2+0] = 1./(2*z);
624c4762a1bSJed Brown   Xi[1*2+1] = 1./2;
625c4762a1bSJed Brown   speeds[0] = -c;
626c4762a1bSJed Brown   speeds[1] = c;
627c4762a1bSJed Brown   PetscFunctionReturn(0);
628c4762a1bSJed Brown }
629c4762a1bSJed Brown 
630c4762a1bSJed Brown static PetscErrorCode PhysicsSample_Acoustics_Initial(AcousticsCtx *phys,PetscInt initial,PetscReal xmin,PetscReal xmax,PetscReal x,PetscReal *u)
631c4762a1bSJed Brown {
632c4762a1bSJed Brown   PetscFunctionBeginUser;
633c4762a1bSJed Brown   switch (initial) {
634c4762a1bSJed Brown   case 0:
635c4762a1bSJed Brown     u[0] = (PetscAbs((x - xmin)/(xmax - xmin) - 0.2) < 0.1) ? 1 : 0.5;
636c4762a1bSJed Brown     u[1] = (PetscAbs((x - xmin)/(xmax - xmin) - 0.7) < 0.1) ? 1 : -0.5;
637c4762a1bSJed Brown     break;
638c4762a1bSJed Brown   case 1:
639c4762a1bSJed Brown     u[0] = PetscCosReal(3 * 2*PETSC_PI*x/(xmax-xmin));
640c4762a1bSJed Brown     u[1] = PetscExpReal(-PetscSqr(x - (xmax + xmin)/2) / (2*PetscSqr(0.2*(xmax - xmin)))) - 0.5;
641c4762a1bSJed Brown     break;
642c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown initial condition");
643c4762a1bSJed Brown   }
644c4762a1bSJed Brown   PetscFunctionReturn(0);
645c4762a1bSJed Brown }
646c4762a1bSJed Brown 
647c4762a1bSJed Brown static PetscErrorCode PhysicsSample_Acoustics(void *vctx,PetscInt initial,FVBCType bctype,PetscReal xmin,PetscReal xmax,PetscReal t,PetscReal x,PetscReal *u)
648c4762a1bSJed Brown {
649c4762a1bSJed Brown   AcousticsCtx   *phys = (AcousticsCtx*)vctx;
650c4762a1bSJed Brown   PetscReal      c     = phys->c;
651c4762a1bSJed Brown   PetscReal      x0a,x0b,u0a[2],u0b[2],tmp[2];
652c4762a1bSJed Brown   PetscReal      X[2][2],Xi[2][2],dummy[2];
653c4762a1bSJed Brown 
654c4762a1bSJed Brown   PetscFunctionBeginUser;
655c4762a1bSJed Brown   switch (bctype) {
656c4762a1bSJed Brown   case FVBC_OUTFLOW:
657c4762a1bSJed Brown     x0a = x+c*t;
658c4762a1bSJed Brown     x0b = x-c*t;
659c4762a1bSJed Brown     break;
660c4762a1bSJed Brown   case FVBC_PERIODIC:
661c4762a1bSJed Brown     x0a = RangeMod(x+c*t,xmin,xmax);
662c4762a1bSJed Brown     x0b = RangeMod(x-c*t,xmin,xmax);
663c4762a1bSJed Brown     break;
664c4762a1bSJed Brown   default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown BCType");
665c4762a1bSJed Brown   }
666*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PhysicsSample_Acoustics_Initial(phys,initial,xmin,xmax,x0a,u0a));
667*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PhysicsSample_Acoustics_Initial(phys,initial,xmin,xmax,x0b,u0b));
668*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PhysicsCharacteristic_Acoustics(vctx,2,u,&X[0][0],&Xi[0][0],dummy));
669c4762a1bSJed Brown   tmp[0] = Xi[0][0]*u0a[0] + Xi[0][1]*u0a[1];
670c4762a1bSJed Brown   tmp[1] = Xi[1][0]*u0b[0] + Xi[1][1]*u0b[1];
671c4762a1bSJed Brown   u[0]   = X[0][0]*tmp[0] + X[0][1]*tmp[1];
672c4762a1bSJed Brown   u[1]   = X[1][0]*tmp[0] + X[1][1]*tmp[1];
673c4762a1bSJed Brown   PetscFunctionReturn(0);
674c4762a1bSJed Brown }
675c4762a1bSJed Brown 
676c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Acoustics_Exact(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
677c4762a1bSJed Brown {
678c4762a1bSJed Brown   AcousticsCtx *phys = (AcousticsCtx*)vctx;
679c4762a1bSJed Brown   PetscReal    c     = phys->c,z = phys->z;
680c4762a1bSJed Brown   PetscReal
681c4762a1bSJed Brown     Al[2][2] = {{-c/2     , c*z/2  },
682c4762a1bSJed Brown                 {c/(2*z)  , -c/2   }}, /* Left traveling waves */
683c4762a1bSJed Brown     Ar[2][2] = {{c/2      , c*z/2  },
684c4762a1bSJed Brown                 {c/(2*z)  , c/2    }}; /* Right traveling waves */
685c4762a1bSJed Brown 
686c4762a1bSJed Brown   PetscFunctionBeginUser;
687c4762a1bSJed Brown   flux[0]   = Al[0][0]*uR[0] + Al[0][1]*uR[1] + Ar[0][0]*uL[0] + Ar[0][1]*uL[1];
688c4762a1bSJed Brown   flux[1]   = Al[1][0]*uR[0] + Al[1][1]*uR[1] + Ar[1][0]*uL[0] + Ar[1][1]*uL[1];
689c4762a1bSJed Brown   *maxspeed = c;
690c4762a1bSJed Brown   PetscFunctionReturn(0);
691c4762a1bSJed Brown }
692c4762a1bSJed Brown 
693c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_Acoustics(FVCtx *ctx)
694c4762a1bSJed Brown {
695c4762a1bSJed Brown   PetscErrorCode    ierr;
696c4762a1bSJed Brown   AcousticsCtx      *user;
697c4762a1bSJed Brown   PetscFunctionList rlist      = 0,rclist = 0;
698c4762a1bSJed Brown   char              rname[256] = "exact",rcname[256] = "characteristic";
699c4762a1bSJed Brown 
700c4762a1bSJed Brown   PetscFunctionBeginUser;
701*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
702c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_Acoustics;
703c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
704c4762a1bSJed Brown   ctx->physics.user           = user;
705c4762a1bSJed Brown   ctx->physics.dof            = 2;
706c4762a1bSJed Brown 
707*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("u",&ctx->physics.fieldname[0]));
708*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("v",&ctx->physics.fieldname[1]));
709c4762a1bSJed Brown 
710c4762a1bSJed Brown   user->c = 1;
711c4762a1bSJed Brown   user->z = 1;
712c4762a1bSJed Brown 
713*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"exact",  PhysicsRiemann_Acoustics_Exact));
714*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"characteristic",PhysicsCharacteristic_Acoustics));
715*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"conservative",PhysicsCharacteristic_Conservative));
716c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for linear Acoustics","");CHKERRQ(ierr);
717c4762a1bSJed Brown   {
718*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_acoustics_c","c = sqrt(bulk/rho)","",user->c,&user->c,NULL));
719*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_acoustics_z","z = sqrt(bulk*rho)","",user->z,&user->z,NULL));
720*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_acoustics_riemann","Riemann solver","",rlist,rname,rname,sizeof(rname),NULL));
721*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_acoustics_reconstruct","Reconstruction","",rclist,rcname,rcname,sizeof(rcname),NULL));
722c4762a1bSJed Brown   }
723c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
724*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListFind(rlist,rname,&ctx->physics.riemann));
725*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListFind(rclist,rcname,&ctx->physics.characteristic));
726*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rlist));
727*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rclist));
728c4762a1bSJed Brown   PetscFunctionReturn(0);
729c4762a1bSJed Brown }
730c4762a1bSJed Brown 
731c4762a1bSJed Brown /* --------------------------------- Isothermal Gas Dynamics ----------------------------------- */
732c4762a1bSJed Brown 
733c4762a1bSJed Brown typedef struct {
734c4762a1bSJed Brown   PetscReal acoustic_speed;
735c4762a1bSJed Brown } IsoGasCtx;
736c4762a1bSJed Brown 
7379fbee547SJacob Faibussowitsch static inline void IsoGasFlux(PetscReal c,const PetscScalar *u,PetscScalar *f)
738c4762a1bSJed Brown {
739c4762a1bSJed Brown   f[0] = u[1];
740c4762a1bSJed Brown   f[1] = PetscSqr(u[1])/u[0] + c*c*u[0];
741c4762a1bSJed Brown }
742c4762a1bSJed Brown 
743c4762a1bSJed Brown static PetscErrorCode PhysicsSample_IsoGas(void *vctx,PetscInt initial,FVBCType bctype,PetscReal xmin,PetscReal xmax,PetscReal t,PetscReal x,PetscReal *u)
744c4762a1bSJed Brown {
745c4762a1bSJed Brown   PetscFunctionBeginUser;
7463c633725SBarry Smith   PetscCheck(t <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Exact solutions not implemented for t > 0");
747c4762a1bSJed Brown   switch (initial) {
748c4762a1bSJed Brown     case 0:
749c4762a1bSJed Brown       u[0] = (x < 0) ? 1 : 0.5;
750c4762a1bSJed Brown       u[1] = (x < 0) ? 1 : 0.7;
751c4762a1bSJed Brown       break;
752c4762a1bSJed Brown     case 1:
753c4762a1bSJed Brown       u[0] = 1+0.5*PetscSinReal(2*PETSC_PI*x);
754c4762a1bSJed Brown       u[1] = 1*u[0];
755c4762a1bSJed Brown       break;
756c4762a1bSJed Brown     default: SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"unknown initial condition");
757c4762a1bSJed Brown   }
758c4762a1bSJed Brown   PetscFunctionReturn(0);
759c4762a1bSJed Brown }
760c4762a1bSJed Brown 
761c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_IsoGas_Roe(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
762c4762a1bSJed Brown {
763c4762a1bSJed Brown   IsoGasCtx   *phys = (IsoGasCtx*)vctx;
764c4762a1bSJed Brown   PetscReal   c     = phys->acoustic_speed;
765c4762a1bSJed Brown   PetscScalar ubar,du[2],a[2],fL[2],fR[2],lam[2],ustar[2],R[2][2];
766c4762a1bSJed Brown   PetscInt    i;
767c4762a1bSJed Brown 
768c4762a1bSJed Brown   PetscFunctionBeginUser;
769c4762a1bSJed Brown   ubar = (uL[1]/PetscSqrtScalar(uL[0]) + uR[1]/PetscSqrtScalar(uR[0])) / (PetscSqrtScalar(uL[0]) + PetscSqrtScalar(uR[0]));
770c4762a1bSJed Brown   /* write fluxuations in characteristic basis */
771c4762a1bSJed Brown   du[0] = uR[0] - uL[0];
772c4762a1bSJed Brown   du[1] = uR[1] - uL[1];
773c4762a1bSJed Brown   a[0]  = (1/(2*c)) * ((ubar + c)*du[0] - du[1]);
774c4762a1bSJed Brown   a[1]  = (1/(2*c)) * ((-ubar + c)*du[0] + du[1]);
775c4762a1bSJed Brown   /* wave speeds */
776c4762a1bSJed Brown   lam[0] = ubar - c;
777c4762a1bSJed Brown   lam[1] = ubar + c;
778c4762a1bSJed Brown   /* Right eigenvectors */
779c4762a1bSJed Brown   R[0][0] = 1; R[0][1] = ubar-c;
780c4762a1bSJed Brown   R[1][0] = 1; R[1][1] = ubar+c;
781c4762a1bSJed Brown   /* Compute state in star region (between the 1-wave and 2-wave) */
782c4762a1bSJed Brown   for (i=0; i<2; i++) ustar[i] = uL[i] + a[0]*R[0][i];
783c4762a1bSJed Brown   if (uL[1]/uL[0] < c && c < ustar[1]/ustar[0]) { /* 1-wave is sonic rarefaction */
784c4762a1bSJed Brown     PetscScalar ufan[2];
785c4762a1bSJed Brown     ufan[0] = uL[0]*PetscExpScalar(uL[1]/(uL[0]*c) - 1);
786c4762a1bSJed Brown     ufan[1] = c*ufan[0];
787c4762a1bSJed Brown     IsoGasFlux(c,ufan,flux);
788c4762a1bSJed Brown   } else if (ustar[1]/ustar[0] < -c && -c < uR[1]/uR[0]) { /* 2-wave is sonic rarefaction */
789c4762a1bSJed Brown     PetscScalar ufan[2];
790c4762a1bSJed Brown     ufan[0] = uR[0]*PetscExpScalar(-uR[1]/(uR[0]*c) - 1);
791c4762a1bSJed Brown     ufan[1] = -c*ufan[0];
792c4762a1bSJed Brown     IsoGasFlux(c,ufan,flux);
793c4762a1bSJed Brown   } else {                      /* Centered form */
794c4762a1bSJed Brown     IsoGasFlux(c,uL,fL);
795c4762a1bSJed Brown     IsoGasFlux(c,uR,fR);
796c4762a1bSJed Brown     for (i=0; i<2; i++) {
797c4762a1bSJed Brown       PetscScalar absdu = PetscAbsScalar(lam[0])*a[0]*R[0][i] + PetscAbsScalar(lam[1])*a[1]*R[1][i];
798c4762a1bSJed Brown       flux[i] = 0.5*(fL[i]+fR[i]) - 0.5*absdu;
799c4762a1bSJed Brown     }
800c4762a1bSJed Brown   }
801c4762a1bSJed Brown   *maxspeed = MaxAbs(lam[0],lam[1]);
802c4762a1bSJed Brown   PetscFunctionReturn(0);
803c4762a1bSJed Brown }
804c4762a1bSJed Brown 
805c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_IsoGas_Exact(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
806c4762a1bSJed Brown {
807c4762a1bSJed Brown   IsoGasCtx                   *phys = (IsoGasCtx*)vctx;
808c4762a1bSJed Brown   PetscReal                   c     = phys->acoustic_speed;
809c4762a1bSJed Brown   PetscScalar                 ustar[2];
810c4762a1bSJed Brown   struct {PetscScalar rho,u;} L = {uL[0],uL[1]/uL[0]},R = {uR[0],uR[1]/uR[0]},star;
811c4762a1bSJed Brown   PetscInt                    i;
812c4762a1bSJed Brown 
813c4762a1bSJed Brown   PetscFunctionBeginUser;
8143c633725SBarry Smith   PetscCheck((L.rho > 0 && R.rho > 0),PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Reconstructed density is negative");
815c4762a1bSJed Brown   {
816c4762a1bSJed Brown     /* Solve for star state */
817c4762a1bSJed Brown     PetscScalar res,tmp,rho = 0.5*(L.rho + R.rho); /* initial guess */
818c4762a1bSJed Brown     for (i=0; i<20; i++) {
819c4762a1bSJed Brown       PetscScalar fr,fl,dfr,dfl;
820c4762a1bSJed Brown       fl = (L.rho < rho)
821c4762a1bSJed Brown         ? (rho-L.rho)/PetscSqrtScalar(L.rho*rho)       /* shock */
822c4762a1bSJed Brown         : PetscLogScalar(rho) - PetscLogScalar(L.rho); /* rarefaction */
823c4762a1bSJed Brown       fr = (R.rho < rho)
824c4762a1bSJed Brown         ? (rho-R.rho)/PetscSqrtScalar(R.rho*rho)       /* shock */
825c4762a1bSJed Brown         : PetscLogScalar(rho) - PetscLogScalar(R.rho); /* rarefaction */
826c4762a1bSJed Brown       res = R.u-L.u + c*(fr+fl);
8273c633725SBarry Smith       PetscCheck(!PetscIsInfOrNanScalar(res),PETSC_COMM_SELF,PETSC_ERR_FP,"Infinity or Not-a-Number generated in computation");
828c4762a1bSJed Brown       if (PetscAbsScalar(res) < 1e-10) {
829c4762a1bSJed Brown         star.rho = rho;
830c4762a1bSJed Brown         star.u   = L.u - c*fl;
831c4762a1bSJed Brown         goto converged;
832c4762a1bSJed Brown       }
833c4762a1bSJed Brown       dfl = (L.rho < rho) ? 1/PetscSqrtScalar(L.rho*rho)*(1 - 0.5*(rho-L.rho)/rho) : 1/rho;
834c4762a1bSJed Brown       dfr = (R.rho < rho) ? 1/PetscSqrtScalar(R.rho*rho)*(1 - 0.5*(rho-R.rho)/rho) : 1/rho;
835c4762a1bSJed Brown       tmp = rho - res/(c*(dfr+dfl));
836c4762a1bSJed Brown       if (tmp <= 0) rho /= 2;   /* Guard against Newton shooting off to a negative density */
837c4762a1bSJed Brown       else rho = tmp;
8383c633725SBarry Smith       PetscCheck(((rho > 0) && PetscIsNormalScalar(rho)),PETSC_COMM_SELF,PETSC_ERR_FP,"non-normal iterate rho=%g",(double)PetscRealPart(rho));
839c4762a1bSJed Brown     }
84098921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_CONV_FAILED,"Newton iteration for star.rho diverged after %D iterations",i);
841c4762a1bSJed Brown   }
842c4762a1bSJed Brown converged:
843c4762a1bSJed Brown   if (L.u-c < 0 && 0 < star.u-c) { /* 1-wave is sonic rarefaction */
844c4762a1bSJed Brown     PetscScalar ufan[2];
845c4762a1bSJed Brown     ufan[0] = L.rho*PetscExpScalar(L.u/c - 1);
846c4762a1bSJed Brown     ufan[1] = c*ufan[0];
847c4762a1bSJed Brown     IsoGasFlux(c,ufan,flux);
848c4762a1bSJed Brown   } else if (star.u+c < 0 && 0 < R.u+c) { /* 2-wave is sonic rarefaction */
849c4762a1bSJed Brown     PetscScalar ufan[2];
850c4762a1bSJed Brown     ufan[0] = R.rho*PetscExpScalar(-R.u/c - 1);
851c4762a1bSJed Brown     ufan[1] = -c*ufan[0];
852c4762a1bSJed Brown     IsoGasFlux(c,ufan,flux);
853c4762a1bSJed 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)) {
854c4762a1bSJed Brown     /* 1-wave is supersonic rarefaction, or supersonic shock */
855c4762a1bSJed Brown     IsoGasFlux(c,uL,flux);
856c4762a1bSJed 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)) {
857c4762a1bSJed Brown     /* 2-wave is supersonic rarefaction or supersonic shock */
858c4762a1bSJed Brown     IsoGasFlux(c,uR,flux);
859c4762a1bSJed Brown   } else {
860c4762a1bSJed Brown     ustar[0] = star.rho;
861c4762a1bSJed Brown     ustar[1] = star.rho*star.u;
862c4762a1bSJed Brown     IsoGasFlux(c,ustar,flux);
863c4762a1bSJed Brown   }
864c4762a1bSJed Brown   *maxspeed = MaxAbs(MaxAbs(star.u-c,star.u+c),MaxAbs(L.u-c,R.u+c));
865c4762a1bSJed Brown   PetscFunctionReturn(0);
866c4762a1bSJed Brown }
867c4762a1bSJed Brown 
868c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_IsoGas_Rusanov(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
869c4762a1bSJed Brown {
870c4762a1bSJed Brown   IsoGasCtx                   *phys = (IsoGasCtx*)vctx;
871c4762a1bSJed Brown   PetscScalar                 c = phys->acoustic_speed,fL[2],fR[2],s;
872c4762a1bSJed Brown   struct {PetscScalar rho,u;} L = {uL[0],uL[1]/uL[0]},R = {uR[0],uR[1]/uR[0]};
873c4762a1bSJed Brown 
874c4762a1bSJed Brown   PetscFunctionBeginUser;
8753c633725SBarry Smith   PetscCheck((L.rho > 0 && R.rho > 0),PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Reconstructed density is negative");
876c4762a1bSJed Brown   IsoGasFlux(c,uL,fL);
877c4762a1bSJed Brown   IsoGasFlux(c,uR,fR);
878c4762a1bSJed Brown   s         = PetscMax(PetscAbs(L.u),PetscAbs(R.u))+c;
879c4762a1bSJed Brown   flux[0]   = 0.5*(fL[0] + fR[0]) + 0.5*s*(uL[0] - uR[0]);
880c4762a1bSJed Brown   flux[1]   = 0.5*(fL[1] + fR[1]) + 0.5*s*(uL[1] - uR[1]);
881c4762a1bSJed Brown   *maxspeed = s;
882c4762a1bSJed Brown   PetscFunctionReturn(0);
883c4762a1bSJed Brown }
884c4762a1bSJed Brown 
885c4762a1bSJed Brown static PetscErrorCode PhysicsCharacteristic_IsoGas(void *vctx,PetscInt m,const PetscScalar *u,PetscScalar *X,PetscScalar *Xi,PetscReal *speeds)
886c4762a1bSJed Brown {
887c4762a1bSJed Brown   IsoGasCtx      *phys = (IsoGasCtx*)vctx;
888c4762a1bSJed Brown   PetscReal      c     = phys->acoustic_speed;
889c4762a1bSJed Brown 
890c4762a1bSJed Brown   PetscFunctionBeginUser;
891c4762a1bSJed Brown   speeds[0] = u[1]/u[0] - c;
892c4762a1bSJed Brown   speeds[1] = u[1]/u[0] + c;
893c4762a1bSJed Brown   X[0*2+0]  = 1;
894c4762a1bSJed Brown   X[0*2+1]  = speeds[0];
895c4762a1bSJed Brown   X[1*2+0]  = 1;
896c4762a1bSJed Brown   X[1*2+1]  = speeds[1];
897*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscArraycpy(Xi,X,4));
898*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscKernel_A_gets_inverse_A_2(Xi,0,PETSC_FALSE,NULL));
899c4762a1bSJed Brown   PetscFunctionReturn(0);
900c4762a1bSJed Brown }
901c4762a1bSJed Brown 
902c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_IsoGas(FVCtx *ctx)
903c4762a1bSJed Brown {
904c4762a1bSJed Brown   PetscErrorCode    ierr;
905c4762a1bSJed Brown   IsoGasCtx         *user;
906c4762a1bSJed Brown   PetscFunctionList rlist = 0,rclist = 0;
907c4762a1bSJed Brown   char              rname[256] = "exact",rcname[256] = "characteristic";
908c4762a1bSJed Brown 
909c4762a1bSJed Brown   PetscFunctionBeginUser;
910*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
911c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_IsoGas;
912c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
913c4762a1bSJed Brown   ctx->physics.user           = user;
914c4762a1bSJed Brown   ctx->physics.dof            = 2;
915c4762a1bSJed Brown 
916*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("density",&ctx->physics.fieldname[0]));
917*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("momentum",&ctx->physics.fieldname[1]));
918c4762a1bSJed Brown 
919c4762a1bSJed Brown   user->acoustic_speed = 1;
920c4762a1bSJed Brown 
921*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"exact",  PhysicsRiemann_IsoGas_Exact));
922*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"roe",    PhysicsRiemann_IsoGas_Roe));
923*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"rusanov",PhysicsRiemann_IsoGas_Rusanov));
924*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"characteristic",PhysicsCharacteristic_IsoGas));
925*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"conservative",PhysicsCharacteristic_Conservative));
926c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for IsoGas","");CHKERRQ(ierr);
927*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_isogas_acoustic_speed","Acoustic speed","",user->acoustic_speed,&user->acoustic_speed,NULL));
928*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_isogas_riemann","Riemann solver","",rlist,rname,rname,sizeof(rname),NULL));
929*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_isogas_reconstruct","Reconstruction","",rclist,rcname,rcname,sizeof(rcname),NULL));
930c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
931*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListFind(rlist,rname,&ctx->physics.riemann));
932*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListFind(rclist,rcname,&ctx->physics.characteristic));
933*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rlist));
934*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rclist));
935c4762a1bSJed Brown   PetscFunctionReturn(0);
936c4762a1bSJed Brown }
937c4762a1bSJed Brown 
938c4762a1bSJed Brown /* --------------------------------- Shallow Water ----------------------------------- */
939c4762a1bSJed Brown typedef struct {
940c4762a1bSJed Brown   PetscReal gravity;
941c4762a1bSJed Brown } ShallowCtx;
942c4762a1bSJed Brown 
9439fbee547SJacob Faibussowitsch static inline void ShallowFlux(ShallowCtx *phys,const PetscScalar *u,PetscScalar *f)
944c4762a1bSJed Brown {
945c4762a1bSJed Brown   f[0] = u[1];
946c4762a1bSJed Brown   f[1] = PetscSqr(u[1])/u[0] + 0.5*phys->gravity*PetscSqr(u[0]);
947c4762a1bSJed Brown }
948c4762a1bSJed Brown 
949c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Shallow_Exact(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
950c4762a1bSJed Brown {
951c4762a1bSJed Brown   ShallowCtx                *phys = (ShallowCtx*)vctx;
952c4762a1bSJed Brown   PetscScalar               g    = phys->gravity,ustar[2],cL,cR,c,cstar;
953c4762a1bSJed Brown   struct {PetscScalar h,u;} L = {uL[0],uL[1]/uL[0]},R = {uR[0],uR[1]/uR[0]},star;
954c4762a1bSJed Brown   PetscInt                  i;
955c4762a1bSJed Brown 
956c4762a1bSJed Brown   PetscFunctionBeginUser;
9573c633725SBarry Smith   PetscCheck((L.h > 0 && R.h > 0),PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Reconstructed thickness is negative");
958c4762a1bSJed Brown   cL = PetscSqrtScalar(g*L.h);
959c4762a1bSJed Brown   cR = PetscSqrtScalar(g*R.h);
960c4762a1bSJed Brown   c  = PetscMax(cL,cR);
961c4762a1bSJed Brown   {
962c4762a1bSJed Brown     /* Solve for star state */
963c4762a1bSJed Brown     const PetscInt maxits = 50;
964c4762a1bSJed Brown     PetscScalar tmp,res,res0=0,h0,h = 0.5*(L.h + R.h); /* initial guess */
965c4762a1bSJed Brown     h0 = h;
966c4762a1bSJed Brown     for (i=0; i<maxits; i++) {
967c4762a1bSJed Brown       PetscScalar fr,fl,dfr,dfl;
968c4762a1bSJed Brown       fl = (L.h < h)
969c4762a1bSJed Brown         ? PetscSqrtScalar(0.5*g*(h*h - L.h*L.h)*(1/L.h - 1/h)) /* shock */
970c4762a1bSJed Brown         : 2*PetscSqrtScalar(g*h) - 2*PetscSqrtScalar(g*L.h);   /* rarefaction */
971c4762a1bSJed Brown       fr = (R.h < h)
972c4762a1bSJed Brown         ? PetscSqrtScalar(0.5*g*(h*h - R.h*R.h)*(1/R.h - 1/h)) /* shock */
973c4762a1bSJed Brown         : 2*PetscSqrtScalar(g*h) - 2*PetscSqrtScalar(g*R.h);   /* rarefaction */
974c4762a1bSJed Brown       res = R.u - L.u + fr + fl;
9753c633725SBarry Smith       PetscCheck(!PetscIsInfOrNanScalar(res),PETSC_COMM_SELF,PETSC_ERR_FP,"Infinity or Not-a-Number generated in computation");
976c4762a1bSJed Brown       if (PetscAbsScalar(res) < 1e-8 || (i > 0 && PetscAbsScalar(h-h0) < 1e-8)) {
977c4762a1bSJed Brown         star.h = h;
978c4762a1bSJed Brown         star.u = L.u - fl;
979c4762a1bSJed Brown         goto converged;
980c4762a1bSJed Brown       } else if (i > 0 && PetscAbsScalar(res) >= PetscAbsScalar(res0)) {        /* Line search */
981c4762a1bSJed Brown         h = 0.8*h0 + 0.2*h;
982c4762a1bSJed Brown         continue;
983c4762a1bSJed Brown       }
984c4762a1bSJed Brown       /* Accept the last step and take another */
985c4762a1bSJed Brown       res0 = res;
986c4762a1bSJed Brown       h0 = h;
987c4762a1bSJed 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);
988c4762a1bSJed 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);
989c4762a1bSJed Brown       tmp = h - res/(dfr+dfl);
990c4762a1bSJed Brown       if (tmp <= 0) h /= 2;   /* Guard against Newton shooting off to a negative thickness */
991c4762a1bSJed Brown       else h = tmp;
9923c633725SBarry Smith       PetscCheck(((h > 0) && PetscIsNormalScalar(h)),PETSC_COMM_SELF,PETSC_ERR_FP,"non-normal iterate h=%g",(double)h);
993c4762a1bSJed Brown     }
99498921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_CONV_FAILED,"Newton iteration for star.h diverged after %D iterations",i);
995c4762a1bSJed Brown   }
996c4762a1bSJed Brown converged:
997c4762a1bSJed Brown   cstar = PetscSqrtScalar(g*star.h);
998c4762a1bSJed Brown   if (L.u-cL < 0 && 0 < star.u-cstar) { /* 1-wave is sonic rarefaction */
999c4762a1bSJed Brown     PetscScalar ufan[2];
1000c4762a1bSJed Brown     ufan[0] = 1/g*PetscSqr(L.u/3 + 2./3*cL);
1001c4762a1bSJed Brown     ufan[1] = PetscSqrtScalar(g*ufan[0])*ufan[0];
1002c4762a1bSJed Brown     ShallowFlux(phys,ufan,flux);
1003c4762a1bSJed Brown   } else if (star.u+cstar < 0 && 0 < R.u+cR) { /* 2-wave is sonic rarefaction */
1004c4762a1bSJed Brown     PetscScalar ufan[2];
1005c4762a1bSJed Brown     ufan[0] = 1/g*PetscSqr(R.u/3 - 2./3*cR);
1006c4762a1bSJed Brown     ufan[1] = -PetscSqrtScalar(g*ufan[0])*ufan[0];
1007c4762a1bSJed Brown     ShallowFlux(phys,ufan,flux);
1008c4762a1bSJed 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)) {
1009c4762a1bSJed Brown     /* 1-wave is right-travelling shock (supersonic) */
1010c4762a1bSJed Brown     ShallowFlux(phys,uL,flux);
1011c4762a1bSJed 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)) {
1012c4762a1bSJed Brown     /* 2-wave is left-travelling shock (supersonic) */
1013c4762a1bSJed Brown     ShallowFlux(phys,uR,flux);
1014c4762a1bSJed Brown   } else {
1015c4762a1bSJed Brown     ustar[0] = star.h;
1016c4762a1bSJed Brown     ustar[1] = star.h*star.u;
1017c4762a1bSJed Brown     ShallowFlux(phys,ustar,flux);
1018c4762a1bSJed Brown   }
1019c4762a1bSJed Brown   *maxspeed = MaxAbs(MaxAbs(star.u-cstar,star.u+cstar),MaxAbs(L.u-cL,R.u+cR));
1020c4762a1bSJed Brown   PetscFunctionReturn(0);
1021c4762a1bSJed Brown }
1022c4762a1bSJed Brown 
1023c4762a1bSJed Brown static PetscErrorCode PhysicsRiemann_Shallow_Rusanov(void *vctx,PetscInt m,const PetscScalar *uL,const PetscScalar *uR,PetscScalar *flux,PetscReal *maxspeed)
1024c4762a1bSJed Brown {
1025c4762a1bSJed Brown   ShallowCtx                *phys = (ShallowCtx*)vctx;
1026c4762a1bSJed Brown   PetscScalar               g = phys->gravity,fL[2],fR[2],s;
1027c4762a1bSJed Brown   struct {PetscScalar h,u;} L = {uL[0],uL[1]/uL[0]},R = {uR[0],uR[1]/uR[0]};
1028c4762a1bSJed Brown 
1029c4762a1bSJed Brown   PetscFunctionBeginUser;
10303c633725SBarry Smith   PetscCheck((L.h > 0 && R.h > 0),PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Reconstructed thickness is negative");
1031c4762a1bSJed Brown   ShallowFlux(phys,uL,fL);
1032c4762a1bSJed Brown   ShallowFlux(phys,uR,fR);
1033c4762a1bSJed Brown   s         = PetscMax(PetscAbs(L.u)+PetscSqrtScalar(g*L.h),PetscAbs(R.u)+PetscSqrtScalar(g*R.h));
1034c4762a1bSJed Brown   flux[0]   = 0.5*(fL[0] + fR[0]) + 0.5*s*(uL[0] - uR[0]);
1035c4762a1bSJed Brown   flux[1]   = 0.5*(fL[1] + fR[1]) + 0.5*s*(uL[1] - uR[1]);
1036c4762a1bSJed Brown   *maxspeed = s;
1037c4762a1bSJed Brown   PetscFunctionReturn(0);
1038c4762a1bSJed Brown }
1039c4762a1bSJed Brown 
1040c4762a1bSJed Brown static PetscErrorCode PhysicsCharacteristic_Shallow(void *vctx,PetscInt m,const PetscScalar *u,PetscScalar *X,PetscScalar *Xi,PetscReal *speeds)
1041c4762a1bSJed Brown {
1042c4762a1bSJed Brown   ShallowCtx     *phys = (ShallowCtx*)vctx;
1043c4762a1bSJed Brown   PetscReal      c;
1044c4762a1bSJed Brown 
1045c4762a1bSJed Brown   PetscFunctionBeginUser;
1046c4762a1bSJed Brown   c         = PetscSqrtScalar(u[0]*phys->gravity);
1047c4762a1bSJed Brown   speeds[0] = u[1]/u[0] - c;
1048c4762a1bSJed Brown   speeds[1] = u[1]/u[0] + c;
1049c4762a1bSJed Brown   X[0*2+0]  = 1;
1050c4762a1bSJed Brown   X[0*2+1]  = speeds[0];
1051c4762a1bSJed Brown   X[1*2+0]  = 1;
1052c4762a1bSJed Brown   X[1*2+1]  = speeds[1];
1053*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscArraycpy(Xi,X,4));
1054*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscKernel_A_gets_inverse_A_2(Xi,0,PETSC_FALSE,NULL));
1055c4762a1bSJed Brown   PetscFunctionReturn(0);
1056c4762a1bSJed Brown }
1057c4762a1bSJed Brown 
1058c4762a1bSJed Brown static PetscErrorCode PhysicsCreate_Shallow(FVCtx *ctx)
1059c4762a1bSJed Brown {
1060c4762a1bSJed Brown   PetscErrorCode    ierr;
1061c4762a1bSJed Brown   ShallowCtx        *user;
1062c4762a1bSJed Brown   PetscFunctionList rlist = 0,rclist = 0;
1063c4762a1bSJed Brown   char              rname[256] = "exact",rcname[256] = "characteristic";
1064c4762a1bSJed Brown 
1065c4762a1bSJed Brown   PetscFunctionBeginUser;
1066*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscNew(&user));
1067c4762a1bSJed Brown   /* Shallow water and Isothermal Gas dynamics are similar so we reuse initial conditions for now */
1068c4762a1bSJed Brown   ctx->physics.sample         = PhysicsSample_IsoGas;
1069c4762a1bSJed Brown   ctx->physics.destroy        = PhysicsDestroy_SimpleFree;
1070c4762a1bSJed Brown   ctx->physics.user           = user;
1071c4762a1bSJed Brown   ctx->physics.dof            = 2;
1072c4762a1bSJed Brown 
1073*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("density",&ctx->physics.fieldname[0]));
1074*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrallocpy("momentum",&ctx->physics.fieldname[1]));
1075c4762a1bSJed Brown 
1076c4762a1bSJed Brown   user->gravity = 1;
1077c4762a1bSJed Brown 
1078*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"exact",  PhysicsRiemann_Shallow_Exact));
1079*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListAdd(&rlist,"rusanov",PhysicsRiemann_Shallow_Rusanov));
1080*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"characteristic",PhysicsCharacteristic_Shallow));
1081*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListAdd(&rclist,"conservative",PhysicsCharacteristic_Conservative));
1082c4762a1bSJed Brown   ierr = PetscOptionsBegin(ctx->comm,ctx->prefix,"Options for Shallow","");CHKERRQ(ierr);
1083*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-physics_shallow_gravity","Gravity","",user->gravity,&user->gravity,NULL));
1084*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_shallow_riemann","Riemann solver","",rlist,rname,rname,sizeof(rname),NULL));
1085*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics_shallow_reconstruct","Reconstruction","",rclist,rcname,rcname,sizeof(rcname),NULL));
1086c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
1087*5f80ce2aSJacob Faibussowitsch   CHKERRQ(RiemannListFind(rlist,rname,&ctx->physics.riemann));
1088*5f80ce2aSJacob Faibussowitsch   CHKERRQ(ReconstructListFind(rclist,rcname,&ctx->physics.characteristic));
1089*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rlist));
1090*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&rclist));
1091c4762a1bSJed Brown   PetscFunctionReturn(0);
1092c4762a1bSJed Brown }
1093c4762a1bSJed Brown 
1094c4762a1bSJed Brown /* --------------------------------- Finite Volume Solver ----------------------------------- */
1095c4762a1bSJed Brown 
1096c4762a1bSJed Brown static PetscErrorCode FVRHSFunction(TS ts,PetscReal time,Vec X,Vec F,void *vctx)
1097c4762a1bSJed Brown {
1098c4762a1bSJed Brown   FVCtx             *ctx = (FVCtx*)vctx;
1099c4762a1bSJed Brown   PetscInt          i,j,k,Mx,dof,xs,xm;
1100c4762a1bSJed Brown   PetscReal         hx,cfl_idt = 0;
1101c4762a1bSJed Brown   PetscScalar       *x,*f,*slope;
1102c4762a1bSJed Brown   Vec               Xloc;
1103c4762a1bSJed Brown   DM                da;
1104c4762a1bSJed Brown 
1105c4762a1bSJed Brown   PetscFunctionBeginUser;
1106*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&da));
1107*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetLocalVector(da,&Xloc));
1108*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetInfo(da,0, &Mx,0,0, 0,0,0, &dof,0,0,0,0,0));
1109c4762a1bSJed Brown   hx   = (ctx->xmax - ctx->xmin)/Mx;
1110*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGlobalToLocalBegin(da,X,INSERT_VALUES,Xloc));
1111*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGlobalToLocalEnd  (da,X,INSERT_VALUES,Xloc));
1112c4762a1bSJed Brown 
1113*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecZeroEntries(F));
1114c4762a1bSJed Brown 
1115*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecGetArray(da,Xloc,&x));
1116*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecGetArray(da,F,&f));
1117*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetArray(da,PETSC_TRUE,&slope));
1118c4762a1bSJed Brown 
1119*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetCorners(da,&xs,0,0,&xm,0,0));
1120c4762a1bSJed Brown 
1121c4762a1bSJed Brown   if (ctx->bctype == FVBC_OUTFLOW) {
1122c4762a1bSJed Brown     for (i=xs-2; i<0; i++) {
1123c4762a1bSJed Brown       for (j=0; j<dof; j++) x[i*dof+j] = x[j];
1124c4762a1bSJed Brown     }
1125c4762a1bSJed Brown     for (i=Mx; i<xs+xm+2; i++) {
1126c4762a1bSJed Brown       for (j=0; j<dof; j++) x[i*dof+j] = x[(xs+xm-1)*dof+j];
1127c4762a1bSJed Brown     }
1128c4762a1bSJed Brown   }
1129c4762a1bSJed Brown   for (i=xs-1; i<xs+xm+1; i++) {
1130c4762a1bSJed Brown     struct _LimitInfo info;
1131c4762a1bSJed Brown     PetscScalar       *cjmpL,*cjmpR;
1132c4762a1bSJed Brown     /* Determine the right eigenvectors R, where A = R \Lambda R^{-1} */
1133*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ctx->physics.characteristic)(ctx->physics.user,dof,&x[i*dof],ctx->R,ctx->Rinv,ctx->speeds));
1134c4762a1bSJed Brown     /* Evaluate jumps across interfaces (i-1, i) and (i, i+1), put in characteristic basis */
1135*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscArrayzero(ctx->cjmpLR,2*dof));
1136c4762a1bSJed Brown     cjmpL = &ctx->cjmpLR[0];
1137c4762a1bSJed Brown     cjmpR = &ctx->cjmpLR[dof];
1138c4762a1bSJed Brown     for (j=0; j<dof; j++) {
1139c4762a1bSJed Brown       PetscScalar jmpL,jmpR;
1140c4762a1bSJed Brown       jmpL = x[(i+0)*dof+j] - x[(i-1)*dof+j];
1141c4762a1bSJed Brown       jmpR = x[(i+1)*dof+j] - x[(i+0)*dof+j];
1142c4762a1bSJed Brown       for (k=0; k<dof; k++) {
1143c4762a1bSJed Brown         cjmpL[k] += ctx->Rinv[k+j*dof] * jmpL;
1144c4762a1bSJed Brown         cjmpR[k] += ctx->Rinv[k+j*dof] * jmpR;
1145c4762a1bSJed Brown       }
1146c4762a1bSJed Brown     }
1147c4762a1bSJed Brown     /* Apply limiter to the left and right characteristic jumps */
1148c4762a1bSJed Brown     info.m  = dof;
1149c4762a1bSJed Brown     info.hx = hx;
1150c4762a1bSJed Brown     (*ctx->limit)(&info,cjmpL,cjmpR,ctx->cslope);
1151c4762a1bSJed Brown     for (j=0; j<dof; j++) ctx->cslope[j] /= hx; /* rescale to a slope */
1152c4762a1bSJed Brown     for (j=0; j<dof; j++) {
1153c4762a1bSJed Brown       PetscScalar tmp = 0;
1154c4762a1bSJed Brown       for (k=0; k<dof; k++) tmp += ctx->R[j+k*dof] * ctx->cslope[k];
1155c4762a1bSJed Brown       slope[i*dof+j] = tmp;
1156c4762a1bSJed Brown     }
1157c4762a1bSJed Brown   }
1158c4762a1bSJed Brown 
1159c4762a1bSJed Brown   for (i=xs; i<xs+xm+1; i++) {
1160c4762a1bSJed Brown     PetscReal   maxspeed;
1161c4762a1bSJed Brown     PetscScalar *uL,*uR;
1162c4762a1bSJed Brown     uL = &ctx->uLR[0];
1163c4762a1bSJed Brown     uR = &ctx->uLR[dof];
1164c4762a1bSJed Brown     for (j=0; j<dof; j++) {
1165c4762a1bSJed Brown       uL[j] = x[(i-1)*dof+j] + slope[(i-1)*dof+j]*hx/2;
1166c4762a1bSJed Brown       uR[j] = x[(i-0)*dof+j] - slope[(i-0)*dof+j]*hx/2;
1167c4762a1bSJed Brown     }
1168*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ctx->physics.riemann)(ctx->physics.user,dof,uL,uR,ctx->flux,&maxspeed));
1169c4762a1bSJed Brown     cfl_idt = PetscMax(cfl_idt,PetscAbsScalar(maxspeed/hx)); /* Max allowable value of 1/Delta t */
1170c4762a1bSJed Brown 
1171c4762a1bSJed Brown     if (i > xs) {
1172c4762a1bSJed Brown       for (j=0; j<dof; j++) f[(i-1)*dof+j] -= ctx->flux[j]/hx;
1173c4762a1bSJed Brown     }
1174c4762a1bSJed Brown     if (i < xs+xm) {
1175c4762a1bSJed Brown       for (j=0; j<dof; j++) f[i*dof+j] += ctx->flux[j]/hx;
1176c4762a1bSJed Brown     }
1177c4762a1bSJed Brown   }
1178c4762a1bSJed Brown 
1179*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecRestoreArray(da,Xloc,&x));
1180*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecRestoreArray(da,F,&f));
1181*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDARestoreArray(da,PETSC_TRUE,&slope));
1182*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMRestoreLocalVector(da,&Xloc));
1183c4762a1bSJed Brown 
1184*5f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&cfl_idt,&ctx->cfl_idt,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)da)));
1185c4762a1bSJed Brown   if (0) {
1186c4762a1bSJed Brown     /* We need to a way to inform the TS of a CFL constraint, this is a debugging fragment */
1187c4762a1bSJed Brown     PetscReal dt,tnow;
1188*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetTimeStep(ts,&dt));
1189*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetTime(ts,&tnow));
1190c4762a1bSJed Brown     if (dt > 0.5/ctx->cfl_idt) {
1191*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(ctx->comm,"Stability constraint exceeded at t=%g, dt %g > %g\n",(double)tnow,(double)dt,(double)(0.5/ctx->cfl_idt)));
1192c4762a1bSJed Brown     }
1193c4762a1bSJed Brown   }
1194c4762a1bSJed Brown   PetscFunctionReturn(0);
1195c4762a1bSJed Brown }
1196c4762a1bSJed Brown 
1197c4762a1bSJed Brown static PetscErrorCode SmallMatMultADB(PetscScalar *C,PetscInt bs,const PetscScalar *A,const PetscReal *D,const PetscScalar *B)
1198c4762a1bSJed Brown {
1199c4762a1bSJed Brown   PetscInt i,j,k;
1200c4762a1bSJed Brown 
1201c4762a1bSJed Brown   PetscFunctionBeginUser;
1202c4762a1bSJed Brown   for (i=0; i<bs; i++) {
1203c4762a1bSJed Brown     for (j=0; j<bs; j++) {
1204c4762a1bSJed Brown       PetscScalar tmp = 0;
1205c4762a1bSJed Brown       for (k=0; k<bs; k++) tmp += A[i*bs+k] * D[k] * B[k*bs+j];
1206c4762a1bSJed Brown       C[i*bs+j] = tmp;
1207c4762a1bSJed Brown     }
1208c4762a1bSJed Brown   }
1209c4762a1bSJed Brown   PetscFunctionReturn(0);
1210c4762a1bSJed Brown }
1211c4762a1bSJed Brown 
1212c4762a1bSJed Brown static PetscErrorCode FVIJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat A,Mat B,void *vctx)
1213c4762a1bSJed Brown {
1214c4762a1bSJed Brown   FVCtx             *ctx = (FVCtx*)vctx;
1215c4762a1bSJed Brown   PetscInt          i,j,dof = ctx->physics.dof;
1216c4762a1bSJed Brown   PetscScalar       *J;
1217c4762a1bSJed Brown   const PetscScalar *x;
1218c4762a1bSJed Brown   PetscReal         hx;
1219c4762a1bSJed Brown   DM                da;
1220c4762a1bSJed Brown   DMDALocalInfo     dainfo;
1221c4762a1bSJed Brown 
1222c4762a1bSJed Brown   PetscFunctionBeginUser;
1223*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&da));
1224*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecGetArrayRead(da,X,(void*)&x));
1225*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetLocalInfo(da,&dainfo));
1226c4762a1bSJed Brown   hx   = (ctx->xmax - ctx->xmin)/dainfo.mx;
1227*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(dof*dof,&J));
1228c4762a1bSJed Brown   for (i=dainfo.xs; i<dainfo.xs+dainfo.xm; i++) {
1229*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ctx->physics.characteristic)(ctx->physics.user,dof,&x[i*dof],ctx->R,ctx->Rinv,ctx->speeds));
1230c4762a1bSJed Brown     for (j=0; j<dof; j++) ctx->speeds[j] = PetscAbs(ctx->speeds[j]);
1231*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SmallMatMultADB(J,dof,ctx->R,ctx->speeds,ctx->Rinv));
1232c4762a1bSJed Brown     for (j=0; j<dof*dof; j++) J[j] = J[j]/hx + shift*(j/dof == j%dof);
1233*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatSetValuesBlocked(B,1,&i,1,&i,J,INSERT_VALUES));
1234c4762a1bSJed Brown   }
1235*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(J));
1236*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecRestoreArrayRead(da,X,(void*)&x));
1237c4762a1bSJed Brown 
1238*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY));
1239*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY));
1240c4762a1bSJed Brown   if (A != B) {
1241*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
1242*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
1243c4762a1bSJed Brown   }
1244c4762a1bSJed Brown   PetscFunctionReturn(0);
1245c4762a1bSJed Brown }
1246c4762a1bSJed Brown 
1247c4762a1bSJed Brown static PetscErrorCode FVSample(FVCtx *ctx,DM da,PetscReal time,Vec U)
1248c4762a1bSJed Brown {
1249c4762a1bSJed Brown   PetscScalar    *u,*uj;
1250c4762a1bSJed Brown   PetscInt       i,j,k,dof,xs,xm,Mx;
1251c4762a1bSJed Brown 
1252c4762a1bSJed Brown   PetscFunctionBeginUser;
12533c633725SBarry Smith   PetscCheck(ctx->physics.sample,PETSC_COMM_SELF,PETSC_ERR_SUP,"Physics has not provided a sampling function");
1254*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetInfo(da,0, &Mx,0,0, 0,0,0, &dof,0,0,0,0,0));
1255*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetCorners(da,&xs,0,0,&xm,0,0));
1256*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecGetArray(da,U,&u));
1257*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(dof,&uj));
1258c4762a1bSJed Brown   for (i=xs; i<xs+xm; i++) {
1259c4762a1bSJed Brown     const PetscReal h = (ctx->xmax-ctx->xmin)/Mx,xi = ctx->xmin+h/2+i*h;
1260c4762a1bSJed Brown     const PetscInt  N = 200;
1261c4762a1bSJed Brown     /* Integrate over cell i using trapezoid rule with N points. */
1262c4762a1bSJed Brown     for (k=0; k<dof; k++) u[i*dof+k] = 0;
1263c4762a1bSJed Brown     for (j=0; j<N+1; j++) {
1264c4762a1bSJed Brown       PetscScalar xj = xi+h*(j-N/2)/(PetscReal)N;
1265*5f80ce2aSJacob Faibussowitsch       CHKERRQ((*ctx->physics.sample)(ctx->physics.user,ctx->initial,ctx->bctype,ctx->xmin,ctx->xmax,time,xj,uj));
1266c4762a1bSJed Brown       for (k=0; k<dof; k++) u[i*dof+k] += ((j==0 || j==N) ? 0.5 : 1.0)*uj[k]/N;
1267c4762a1bSJed Brown     }
1268c4762a1bSJed Brown   }
1269*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAVecRestoreArray(da,U,&u));
1270*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(uj));
1271c4762a1bSJed Brown   PetscFunctionReturn(0);
1272c4762a1bSJed Brown }
1273c4762a1bSJed Brown 
1274c4762a1bSJed Brown static PetscErrorCode SolutionStatsView(DM da,Vec X,PetscViewer viewer)
1275c4762a1bSJed Brown {
1276c4762a1bSJed Brown   PetscReal         xmin,xmax;
1277c4762a1bSJed Brown   PetscScalar       sum,tvsum,tvgsum;
1278c4762a1bSJed Brown   const PetscScalar *x;
1279c4762a1bSJed Brown   PetscInt          imin,imax,Mx,i,j,xs,xm,dof;
1280c4762a1bSJed Brown   Vec               Xloc;
1281c4762a1bSJed Brown   PetscBool         iascii;
1282c4762a1bSJed Brown 
1283c4762a1bSJed Brown   PetscFunctionBeginUser;
1284*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii));
1285c4762a1bSJed Brown   if (iascii) {
1286c4762a1bSJed Brown     /* PETSc lacks a function to compute total variation norm (difficult in multiple dimensions), we do it here */
1287*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMGetLocalVector(da,&Xloc));
1288*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMGlobalToLocalBegin(da,X,INSERT_VALUES,Xloc));
1289*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMGlobalToLocalEnd  (da,X,INSERT_VALUES,Xloc));
1290*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAVecGetArrayRead(da,Xloc,(void*)&x));
1291*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAGetCorners(da,&xs,0,0,&xm,0,0));
1292*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAGetInfo(da,0, &Mx,0,0, 0,0,0, &dof,0,0,0,0,0));
1293c4762a1bSJed Brown     tvsum = 0;
1294c4762a1bSJed Brown     for (i=xs; i<xs+xm; i++) {
1295c4762a1bSJed Brown       for (j=0; j<dof; j++) tvsum += PetscAbsScalar(x[i*dof+j] - x[(i-1)*dof+j]);
1296c4762a1bSJed Brown     }
1297*5f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&tvsum,&tvgsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)da)));
1298*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAVecRestoreArrayRead(da,Xloc,(void*)&x));
1299*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMRestoreLocalVector(da,&Xloc));
1300c4762a1bSJed Brown 
1301*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecMin(X,&imin,&xmin));
1302*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecMax(X,&imax,&xmax));
1303*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecSum(X,&sum));
1304*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPrintf(viewer,"Solution range [%8.5f,%8.5f] with extrema at %D and %D, mean %8.5f, ||x||_TV %8.5f\n",(double)xmin,(double)xmax,imin,imax,(double)(sum/Mx),(double)(tvgsum/Mx)));
1305c4762a1bSJed Brown   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type not supported");
1306c4762a1bSJed Brown   PetscFunctionReturn(0);
1307c4762a1bSJed Brown }
1308c4762a1bSJed Brown 
1309c4762a1bSJed Brown static PetscErrorCode SolutionErrorNorms(FVCtx *ctx,DM da,PetscReal t,Vec X,PetscReal *nrm1,PetscReal *nrmsup)
1310c4762a1bSJed Brown {
1311c4762a1bSJed Brown   Vec            Y;
1312c4762a1bSJed Brown   PetscInt       Mx;
1313c4762a1bSJed Brown 
1314c4762a1bSJed Brown   PetscFunctionBeginUser;
1315*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetSize(X,&Mx));
1316*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDuplicate(X,&Y));
1317*5f80ce2aSJacob Faibussowitsch   CHKERRQ(FVSample(ctx,da,t,Y));
1318*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecAYPX(Y,-1,X));
1319*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecNorm(Y,NORM_1,nrm1));
1320*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecNorm(Y,NORM_INFINITY,nrmsup));
1321c4762a1bSJed Brown   *nrm1 /= Mx;
1322*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&Y));
1323c4762a1bSJed Brown   PetscFunctionReturn(0);
1324c4762a1bSJed Brown }
1325c4762a1bSJed Brown 
1326c4762a1bSJed Brown int main(int argc,char *argv[])
1327c4762a1bSJed Brown {
1328c4762a1bSJed Brown   char              lname[256] = "mc",physname[256] = "advect",final_fname[256] = "solution.m";
1329c4762a1bSJed Brown   PetscFunctionList limiters   = 0,physics = 0;
1330c4762a1bSJed Brown   MPI_Comm          comm;
1331c4762a1bSJed Brown   TS                ts;
1332c4762a1bSJed Brown   DM                da;
1333c4762a1bSJed Brown   Vec               X,X0,R;
1334c4762a1bSJed Brown   Mat               B;
1335c4762a1bSJed Brown   FVCtx             ctx;
1336c4762a1bSJed Brown   PetscInt          i,dof,xs,xm,Mx,draw = 0;
1337c4762a1bSJed Brown   PetscBool         view_final = PETSC_FALSE;
1338c4762a1bSJed Brown   PetscReal         ptime;
1339c4762a1bSJed Brown   PetscErrorCode    ierr;
1340c4762a1bSJed Brown 
1341c4762a1bSJed Brown   ierr = PetscInitialize(&argc,&argv,0,help);if (ierr) return ierr;
1342c4762a1bSJed Brown   comm = PETSC_COMM_WORLD;
1343*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMemzero(&ctx,sizeof(ctx)));
1344c4762a1bSJed Brown 
1345c4762a1bSJed Brown   /* Register limiters to be available on the command line */
1346*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"upwind"              ,Limit_Upwind));
1347*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"lax-wendroff"        ,Limit_LaxWendroff));
1348*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"beam-warming"        ,Limit_BeamWarming));
1349*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"fromm"               ,Limit_Fromm));
1350*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"minmod"              ,Limit_Minmod));
1351*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"superbee"            ,Limit_Superbee));
1352*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"mc"                  ,Limit_MC));
1353*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"vanleer"             ,Limit_VanLeer));
1354*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"vanalbada"           ,Limit_VanAlbada));
1355*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"vanalbadatvd"        ,Limit_VanAlbadaTVD));
1356*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"koren"               ,Limit_Koren));
1357*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"korensym"            ,Limit_KorenSym));
1358*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"koren3"              ,Limit_Koren3));
1359*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"cada-torrilhon2"     ,Limit_CadaTorrilhon2));
1360*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"cada-torrilhon3-r0p1",Limit_CadaTorrilhon3R0p1));
1361*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"cada-torrilhon3-r1"  ,Limit_CadaTorrilhon3R1));
1362*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"cada-torrilhon3-r10" ,Limit_CadaTorrilhon3R10));
1363*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&limiters,"cada-torrilhon3-r100",Limit_CadaTorrilhon3R100));
1364c4762a1bSJed Brown 
1365c4762a1bSJed Brown   /* Register physical models to be available on the command line */
1366*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"advect"          ,PhysicsCreate_Advect));
1367*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"burgers"         ,PhysicsCreate_Burgers));
1368*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"traffic"         ,PhysicsCreate_Traffic));
1369*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"acoustics"       ,PhysicsCreate_Acoustics));
1370*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"isogas"          ,PhysicsCreate_IsoGas));
1371*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListAdd(&physics,"shallow"         ,PhysicsCreate_Shallow));
1372c4762a1bSJed Brown 
1373c4762a1bSJed Brown   ctx.comm = comm;
1374c4762a1bSJed Brown   ctx.cfl  = 0.9; ctx.bctype = FVBC_PERIODIC;
1375c4762a1bSJed Brown   ctx.xmin = -1; ctx.xmax = 1;
1376c4762a1bSJed Brown   ierr     = PetscOptionsBegin(comm,NULL,"Finite Volume solver options","");CHKERRQ(ierr);
1377*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-xmin","X min","",ctx.xmin,&ctx.xmin,NULL));
1378*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-xmax","X max","",ctx.xmax,&ctx.xmax,NULL));
1379*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-limit","Name of flux limiter to use","",limiters,lname,lname,sizeof(lname),NULL));
1380*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsFList("-physics","Name of physics (Riemann solver and characteristics) to use","",physics,physname,physname,sizeof(physname),NULL));
1381*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-draw","Draw solution vector, bitwise OR of (1=initial,2=final,4=final error)","",draw,&draw,NULL));
1382*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsString("-view_final","Write final solution in ASCII MATLAB format to given file name","",final_fname,final_fname,sizeof(final_fname),&view_final));
1383*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-initial","Initial condition (depends on the physics)","",ctx.initial,&ctx.initial,NULL));
1384*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsBool("-exact","Compare errors with exact solution","",ctx.exact,&ctx.exact,NULL));
1385*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsReal("-cfl","CFL number to time step at","",ctx.cfl,&ctx.cfl,NULL));
1386*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsEnum("-bc_type","Boundary condition","",FVBCTypes,(PetscEnum)ctx.bctype,(PetscEnum*)&ctx.bctype,NULL));
1387c4762a1bSJed Brown   ierr = PetscOptionsEnd();CHKERRQ(ierr);
1388c4762a1bSJed Brown 
1389c4762a1bSJed Brown   /* Choose the limiter from the list of registered limiters */
1390*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListFind(limiters,lname,&ctx.limit));
13913c633725SBarry Smith   PetscCheck(ctx.limit,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Limiter '%s' not found",lname);
1392c4762a1bSJed Brown 
1393c4762a1bSJed Brown   /* Choose the physics from the list of registered models */
1394c4762a1bSJed Brown   {
1395c4762a1bSJed Brown     PetscErrorCode (*r)(FVCtx*);
1396*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFunctionListFind(physics,physname,&r));
13973c633725SBarry Smith     PetscCheck(r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Physics '%s' not found",physname);
1398c4762a1bSJed Brown     /* Create the physics, will set the number of fields and their names */
1399*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*r)(&ctx));
1400c4762a1bSJed Brown   }
1401c4762a1bSJed Brown 
1402c4762a1bSJed Brown   /* Create a DMDA to manage the parallel grid */
1403*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDACreate1d(comm,DM_BOUNDARY_PERIODIC,50,ctx.physics.dof,2,NULL,&da));
1404*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMSetFromOptions(da));
1405*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMSetUp(da));
1406c4762a1bSJed Brown   /* Inform the DMDA of the field names provided by the physics. */
1407c4762a1bSJed Brown   /* The names will be shown in the title bars when run with -ts_monitor_draw_solution */
1408c4762a1bSJed Brown   for (i=0; i<ctx.physics.dof; i++) {
1409*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDASetFieldName(da,i,ctx.physics.fieldname[i]));
1410c4762a1bSJed Brown   }
1411*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetInfo(da,0, &Mx,0,0, 0,0,0, &dof,0,0,0,0,0));
1412*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDAGetCorners(da,&xs,0,0,&xm,0,0));
1413c4762a1bSJed Brown 
1414c4762a1bSJed Brown   /* Set coordinates of cell centers */
1415*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDASetUniformCoordinates(da,ctx.xmin+0.5*(ctx.xmax-ctx.xmin)/Mx,ctx.xmax+0.5*(ctx.xmax-ctx.xmin)/Mx,0,0,0,0));
1416c4762a1bSJed Brown 
1417c4762a1bSJed Brown   /* Allocate work space for the Finite Volume solver (so it doesn't have to be reallocated on each function evaluation) */
1418*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc4(dof*dof,&ctx.R,dof*dof,&ctx.Rinv,2*dof,&ctx.cjmpLR,1*dof,&ctx.cslope));
1419*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc3(2*dof,&ctx.uLR,dof,&ctx.flux,dof,&ctx.speeds));
1420c4762a1bSJed Brown 
1421c4762a1bSJed Brown   /* Create a vector to store the solution and to save the initial state */
1422*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMCreateGlobalVector(da,&X));
1423*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDuplicate(X,&X0));
1424*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDuplicate(X,&R));
1425c4762a1bSJed Brown 
1426*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMCreateMatrix(da,&B));
1427c4762a1bSJed Brown 
1428c4762a1bSJed Brown   /* Create a time-stepping object */
1429*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSCreate(comm,&ts));
1430*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetDM(ts,da));
1431*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetRHSFunction(ts,R,FVRHSFunction,&ctx));
1432*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetIJacobian(ts,B,B,FVIJacobian,&ctx));
1433*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetType(ts,TSSSP));
1434*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetMaxTime(ts,10));
1435*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetExactFinalTime(ts,TS_EXACTFINALTIME_STEPOVER));
1436c4762a1bSJed Brown 
1437c4762a1bSJed Brown   /* Compute initial conditions and starting time step */
1438*5f80ce2aSJacob Faibussowitsch   CHKERRQ(FVSample(&ctx,da,0,X0));
1439*5f80ce2aSJacob Faibussowitsch   CHKERRQ(FVRHSFunction(ts,0,X0,X,(void*)&ctx)); /* Initial function evaluation, only used to determine max speed */
1440*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecCopy(X0,X));                        /* The function value was not used so we set X=X0 again */
1441*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetTimeStep(ts,ctx.cfl/ctx.cfl_idt));
1442*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetFromOptions(ts)); /* Take runtime options */
1443*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SolutionStatsView(da,X,PETSC_VIEWER_STDOUT_WORLD));
1444c4762a1bSJed Brown   {
1445c4762a1bSJed Brown     PetscReal nrm1,nrmsup;
1446c4762a1bSJed Brown     PetscInt  steps;
1447c4762a1bSJed Brown 
1448*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSolve(ts,X));
1449*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolveTime(ts,&ptime));
1450*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetStepNumber(ts,&steps));
1451c4762a1bSJed Brown 
1452*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscPrintf(comm,"Final time %8.5f, steps %D\n",(double)ptime,steps));
1453c4762a1bSJed Brown     if (ctx.exact) {
1454*5f80ce2aSJacob Faibussowitsch       CHKERRQ(SolutionErrorNorms(&ctx,da,ptime,X,&nrm1,&nrmsup));
1455*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(comm,"Error ||x-x_e||_1 %8.4e  ||x-x_e||_sup %8.4e\n",(double)nrm1,(double)nrmsup));
1456c4762a1bSJed Brown     }
1457c4762a1bSJed Brown   }
1458c4762a1bSJed Brown 
1459*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SolutionStatsView(da,X,PETSC_VIEWER_STDOUT_WORLD));
1460*5f80ce2aSJacob Faibussowitsch   if (draw & 0x1) CHKERRQ(VecView(X0,PETSC_VIEWER_DRAW_WORLD));
1461*5f80ce2aSJacob Faibussowitsch   if (draw & 0x2) CHKERRQ(VecView(X,PETSC_VIEWER_DRAW_WORLD));
1462c4762a1bSJed Brown   if (draw & 0x4) {
1463c4762a1bSJed Brown     Vec Y;
1464*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDuplicate(X,&Y));
1465*5f80ce2aSJacob Faibussowitsch     CHKERRQ(FVSample(&ctx,da,ptime,Y));
1466*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecAYPX(Y,-1,X));
1467*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecView(Y,PETSC_VIEWER_DRAW_WORLD));
1468*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDestroy(&Y));
1469c4762a1bSJed Brown   }
1470c4762a1bSJed Brown 
1471c4762a1bSJed Brown   if (view_final) {
1472c4762a1bSJed Brown     PetscViewer viewer;
1473*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIOpen(PETSC_COMM_WORLD,final_fname,&viewer));
1474*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_MATLAB));
1475*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecView(X,viewer));
1476*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerPopFormat(viewer));
1477*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDestroy(&viewer));
1478c4762a1bSJed Brown   }
1479c4762a1bSJed Brown 
1480c4762a1bSJed Brown   /* Clean up */
1481*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ctx.physics.destroy)(ctx.physics.user));
1482*5f80ce2aSJacob Faibussowitsch   for (i=0; i<ctx.physics.dof; i++) CHKERRQ(PetscFree(ctx.physics.fieldname[i]));
1483*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree4(ctx.R,ctx.Rinv,ctx.cjmpLR,ctx.cslope));
1484*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree3(ctx.uLR,ctx.flux,ctx.speeds));
1485*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&X));
1486*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&X0));
1487*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&R));
1488*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatDestroy(&B));
1489*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDestroy(&da));
1490*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSDestroy(&ts));
1491*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&limiters));
1492*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListDestroy(&physics));
1493c4762a1bSJed Brown   ierr = PetscFinalize();
1494c4762a1bSJed Brown   return ierr;
1495c4762a1bSJed Brown }
1496c4762a1bSJed Brown 
1497c4762a1bSJed Brown /*TEST
1498c4762a1bSJed Brown 
1499c4762a1bSJed Brown     build:
1500f56ea12dSJed Brown       requires: !complex
1501c4762a1bSJed Brown 
1502c4762a1bSJed Brown     test:
1503c4762a1bSJed Brown       args: -da_grid_x 100 -initial 1 -xmin -2 -xmax 5 -exact -limit mc
1504c4762a1bSJed Brown       requires: !complex !single
1505c4762a1bSJed Brown 
1506c4762a1bSJed Brown     test:
1507c4762a1bSJed Brown       suffix: 2
1508c4762a1bSJed Brown       args: -da_grid_x 100 -initial 2 -xmin -2 -xmax 2 -exact -limit mc -physics burgers -bc_type outflow -ts_max_time 1
1509c4762a1bSJed Brown       filter:  sed "s/at 48/at 0/g"
1510c4762a1bSJed Brown       requires: !complex !single
1511c4762a1bSJed Brown 
1512c4762a1bSJed Brown     test:
1513c4762a1bSJed Brown       suffix: 3
1514c4762a1bSJed Brown       args: -da_grid_x 100 -initial 2 -xmin -2 -xmax 2 -exact -limit mc -physics burgers -bc_type outflow -ts_max_time 1
1515c4762a1bSJed Brown       nsize: 3
1516c4762a1bSJed Brown       filter:  sed "s/at 48/at 0/g"
1517c4762a1bSJed Brown       requires: !complex !single
1518c4762a1bSJed Brown 
1519c4762a1bSJed Brown TEST*/
1520