xref: /petsc/include/petscfe.h (revision 2c9ec6dfe874b911fa49ef7e759d29a8430d6aff)
1 /*
2       Objects which encapsulate finite element spaces and operations
3 */
4 #if !defined(__PETSCFE_H)
5 #define __PETSCFE_H
6 #include <petscdm.h>
7 #include <petscdt.h>
8 #include <petscfetypes.h>
9 #include <petscdstypes.h>
10 
11 PETSC_EXTERN PetscErrorCode PetscFEInitializePackage(void);
12 
13 PETSC_EXTERN PetscClassId PETSCSPACE_CLASSID;
14 
15 /*J
16   PetscSpaceType - String with the name of a PETSc linear space
17 
18   Level: beginner
19 
20 .seealso: PetscSpaceSetType(), PetscSpace
21 J*/
22 typedef const char *PetscSpaceType;
23 #define PETSCSPACEPOLYNOMIAL "poly"
24 #define PETSCSPACEDG         "dg"
25 
26 PETSC_EXTERN PetscFunctionList PetscSpaceList;
27 PETSC_EXTERN PetscBool         PetscSpaceRegisterAllCalled;
28 PETSC_EXTERN PetscErrorCode PetscSpaceCreate(MPI_Comm, PetscSpace *);
29 PETSC_EXTERN PetscErrorCode PetscSpaceDestroy(PetscSpace *);
30 PETSC_EXTERN PetscErrorCode PetscSpaceSetType(PetscSpace, PetscSpaceType);
31 PETSC_EXTERN PetscErrorCode PetscSpaceGetType(PetscSpace, PetscSpaceType *);
32 PETSC_EXTERN PetscErrorCode PetscSpaceSetUp(PetscSpace);
33 PETSC_EXTERN PetscErrorCode PetscSpaceSetFromOptions(PetscSpace);
34 PETSC_EXTERN PetscErrorCode PetscSpaceViewFromOptions(PetscSpace,const char[],const char[]);
35 PETSC_EXTERN PetscErrorCode PetscSpaceView(PetscSpace,PetscViewer);
36 PETSC_EXTERN PetscErrorCode PetscSpaceRegister(const char [], PetscErrorCode (*)(PetscSpace));
37 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterAll(void);
38 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterDestroy(void);
39 
40 PETSC_EXTERN PetscErrorCode PetscSpaceGetDimension(PetscSpace, PetscInt *);
41 PETSC_EXTERN PetscErrorCode PetscSpaceSetOrder(PetscSpace, PetscInt);
42 PETSC_EXTERN PetscErrorCode PetscSpaceGetOrder(PetscSpace, PetscInt *);
43 PETSC_EXTERN PetscErrorCode PetscSpaceEvaluate(PetscSpace, PetscInt, const PetscReal[], PetscReal[], PetscReal[], PetscReal[]);
44 
45 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetNumVariables(PetscSpace, PetscInt);
46 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetNumVariables(PetscSpace, PetscInt *);
47 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetSymmetric(PetscSpace, PetscBool);
48 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetSymmetric(PetscSpace, PetscBool *);
49 
50 PETSC_EXTERN PetscErrorCode PetscSpaceDGSetQuadrature(PetscSpace, PetscQuadrature);
51 PETSC_EXTERN PetscErrorCode PetscSpaceDGGetQuadrature(PetscSpace, PetscQuadrature *);
52 
53 PETSC_EXTERN PetscClassId PETSCDUALSPACE_CLASSID;
54 
55 /*J
56   PetscDualSpaceType - String with the name of a PETSc dual space
57 
58   Level: beginner
59 
60 .seealso: PetscDualSpaceSetType(), PetscDualSpace
61 J*/
62 typedef const char *PetscDualSpaceType;
63 #define PETSCDUALSPACELAGRANGE "lagrange"
64 
65 PETSC_EXTERN PetscFunctionList PetscDualSpaceList;
66 PETSC_EXTERN PetscBool         PetscDualSpaceRegisterAllCalled;
67 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreate(MPI_Comm, PetscDualSpace *);
68 PETSC_EXTERN PetscErrorCode PetscDualSpaceDestroy(PetscDualSpace *);
69 PETSC_EXTERN PetscErrorCode PetscDualSpaceDuplicate(PetscDualSpace, PetscDualSpace *);
70 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetType(PetscDualSpace, PetscDualSpaceType);
71 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetType(PetscDualSpace, PetscDualSpaceType *);
72 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetUp(PetscDualSpace);
73 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetFromOptions(PetscDualSpace);
74 PETSC_EXTERN PetscErrorCode PetscDualSpaceViewFromOptions(PetscDualSpace,const char[],const char[]);
75 PETSC_EXTERN PetscErrorCode PetscDualSpaceView(PetscDualSpace,PetscViewer);
76 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegister(const char [], PetscErrorCode (*)(PetscDualSpace));
77 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterAll(void);
78 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterDestroy(void);
79 
80 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDimension(PetscDualSpace, PetscInt *);
81 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetOrder(PetscDualSpace, PetscInt);
82 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetOrder(PetscDualSpace, PetscInt *);
83 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetDM(PetscDualSpace, DM);
84 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDM(PetscDualSpace, DM *);
85 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetFunctional(PetscDualSpace, PetscInt, PetscQuadrature *);
86 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreateReferenceCell(PetscDualSpace, PetscInt, PetscBool, DM *);
87 
88 PETSC_EXTERN PetscErrorCode PetscDualSpaceApply(PetscDualSpace, PetscInt, PetscCellGeometry, PetscInt, void (*)(const PetscReal [], PetscScalar *, void *), void *, PetscScalar *);
89 
90 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeGetContinuity(PetscDualSpace, PetscBool *);
91 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeSetContinuity(PetscDualSpace, PetscBool);
92 
93 PETSC_EXTERN PetscClassId PETSCFE_CLASSID;
94 
95 /*J
96   PetscFEType - String with the name of a PETSc finite element space
97 
98   Level: beginner
99 
100   Note: Currently, the classes are concerned with the implementation of element integration
101 
102 .seealso: PetscFESetType(), PetscFE
103 J*/
104 typedef const char *PetscFEType;
105 #define PETSCFEBASIC     "basic"
106 #define PETSCFENONAFFINE "nonaffine"
107 #define PETSCFEOPENCL    "opencl"
108 #define PETSCFECOMPOSITE "composite"
109 
110 PETSC_EXTERN PetscFunctionList PetscFEList;
111 PETSC_EXTERN PetscBool         PetscFERegisterAllCalled;
112 PETSC_EXTERN PetscErrorCode PetscFECreate(MPI_Comm, PetscFE *);
113 PETSC_EXTERN PetscErrorCode PetscFEDestroy(PetscFE *);
114 PETSC_EXTERN PetscErrorCode PetscFESetType(PetscFE, PetscFEType);
115 PETSC_EXTERN PetscErrorCode PetscFEGetType(PetscFE, PetscFEType *);
116 PETSC_EXTERN PetscErrorCode PetscFESetUp(PetscFE);
117 PETSC_EXTERN PetscErrorCode PetscFESetFromOptions(PetscFE);
118 PETSC_EXTERN PetscErrorCode PetscFEViewFromOptions(PetscFE,const char[],const char[]);
119 PETSC_EXTERN PetscErrorCode PetscFEView(PetscFE,PetscViewer);
120 PETSC_EXTERN PetscErrorCode PetscFERegister(const char [], PetscErrorCode (*)(PetscFE));
121 PETSC_EXTERN PetscErrorCode PetscFERegisterAll(void);
122 PETSC_EXTERN PetscErrorCode PetscFERegisterDestroy(void);
123 PETSC_EXTERN PetscErrorCode PetscFECreateDefault(DM, PetscInt, PetscInt, PetscBool, const char [], PetscInt, PetscFE *);
124 
125 PETSC_EXTERN PetscErrorCode PetscFEGetDimension(PetscFE, PetscInt *);
126 PETSC_EXTERN PetscErrorCode PetscFEGetSpatialDimension(PetscFE, PetscInt *);
127 PETSC_EXTERN PetscErrorCode PetscFESetNumComponents(PetscFE, PetscInt);
128 PETSC_EXTERN PetscErrorCode PetscFEGetNumComponents(PetscFE, PetscInt *);
129 PETSC_EXTERN PetscErrorCode PetscFEGetTileSizes(PetscFE, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
130 PETSC_EXTERN PetscErrorCode PetscFESetTileSizes(PetscFE, PetscInt, PetscInt, PetscInt, PetscInt);
131 PETSC_EXTERN PetscErrorCode PetscFESetBasisSpace(PetscFE, PetscSpace);
132 PETSC_EXTERN PetscErrorCode PetscFEGetBasisSpace(PetscFE, PetscSpace *);
133 PETSC_EXTERN PetscErrorCode PetscFESetDualSpace(PetscFE, PetscDualSpace);
134 PETSC_EXTERN PetscErrorCode PetscFEGetDualSpace(PetscFE, PetscDualSpace *);
135 PETSC_EXTERN PetscErrorCode PetscFESetQuadrature(PetscFE, PetscQuadrature);
136 PETSC_EXTERN PetscErrorCode PetscFEGetQuadrature(PetscFE, PetscQuadrature *);
137 PETSC_EXTERN PetscErrorCode PetscFEGetNumDof(PetscFE, const PetscInt **);
138 PETSC_EXTERN PetscErrorCode PetscFEGetDefaultTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
139 PETSC_EXTERN PetscErrorCode PetscFEGetTabulation(PetscFE, PetscInt, const PetscReal[], PetscReal **, PetscReal **, PetscReal **);
140 PETSC_EXTERN PetscErrorCode PetscFERestoreTabulation(PetscFE, PetscInt, const PetscReal[], PetscReal **, PetscReal **, PetscReal **);
141 PETSC_EXTERN PetscErrorCode PetscFERefine(PetscFE, PetscFE *);
142 
143 PETSC_EXTERN PetscErrorCode PetscFEIntegrate(PetscFE, PetscDS, PetscInt, PetscInt, PetscCellGeometry, const PetscScalar[], PetscDS, const PetscScalar[], PetscReal[]);
144 PETSC_EXTERN PetscErrorCode PetscFEIntegrateResidual(PetscFE, PetscDS, PetscInt, PetscInt, PetscCellGeometry, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
145 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdResidual(PetscFE, PetscDS, PetscInt, PetscInt, PetscCellGeometry, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
146 PETSC_EXTERN PetscErrorCode PetscFEIntegrateJacobian(PetscFE, PetscDS, PetscInt, PetscInt, PetscInt, PetscCellGeometry, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
147 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdJacobian(PetscFE, PetscDS, PetscInt, PetscInt, PetscInt, PetscCellGeometry, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
148 
149 PETSC_EXTERN PetscErrorCode PetscFEOpenCLSetRealType(PetscFE, PetscDataType);
150 PETSC_EXTERN PetscErrorCode PetscFEOpenCLGetRealType(PetscFE, PetscDataType *);
151 
152 #endif
153