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