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