xref: /petsc/include/petscfe.h (revision f19dbd5846ffd4db2e55501a1bb9a58c867a074c)
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 /* Assuming dim <= 3 */
12 typedef struct {
13   PetscReal v0[3];
14   PetscReal J[9];
15   PetscReal invJ[9];
16   PetscReal detJ;
17   PetscInt  dim;
18   PetscInt  dimEmbed;
19 } PetscFECellGeom;
20 
21 typedef struct {
22   PetscReal v0[3];
23   PetscReal J[9];       /* Size could be reduced to 6 */
24   PetscReal invJ[2][9]; /* invJ in the adjacent cells */
25   PetscReal detJ;       /* Not really the determinant of J, but \sqrt{\det{J^T J}} */
26   PetscReal n[3];
27   PetscInt  dim;
28   PetscInt  dimEmbed;
29   PetscInt  face[2];    /* The local face numbers in the adjacent cells */
30 } PetscFEFaceGeom;
31 
32 typedef struct _n_PetscFEGeom {
33   const PetscReal *xi;
34   PetscReal *v;
35   PetscReal *J;
36   PetscReal *invJ;
37   PetscReal *detJ;
38   PetscReal *n;
39   PetscInt  (*face)[2];
40   PetscInt  dim;
41   PetscInt  dimEmbed;
42   PetscInt  numCells;
43   PetscInt  numPoints;
44   PetscBool isAffine;
45 } PetscFEGeom;
46 
47 PETSC_EXTERN PetscErrorCode PetscFEInitializePackage(void);
48 
49 PETSC_EXTERN PetscClassId PETSCSPACE_CLASSID;
50 
51 /*J
52   PetscSpaceType - String with the name of a PETSc linear space
53 
54   Level: beginner
55 
56 .seealso: PetscSpaceSetType(), PetscSpace
57 J*/
58 typedef const char *PetscSpaceType;
59 #define PETSCSPACEPOLYNOMIAL "poly"
60 #define PETSCSPACEPOINT      "point"
61 #define PETSCSPACESUBSPACE   "subspace"
62 
63 PETSC_EXTERN PetscFunctionList PetscSpaceList;
64 PETSC_EXTERN PetscErrorCode PetscSpaceCreate(MPI_Comm, PetscSpace *);
65 PETSC_EXTERN PetscErrorCode PetscSpaceDestroy(PetscSpace *);
66 PETSC_EXTERN PetscErrorCode PetscSpaceSetType(PetscSpace, PetscSpaceType);
67 PETSC_EXTERN PetscErrorCode PetscSpaceGetType(PetscSpace, PetscSpaceType *);
68 PETSC_EXTERN PetscErrorCode PetscSpaceSetUp(PetscSpace);
69 PETSC_EXTERN PetscErrorCode PetscSpaceSetFromOptions(PetscSpace);
70 PETSC_STATIC_INLINE PetscErrorCode PetscSpaceViewFromOptions(PetscSpace A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
71 
72 PETSC_EXTERN PetscErrorCode PetscSpaceView(PetscSpace,PetscViewer);
73 PETSC_EXTERN PetscErrorCode PetscSpaceRegister(const char [], PetscErrorCode (*)(PetscSpace));
74 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterDestroy(void);
75 
76 PETSC_EXTERN PetscErrorCode PetscSpaceGetDimension(PetscSpace, PetscInt *);
77 PETSC_EXTERN PetscErrorCode PetscSpaceSetNumComponents(PetscSpace, PetscInt);
78 PETSC_EXTERN PetscErrorCode PetscSpaceGetNumComponents(PetscSpace, PetscInt *);
79 PETSC_EXTERN PetscErrorCode PetscSpaceSetNumVariables(PetscSpace, PetscInt);
80 PETSC_EXTERN PetscErrorCode PetscSpaceGetNumVariables(PetscSpace, PetscInt *);
81 PETSC_EXTERN PetscErrorCode PetscSpaceSetOrder(PetscSpace, PetscInt);
82 PETSC_EXTERN PetscErrorCode PetscSpaceGetOrder(PetscSpace, PetscInt *);
83 PETSC_EXTERN PetscErrorCode PetscSpaceEvaluate(PetscSpace, PetscInt, const PetscReal[], PetscReal[], PetscReal[], PetscReal[]);
84 PETSC_EXTERN PetscErrorCode PetscSpaceGetHeightSubspace(PetscSpace, PetscInt, PetscSpace *);
85 
86 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetSymmetric(PetscSpace, PetscBool);
87 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetSymmetric(PetscSpace, PetscBool *);
88 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetTensor(PetscSpace, PetscBool);
89 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetTensor(PetscSpace, PetscBool *);
90 
91 PETSC_EXTERN PetscErrorCode PetscSpacePointGetPoints(PetscSpace, PetscQuadrature *);
92 PETSC_EXTERN PetscErrorCode PetscSpacePointSetPoints(PetscSpace, PetscQuadrature);
93 
94 PETSC_EXTERN PetscErrorCode PetscSpaceCreateSubspace(PetscSpace, PetscDualSpace, PetscReal *, PetscReal *, PetscReal *, PetscReal *, PetscCopyMode, PetscSpace *);
95 
96 PETSC_EXTERN PetscClassId PETSCDUALSPACE_CLASSID;
97 
98 /*J
99   PetscDualSpaceType - String with the name of a PETSc dual space
100 
101   Level: beginner
102 
103 .seealso: PetscDualSpaceSetType(), PetscDualSpace
104 J*/
105 typedef const char *PetscDualSpaceType;
106 #define PETSCDUALSPACELAGRANGE "lagrange"
107 #define PETSCDUALSPACESIMPLE   "simple"
108 
109 PETSC_EXTERN PetscFunctionList PetscDualSpaceList;
110 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreate(MPI_Comm, PetscDualSpace *);
111 PETSC_EXTERN PetscErrorCode PetscDualSpaceDestroy(PetscDualSpace *);
112 PETSC_EXTERN PetscErrorCode PetscDualSpaceDuplicate(PetscDualSpace, PetscDualSpace *);
113 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetType(PetscDualSpace, PetscDualSpaceType);
114 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetType(PetscDualSpace, PetscDualSpaceType *);
115 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetNumDof(PetscDualSpace, const PetscInt **);
116 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreateSection(PetscDualSpace, PetscSection *);
117 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetUp(PetscDualSpace);
118 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetFromOptions(PetscDualSpace);
119 PETSC_STATIC_INLINE PetscErrorCode PetscDualSpaceViewFromOptions(PetscDualSpace A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
120 
121 PETSC_EXTERN PetscErrorCode PetscDualSpaceView(PetscDualSpace,PetscViewer);
122 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegister(const char [], PetscErrorCode (*)(PetscDualSpace));
123 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterDestroy(void);
124 
125 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDimension(PetscDualSpace, PetscInt *);
126 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetNumComponents(PetscDualSpace, PetscInt);
127 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetNumComponents(PetscDualSpace, PetscInt *);
128 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetOrder(PetscDualSpace, PetscInt);
129 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetOrder(PetscDualSpace, PetscInt *);
130 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetDM(PetscDualSpace, DM);
131 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDM(PetscDualSpace, DM *);
132 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetFunctional(PetscDualSpace, PetscInt, PetscQuadrature *);
133 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreateReferenceCell(PetscDualSpace, PetscInt, PetscBool, DM *);
134 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetSymmetries(PetscDualSpace, const PetscInt ****, const PetscScalar ****);
135 
136 PETSC_EXTERN PetscErrorCode PetscFEGeomCreate(PetscQuadrature,PetscInt,PetscInt,PetscBool,PetscFEGeom**);
137 PETSC_EXTERN PetscErrorCode PetscFEGeomGetChunk(PetscFEGeom*,PetscInt,PetscInt,PetscFEGeom**);
138 PETSC_EXTERN PetscErrorCode PetscFEGeomRestoreChunk(PetscFEGeom*,PetscInt,PetscInt,PetscFEGeom**);
139 PETSC_EXTERN PetscErrorCode PetscFEGeomComplete(PetscFEGeom*);
140 PETSC_EXTERN PetscErrorCode PetscFEGeomDestroy(PetscFEGeom**);
141 
142 PETSC_EXTERN PetscErrorCode PetscDualSpaceApply(PetscDualSpace, PetscInt, PetscReal, PetscFECellGeom *, PetscInt, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void *, PetscScalar *);
143 PETSC_EXTERN PetscErrorCode PetscDualSpaceApplyDefault(PetscDualSpace, PetscInt, PetscReal, PetscFECellGeom *, PetscInt, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void *, PetscScalar *);
144 
145 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeGetContinuity(PetscDualSpace, PetscBool *);
146 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeSetContinuity(PetscDualSpace, PetscBool);
147 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeGetTensor(PetscDualSpace, PetscBool *);
148 PETSC_EXTERN PetscErrorCode PetscDualSpaceLagrangeSetTensor(PetscDualSpace, PetscBool);
149 
150 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetHeightSubspace(PetscDualSpace,PetscInt,PetscDualSpace *);
151 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetPointSubspace(PetscDualSpace,PetscInt,PetscDualSpace *);
152 PETSC_EXTERN PetscErrorCode PetscDualSpaceSimpleSetDimension(PetscDualSpace, PetscInt);
153 PETSC_EXTERN PetscErrorCode PetscDualSpaceSimpleSetFunctional(PetscDualSpace, PetscInt, PetscQuadrature);
154 
155 PETSC_EXTERN PetscClassId PETSCFE_CLASSID;
156 
157 /*J
158   PetscFEType - String with the name of a PETSc finite element space
159 
160   Level: beginner
161 
162   Note: Currently, the classes are concerned with the implementation of element integration
163 
164 .seealso: PetscFESetType(), PetscFE
165 J*/
166 typedef const char *PetscFEType;
167 #define PETSCFEBASIC     "basic"
168 #define PETSCFENONAFFINE "nonaffine"
169 #define PETSCFEOPENCL    "opencl"
170 #define PETSCFECOMPOSITE "composite"
171 
172 PETSC_EXTERN PetscFunctionList PetscFEList;
173 PETSC_EXTERN PetscErrorCode PetscFECreate(MPI_Comm, PetscFE *);
174 PETSC_EXTERN PetscErrorCode PetscFEDestroy(PetscFE *);
175 PETSC_EXTERN PetscErrorCode PetscFESetType(PetscFE, PetscFEType);
176 PETSC_EXTERN PetscErrorCode PetscFEGetType(PetscFE, PetscFEType *);
177 PETSC_EXTERN PetscErrorCode PetscFESetUp(PetscFE);
178 PETSC_EXTERN PetscErrorCode PetscFESetFromOptions(PetscFE);
179 PETSC_STATIC_INLINE PetscErrorCode PetscFEViewFromOptions(PetscFE A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
180 
181 PETSC_EXTERN PetscErrorCode PetscFEView(PetscFE,PetscViewer);
182 PETSC_EXTERN PetscErrorCode PetscFERegister(const char [], PetscErrorCode (*)(PetscFE));
183 PETSC_EXTERN PetscErrorCode PetscFERegisterDestroy(void);
184 PETSC_EXTERN PetscErrorCode PetscFECreateDefault(DM, PetscInt, PetscInt, PetscBool, const char [], PetscInt, PetscFE *);
185 
186 PETSC_EXTERN PetscErrorCode PetscFEGetDimension(PetscFE, PetscInt *);
187 PETSC_EXTERN PetscErrorCode PetscFEGetSpatialDimension(PetscFE, PetscInt *);
188 PETSC_EXTERN PetscErrorCode PetscFESetNumComponents(PetscFE, PetscInt);
189 PETSC_EXTERN PetscErrorCode PetscFEGetNumComponents(PetscFE, PetscInt *);
190 PETSC_EXTERN PetscErrorCode PetscFEGetTileSizes(PetscFE, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
191 PETSC_EXTERN PetscErrorCode PetscFESetTileSizes(PetscFE, PetscInt, PetscInt, PetscInt, PetscInt);
192 PETSC_EXTERN PetscErrorCode PetscFESetBasisSpace(PetscFE, PetscSpace);
193 PETSC_EXTERN PetscErrorCode PetscFEGetBasisSpace(PetscFE, PetscSpace *);
194 PETSC_EXTERN PetscErrorCode PetscFESetDualSpace(PetscFE, PetscDualSpace);
195 PETSC_EXTERN PetscErrorCode PetscFEGetDualSpace(PetscFE, PetscDualSpace *);
196 PETSC_EXTERN PetscErrorCode PetscFESetQuadrature(PetscFE, PetscQuadrature);
197 PETSC_EXTERN PetscErrorCode PetscFEGetQuadrature(PetscFE, PetscQuadrature *);
198 PETSC_EXTERN PetscErrorCode PetscFESetFaceQuadrature(PetscFE, PetscQuadrature);
199 PETSC_EXTERN PetscErrorCode PetscFEGetFaceQuadrature(PetscFE, PetscQuadrature *);
200 PETSC_EXTERN PetscErrorCode PetscFEGetNumDof(PetscFE, const PetscInt **);
201 PETSC_EXTERN PetscErrorCode PetscFEGetDefaultTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
202 PETSC_EXTERN PetscErrorCode PetscFEGetFaceTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
203 PETSC_EXTERN PetscErrorCode PetscFEGetFaceCentroidTabulation(PetscFE, PetscReal **);
204 PETSC_EXTERN PetscErrorCode PetscFEGetTabulation(PetscFE, PetscInt, const PetscReal[], PetscReal **, PetscReal **, PetscReal **);
205 PETSC_EXTERN PetscErrorCode PetscFERestoreTabulation(PetscFE, PetscInt, const PetscReal[], PetscReal **, PetscReal **, PetscReal **);
206 PETSC_EXTERN PetscErrorCode PetscFERefine(PetscFE, PetscFE *);
207 PETSC_EXTERN PetscErrorCode PetscFEGetHeightSubspace(PetscFE, PetscInt, PetscFE *);
208 
209 PETSC_EXTERN PetscErrorCode PetscFEIntegrate(PetscFE, PetscDS, PetscInt, PetscInt, PetscFECellGeom *, const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
210 PETSC_EXTERN PetscErrorCode PetscFEIntegrateResidual(PetscFE, PetscDS, PetscInt, PetscInt, PetscFECellGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscScalar[]);
211 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdResidual(PetscFE, PetscDS, PetscInt, PetscInt, PetscFEFaceGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscScalar[]);
212 PETSC_EXTERN PetscErrorCode PetscFEIntegrateJacobian(PetscFE, PetscDS, PetscFEJacobianType, PetscInt, PetscInt, PetscInt, PetscFECellGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscReal, PetscScalar[]);
213 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdJacobian(PetscFE, PetscDS, PetscInt, PetscInt, PetscInt, PetscFEFaceGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscReal, PetscScalar[]);
214 
215 PETSC_EXTERN PetscErrorCode PetscFECompositeGetMapping(PetscFE, PetscInt *, const PetscReal *[], const PetscReal *[], const PetscReal *[]);
216 
217 PETSC_EXTERN PetscErrorCode PetscFECreateHeightTrace(PetscFE, PetscInt, PetscFE *);
218 PETSC_EXTERN PetscErrorCode PetscFECreatePointTrace(PetscFE, PetscInt, PetscFE *);
219 
220 PETSC_EXTERN PetscErrorCode PetscFEOpenCLSetRealType(PetscFE, PetscDataType);
221 PETSC_EXTERN PetscErrorCode PetscFEOpenCLGetRealType(PetscFE, PetscDataType *);
222 
223 #endif
224