xref: /petsc/include/petscfv.h (revision fe998a80077c9ee0917a39496df43fc256e1b478)
1 /*
2       Objects which encapsulate finite volume spaces and operations
3 */
4 #if !defined(__PETSCFV_H)
5 #define __PETSCFV_H
6 #include <petscdm.h>
7 #include <petscdt.h>
8 #include <petscfvtypes.h>
9 #include <petscdstypes.h>
10 
11 PETSC_EXTERN PetscClassId PETSCLIMITER_CLASSID;
12 
13 /*J
14   PetscLimiterType - String with the name of a PETSc finite volume slope limiter
15 
16   Level: beginner
17 
18 .seealso: PetscLimiterSetType(), PetscLimiter
19 J*/
20 typedef const char *PetscLimiterType;
21 #define PETSCLIMITERSIN       "sin"
22 #define PETSCLIMITERZERO      "zero"
23 #define PETSCLIMITERNONE      "none"
24 #define PETSCLIMITERMINMOD    "minmod"
25 #define PETSCLIMITERVANLEER   "vanleer"
26 #define PETSCLIMITERVANALBADA "vanalbada"
27 #define PETSCLIMITERSUPERBEE  "superbee"
28 #define PETSCLIMITERMC        "mc"
29 
30 PETSC_EXTERN PetscFunctionList PetscLimiterList;
31 PETSC_EXTERN PetscBool         PetscLimiterRegisterAllCalled;
32 PETSC_EXTERN PetscErrorCode PetscLimiterCreate(MPI_Comm, PetscLimiter *);
33 PETSC_EXTERN PetscErrorCode PetscLimiterDestroy(PetscLimiter *);
34 PETSC_EXTERN PetscErrorCode PetscLimiterSetType(PetscLimiter, PetscLimiterType);
35 PETSC_EXTERN PetscErrorCode PetscLimiterGetType(PetscLimiter, PetscLimiterType *);
36 PETSC_EXTERN PetscErrorCode PetscLimiterSetUp(PetscLimiter);
37 PETSC_EXTERN PetscErrorCode PetscLimiterSetFromOptions(PetscLimiter);
38 PETSC_EXTERN PetscErrorCode PetscLimiterViewFromOptions(PetscLimiter, const char[], const char[]);
39 PETSC_EXTERN PetscErrorCode PetscLimiterView(PetscLimiter, PetscViewer);
40 PETSC_EXTERN PetscErrorCode PetscLimiterRegister(const char [], PetscErrorCode (*)(PetscLimiter));
41 PETSC_EXTERN PetscErrorCode PetscLimiterRegisterAll(void);
42 PETSC_EXTERN PetscErrorCode PetscLimiterRegisterDestroy(void);
43 
44 PETSC_EXTERN PetscErrorCode PetscLimiterLimit(PetscLimiter, PetscReal, PetscReal *);
45 
46 
47 PETSC_EXTERN PetscErrorCode PetscFVInitializePackage(void);
48 
49 PETSC_EXTERN PetscClassId PETSCFV_CLASSID;
50 
51 /*J
52   PetscFVType - String with the name of a PETSc finite volume discretization
53 
54   Level: beginner
55 
56 .seealso: PetscFVSetType(), PetscFV
57 J*/
58 typedef const char *PetscFVType;
59 #define PETSCFVUPWIND       "upwind"
60 #define PETSCFVLEASTSQUARES "leastsquares"
61 
62 PETSC_EXTERN PetscFunctionList PetscFVList;
63 PETSC_EXTERN PetscBool         PetscFVRegisterAllCalled;
64 PETSC_EXTERN PetscErrorCode PetscFVCreate(MPI_Comm, PetscFV *);
65 PETSC_EXTERN PetscErrorCode PetscFVDestroy(PetscFV *);
66 PETSC_EXTERN PetscErrorCode PetscFVSetType(PetscFV, PetscFVType);
67 PETSC_EXTERN PetscErrorCode PetscFVGetType(PetscFV, PetscFVType *);
68 PETSC_EXTERN PetscErrorCode PetscFVSetUp(PetscFV);
69 PETSC_EXTERN PetscErrorCode PetscFVSetFromOptions(PetscFV);
70 PETSC_EXTERN PetscErrorCode PetscFVViewFromOptions(PetscFV, const char[], const char[]);
71 PETSC_EXTERN PetscErrorCode PetscFVView(PetscFV, PetscViewer);
72 PETSC_EXTERN PetscErrorCode PetscFVRegister(const char [], PetscErrorCode (*)(PetscFV));
73 PETSC_EXTERN PetscErrorCode PetscFVRegisterAll(void);
74 PETSC_EXTERN PetscErrorCode PetscFVRegisterDestroy(void);
75 
76 PETSC_EXTERN PetscErrorCode PetscFVSetLimiter(PetscFV, PetscLimiter);
77 PETSC_EXTERN PetscErrorCode PetscFVGetLimiter(PetscFV, PetscLimiter *);
78 PETSC_EXTERN PetscErrorCode PetscFVSetNumComponents(PetscFV, PetscInt);
79 PETSC_EXTERN PetscErrorCode PetscFVGetNumComponents(PetscFV, PetscInt *);
80 PETSC_EXTERN PetscErrorCode PetscFVSetSpatialDimension(PetscFV, PetscInt);
81 PETSC_EXTERN PetscErrorCode PetscFVGetSpatialDimension(PetscFV, PetscInt *);
82 PETSC_EXTERN PetscErrorCode PetscFVSetComputeGradients(PetscFV, PetscBool);
83 PETSC_EXTERN PetscErrorCode PetscFVGetComputeGradients(PetscFV, PetscBool *);
84 PETSC_EXTERN PetscErrorCode PetscFVSetQuadrature(PetscFV, PetscQuadrature);
85 PETSC_EXTERN PetscErrorCode PetscFVGetQuadrature(PetscFV, PetscQuadrature *);
86 
87 PETSC_EXTERN PetscErrorCode PetscFVComputeGradient(PetscFV, PetscInt, PetscScalar[], PetscScalar[]);
88 PETSC_EXTERN PetscErrorCode PetscFVIntegrateRHSFunction(PetscFV, PetscDS, PetscInt, PetscInt, PetscFVFaceGeom *, PetscReal *, PetscScalar[], PetscScalar[], PetscScalar[], PetscScalar[]);
89 
90 PETSC_EXTERN PetscErrorCode PetscFVLeastSquaresSetMaxFaces(PetscFV, PetscInt);
91 
92 #endif
93