xref: /petsc/include/petscfe.h (revision 89a8e22d45cf8ef376b46ea5983ec24985e49039)
1 /*
2       Objects which encapsulate finite element spaces and operations
3 */
4 #pragma once
5 #include <petscdm.h>
6 #include <petscdt.h>
7 #include <petscfetypes.h>
8 #include <petscdstypes.h>
9 #include <petscspace.h>
10 #include <petscdualspace.h>
11 
12 /* SUBMANSEC = FE */
13 
14 /*MC
15     PetscFEGeom - Structure for geometric information for `PetscFE`
16 
17     Level: intermediate
18 
19     Note:
20     This is a struct, not a `PetscObject`
21 
22 .seealso: `PetscFE`, `PetscFEGeomCreate()`, `PetscFEGeomDestroy()`, `PetscFEGeomGetChunk()`, `PetscFEGeomRestoreChunk()`, `PetscFEGeomGetPoint()`, `PetscFEGeomGetCellPoint()`,
23           `PetscFEGeomComplete()`, `PetscSpace`, `PetscDualSpace`
24 M*/
25 typedef struct _n_PetscFEGeom {
26   // We can represent several different types of geometry, which we call modes:
27   //   basic:    dim == dE, only bulk data
28   //     These are normal dim-cells
29   //   embedded: dim < dE, only bulk data
30   //     These are dim-cells embedded in a higher dimension, as an embedded manifold
31   //   boundary: dim < dE, bulk and face data
32   //     These are dim-cells on the boundary of a dE-mesh
33   //   cohesive: dim < dE, bulk and face data
34   //     These are dim-cells in the interior of a dE-mesh
35   //   affine:
36   //     For all modes, the transforms between real and reference are affine
37   PetscFEGeomMode mode;     // The type of geometric data stored
38   PetscBool       isAffine; // Flag for affine transforms
39   // Sizes
40   PetscInt dim;       // dim: topological dimension and reference coordinate dimension
41   PetscInt dimEmbed;  // dE:  real coordinate dimension
42   PetscInt numCells;  // Nc:  Number of mesh points represented in the arrays (points are assumed to be the same DMPolytopeType)
43   PetscInt numPoints; // Np:  Number of evaluation points represented in the arrays
44   // Bulk data
45   const PetscReal *xi;   // xi[dim]                The first point in each cell in reference coordinates
46   PetscReal       *v;    // v[Nc*Np*dE]:           The first point in each cell in real coordinates
47   PetscReal       *J;    // J[Nc*Np*dE*dE]:        The Jacobian of the map from reference to real coordinates (if nonsquare it is completed with orthogonal columns)
48   PetscReal       *invJ; // invJ[Nc*Np*dE*dE]:     The inverse of the Jacobian of the map from reference to real coordinates (if nonsquare it is completed with orthogonal columns)
49   PetscReal       *detJ; // detJ[Nc*Np]:           The determinant of J, and if J is non-square it is the volume change
50   // Face data
51   PetscReal *n;           // n[Nc*Np*dE]:           For faces, the normal to the face in real coordinates, outward for the first supporting cell
52   PetscInt (*face)[4];    // face[Nc][s*2]:         For faces, the local face number (cone index) and orientation for this face in each supporting cell
53   PetscReal *suppJ[2];    // sJ[s][Nc*Np*dE*dE]:    For faces, the Jacobian for each supporting cell
54   PetscReal *suppInvJ[2]; // sInvJ[s][Nc*Np*dE*dE]: For faces, the inverse Jacobian for each supporting cell
55   PetscReal *suppDetJ[2]; // sdetJ[s][Nc*Np]:       For faces, the Jacobian determinant for each supporting cell
56 } PetscFEGeom;
57 
58 PETSC_EXTERN PetscErrorCode PetscFEInitializePackage(void);
59 
60 PETSC_EXTERN PetscErrorCode PetscFEGeomCreate(PetscQuadrature, PetscInt, PetscInt, PetscFEGeomMode, PetscFEGeom **);
61 PETSC_EXTERN PetscErrorCode PetscFEGeomGetChunk(PetscFEGeom *, PetscInt, PetscInt, PetscFEGeom **);
62 PETSC_EXTERN PetscErrorCode PetscFEGeomRestoreChunk(PetscFEGeom *, PetscInt, PetscInt, PetscFEGeom **);
63 PETSC_EXTERN PetscErrorCode PetscFEGeomGetPoint(PetscFEGeom *, PetscInt, PetscInt, const PetscReal[], PetscFEGeom *);
64 PETSC_EXTERN PetscErrorCode PetscFEGeomGetCellPoint(PetscFEGeom *, PetscInt, PetscInt, PetscFEGeom *);
65 PETSC_EXTERN PetscErrorCode PetscFEGeomComplete(PetscFEGeom *);
66 PETSC_EXTERN PetscErrorCode PetscFEGeomDestroy(PetscFEGeom **);
67 
68 PETSC_EXTERN PetscErrorCode PetscDualSpaceApply(PetscDualSpace, PetscInt, PetscReal, PetscFEGeom *, PetscInt, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void *, PetscScalar *);
69 PETSC_EXTERN PetscErrorCode PetscDualSpaceApplyDefault(PetscDualSpace, PetscInt, PetscReal, PetscFEGeom *, PetscInt, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void *, PetscScalar *);
70 
71 PETSC_EXTERN PetscErrorCode PetscDualSpaceTransform(PetscDualSpace, PetscDualSpaceTransformType, PetscBool, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
72 PETSC_EXTERN PetscErrorCode PetscDualSpaceTransformGradient(PetscDualSpace, PetscDualSpaceTransformType, PetscBool, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
73 PETSC_EXTERN PetscErrorCode PetscDualSpaceTransformHessian(PetscDualSpace, PetscDualSpaceTransformType, PetscBool, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
74 PETSC_EXTERN PetscErrorCode PetscDualSpacePullback(PetscDualSpace, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
75 PETSC_EXTERN PetscErrorCode PetscDualSpacePushforward(PetscDualSpace, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
76 PETSC_EXTERN PetscErrorCode PetscDualSpacePushforwardGradient(PetscDualSpace, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
77 PETSC_EXTERN PetscErrorCode PetscDualSpacePushforwardHessian(PetscDualSpace, PetscFEGeom *, PetscInt, PetscInt, PetscScalar[]);
78 
79 PETSC_EXTERN PetscClassId PETSCFE_CLASSID;
80 
81 /*J
82   PetscFEType - String with the name of a PETSc finite element space
83 
84   Level: beginner
85 
86   Note:
87   Currently, the classes are concerned with the implementation of element integration
88 
89 .seealso: `PetscFESetType()`, `PetscFE`
90 J*/
91 typedef const char *PetscFEType;
92 #define PETSCFEBASIC     "basic"
93 #define PETSCFEOPENCL    "opencl"
94 #define PETSCFECOMPOSITE "composite"
95 #define PETSCFEVECTOR    "vector"
96 
97 PETSC_EXTERN PetscFunctionList PetscFEList;
98 PETSC_EXTERN PetscErrorCode    PetscFECreate(MPI_Comm, PetscFE *);
99 PETSC_EXTERN PetscErrorCode    PetscFEDestroy(PetscFE *);
100 PETSC_EXTERN PetscErrorCode    PetscFESetType(PetscFE, PetscFEType);
101 PETSC_EXTERN PetscErrorCode    PetscFEGetType(PetscFE, PetscFEType *);
102 PETSC_EXTERN PetscErrorCode    PetscFESetUp(PetscFE);
103 PETSC_EXTERN PetscErrorCode    PetscFESetFromOptions(PetscFE);
104 PETSC_EXTERN PetscErrorCode    PetscFEViewFromOptions(PetscFE, PetscObject, const char[]);
105 PETSC_EXTERN PetscErrorCode    PetscFESetName(PetscFE, const char[]);
106 PETSC_EXTERN PetscErrorCode    PetscFECreateVector(PetscFE, PetscInt, PetscBool, PetscBool, PetscFE *);
107 
108 PETSC_EXTERN PetscErrorCode PetscFEView(PetscFE, PetscViewer);
109 PETSC_EXTERN PetscErrorCode PetscFERegister(const char[], PetscErrorCode (*)(PetscFE));
110 PETSC_EXTERN PetscErrorCode PetscFERegisterDestroy(void);
111 PETSC_EXTERN PetscErrorCode PetscFECreateDefault(MPI_Comm, PetscInt, PetscInt, PetscBool, const char[], PetscInt, PetscFE *);
112 PETSC_EXTERN PetscErrorCode PetscFECreateByCell(MPI_Comm, PetscInt, PetscInt, DMPolytopeType, const char[], PetscInt, PetscFE *);
113 PETSC_EXTERN PetscErrorCode PetscFECreateLagrange(MPI_Comm, PetscInt, PetscInt, PetscBool, PetscInt, PetscInt, PetscFE *);
114 PETSC_EXTERN PetscErrorCode PetscFECreateLagrangeByCell(MPI_Comm, PetscInt, PetscInt, DMPolytopeType, PetscInt, PetscInt, PetscFE *);
115 PETSC_EXTERN PetscErrorCode PetscFECreateFromSpaces(PetscSpace, PetscDualSpace, PetscQuadrature, PetscQuadrature, PetscFE *);
116 PETSC_EXTERN PetscErrorCode PetscFELimitDegree(PetscFE, PetscInt, PetscInt, PetscFE *);
117 
118 PETSC_EXTERN PetscErrorCode PetscFEGetDimension(PetscFE, PetscInt *);
119 PETSC_EXTERN PetscErrorCode PetscFEGetSpatialDimension(PetscFE, PetscInt *);
120 PETSC_EXTERN PetscErrorCode PetscFESetNumComponents(PetscFE, PetscInt);
121 PETSC_EXTERN PetscErrorCode PetscFEGetNumComponents(PetscFE, PetscInt *);
122 PETSC_EXTERN PetscErrorCode PetscFEGetTileSizes(PetscFE, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
123 PETSC_EXTERN PetscErrorCode PetscFESetTileSizes(PetscFE, PetscInt, PetscInt, PetscInt, PetscInt);
124 PETSC_EXTERN PetscErrorCode PetscFESetBasisSpace(PetscFE, PetscSpace);
125 PETSC_EXTERN PetscErrorCode PetscFEGetBasisSpace(PetscFE, PetscSpace *);
126 PETSC_EXTERN PetscErrorCode PetscFESetDualSpace(PetscFE, PetscDualSpace);
127 PETSC_EXTERN PetscErrorCode PetscFEGetDualSpace(PetscFE, PetscDualSpace *);
128 PETSC_EXTERN PetscErrorCode PetscFESetQuadrature(PetscFE, PetscQuadrature);
129 PETSC_EXTERN PetscErrorCode PetscFEGetQuadrature(PetscFE, PetscQuadrature *);
130 PETSC_EXTERN PetscErrorCode PetscFESetFaceQuadrature(PetscFE, PetscQuadrature);
131 PETSC_EXTERN PetscErrorCode PetscFEGetFaceQuadrature(PetscFE, PetscQuadrature *);
132 PETSC_EXTERN PetscErrorCode PetscFECopyQuadrature(PetscFE, PetscFE);
133 PETSC_EXTERN PetscErrorCode PetscFEGetNumDof(PetscFE, const PetscInt **);
134 
135 /* TODO: Need a function to reuse the memory when retabulating the same FE at different points */
136 PETSC_EXTERN PetscErrorCode PetscFEGetCellTabulation(PetscFE, PetscInt, PetscTabulation *);
137 PETSC_EXTERN PetscErrorCode PetscFEGetFaceTabulation(PetscFE, PetscInt, PetscTabulation *);
138 PETSC_EXTERN PetscErrorCode PetscFEGetFaceCentroidTabulation(PetscFE, PetscTabulation *);
139 PETSC_EXTERN PetscErrorCode PetscFECreateTabulation(PetscFE, PetscInt, PetscInt, const PetscReal[], PetscInt, PetscTabulation *);
140 PETSC_EXTERN PetscErrorCode PetscFEComputeTabulation(PetscFE, PetscInt, const PetscReal[], PetscInt, PetscTabulation);
141 PETSC_EXTERN PetscErrorCode PetscTabulationDestroy(PetscTabulation *);
142 
143 PETSC_EXTERN PetscErrorCode PetscFERefine(PetscFE, PetscFE *);
144 PETSC_EXTERN PetscErrorCode PetscFEGetHeightSubspace(PetscFE, PetscInt, PetscFE *);
145 
146 PETSC_EXTERN PetscErrorCode PetscFECreateCellGeometry(PetscFE, PetscQuadrature, PetscFEGeom *);
147 PETSC_EXTERN PetscErrorCode PetscFEDestroyCellGeometry(PetscFE, PetscFEGeom *);
148 PETSC_EXTERN PetscErrorCode PetscFEPushforward(PetscFE, PetscFEGeom *, PetscInt, PetscScalar[]);
149 PETSC_EXTERN PetscErrorCode PetscFEPushforwardGradient(PetscFE, PetscFEGeom *, PetscInt, PetscScalar[]);
150 PETSC_EXTERN PetscErrorCode PetscFEPushforwardHessian(PetscFE, PetscFEGeom *, PetscInt, PetscScalar[]);
151 
152 PETSC_EXTERN PetscErrorCode PetscFEIntegrate(PetscDS, PetscInt, PetscInt, PetscFEGeom *, const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
153 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBd(PetscDS, PetscInt, void (*)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), PetscInt, PetscFEGeom *, const PetscScalar[], PetscDS, const PetscScalar[], PetscScalar[]);
154 PETSC_EXTERN PetscErrorCode PetscFEIntegrateResidual(PetscDS, PetscFormKey, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscScalar[]);
155 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdResidual(PetscDS, PetscWeakForm, PetscFormKey, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscScalar[]);
156 PETSC_EXTERN PetscErrorCode PetscFEIntegrateHybridResidual(PetscDS, PetscDS, PetscFormKey, PetscInt, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscScalar[]);
157 PETSC_EXTERN PetscErrorCode PetscFEIntegrateJacobian(PetscDS, PetscFEJacobianType, PetscFormKey, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscReal, PetscScalar[]);
158 PETSC_EXTERN PetscErrorCode PetscFEIntegrateBdJacobian(PetscDS, PetscWeakForm, PetscFEJacobianType, PetscFormKey, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscReal, PetscScalar[]);
159 PETSC_EXTERN PetscErrorCode PetscFEIntegrateHybridJacobian(PetscDS, PetscDS, PetscFEJacobianType, PetscFormKey, PetscInt, PetscInt, PetscFEGeom *, const PetscScalar[], const PetscScalar[], PetscDS, const PetscScalar[], PetscReal, PetscReal, PetscScalar[]);
160 
161 PETSC_EXTERN PetscErrorCode PetscFECompositeGetMapping(PetscFE, PetscInt *, const PetscReal *[], const PetscReal *[], const PetscReal *[]);
162 
163 PETSC_EXTERN PetscErrorCode PetscFECreateHeightTrace(PetscFE, PetscInt, PetscFE *);
164 PETSC_EXTERN PetscErrorCode PetscFECreatePointTrace(PetscFE, PetscInt, PetscFE *);
165 
166 PETSC_EXTERN PetscErrorCode PetscFEOpenCLSetRealType(PetscFE, PetscDataType);
167 PETSC_EXTERN PetscErrorCode PetscFEOpenCLGetRealType(PetscFE, PetscDataType *);
168 
169 #ifdef PETSC_HAVE_LIBCEED
170 
171   #ifndef PLEXFE_QFUNCTION
172     #define PLEXFE_QFUNCTION(fname, f0_name, f1_name) \
173       CEED_QFUNCTION(PlexQFunction##fname)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) \
174       { \
175         const CeedScalar *u = in[0], *du = in[1], *qdata = in[2]; \
176         CeedScalar       *v = out[0], *dv = out[1]; \
177         const PetscInt    Nc   = 1; \
178         const PetscInt    cdim = 2; \
179 \
180         CeedPragmaSIMD for (CeedInt i = 0; i < Q; ++i) \
181         { \
182           const PetscInt   uOff[2]    = {0, Nc}; \
183           const PetscInt   uOff_x[2]  = {0, Nc * cdim}; \
184           const CeedScalar x[2]       = {qdata[i + Q * 1], qdata[i + Q * 2]}; \
185           const CeedScalar invJ[2][2] = { \
186             {qdata[i + Q * 3], qdata[i + Q * 5]}, \
187             {qdata[i + Q * 4], qdata[i + Q * 6]} \
188           }; \
189           const CeedScalar u_x[2] = {invJ[0][0] * du[i + Q * 0] + invJ[1][0] * du[i + Q * 1], invJ[0][1] * du[i + Q * 0] + invJ[1][1] * du[i + Q * 1]}; \
190           PetscScalar      f0[Nc]; \
191           PetscScalar      f1[Nc * cdim]; \
192 \
193           for (PetscInt k = 0; k < Nc; ++k) f0[k] = 0; \
194           for (PetscInt k = 0; k < Nc * cdim; ++k) f1[k] = 0; \
195           f0_name(2, 1, 0, uOff, uOff_x, u, NULL, u_x, NULL, NULL, NULL, NULL, NULL, 0.0, x, 0, NULL, f0); \
196           f1_name(2, 1, 0, uOff, uOff_x, u, NULL, u_x, NULL, NULL, NULL, NULL, NULL, 0.0, x, 0, NULL, f1); \
197 \
198           dv[i + Q * 0] = qdata[i + Q * 0] * (invJ[0][0] * f1[0] + invJ[0][1] * f1[1]); \
199           dv[i + Q * 1] = qdata[i + Q * 0] * (invJ[1][0] * f1[0] + invJ[1][1] * f1[1]); \
200           v[i]          = qdata[i + Q * 0] * f0[0]; \
201         } \
202         return CEED_ERROR_SUCCESS; \
203       }
204   #endif
205 
206 #else
207 
208   #ifndef PLEXFE_QFUNCTION
209     #define PLEXFE_QFUNCTION(fname, f0_name, f1_name)
210   #endif
211 
212 #endif
213