xref: /petsc/include/petscfe.h (revision a0845e3a928e8c3de76a3c8bfba8b69f6cc922fe)
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 
10 PETSC_EXTERN PetscErrorCode PetscFEInitializePackage(void);
11 
12 PETSC_EXTERN PetscClassId PETSCSPACE_CLASSID;
13 
14 /*J
15   PetscSpaceType - String with the name of a PETSc linear space
16 
17   Level: beginner
18 
19 .seealso: PetscSpaceSetType(), PetscSpace
20 J*/
21 typedef const char *PetscSpaceType;
22 #define PETSCSPACEPOLYNOMIAL "poly"
23 
24 PETSC_EXTERN PetscFunctionList PetscSpaceList;
25 PETSC_EXTERN PetscBool         PetscSpaceRegisterAllCalled;
26 PETSC_EXTERN PetscErrorCode PetscSpaceCreate(MPI_Comm, PetscSpace *);
27 PETSC_EXTERN PetscErrorCode PetscSpaceDestroy(PetscSpace *);
28 PETSC_EXTERN PetscErrorCode PetscSpaceSetType(PetscSpace, PetscSpaceType);
29 PETSC_EXTERN PetscErrorCode PetscSpaceGetType(PetscSpace, PetscSpaceType *);
30 PETSC_EXTERN PetscErrorCode PetscSpaceSetUp(PetscSpace);
31 PETSC_EXTERN PetscErrorCode PetscSpaceSetFromOptions(PetscSpace);
32 PETSC_EXTERN PetscErrorCode PetscSpaceRegister(const char [], PetscErrorCode (*)(PetscSpace));
33 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterAll(void);
34 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterDestroy(void);
35 
36 PETSC_EXTERN PetscErrorCode PetscSpaceGetDimension(PetscSpace, PetscInt *);
37 PETSC_EXTERN PetscErrorCode PetscSpaceSetOrder(PetscSpace, PetscInt);
38 PETSC_EXTERN PetscErrorCode PetscSpaceGetOrder(PetscSpace, PetscInt *);
39 
40 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetNumVariables(PetscSpace, PetscInt);
41 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetNumVariables(PetscSpace, PetscInt *);
42 
43 PETSC_EXTERN PetscClassId PETSCDUALSPACE_CLASSID;
44 
45 /*J
46   PetscDualSpaceType - String with the name of a PETSc dual space
47 
48   Level: beginner
49 
50 .seealso: PetscDualSpaceSetType(), PetscDualSpace
51 J*/
52 typedef const char *PetscDualSpaceType;
53 #define PETSCDUALSPACELAGRANGE "lagrange"
54 
55 PETSC_EXTERN PetscFunctionList PetscDualSpaceList;
56 PETSC_EXTERN PetscBool         PetscDualSpaceRegisterAllCalled;
57 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreate(MPI_Comm, PetscDualSpace *);
58 PETSC_EXTERN PetscErrorCode PetscDualSpaceDestroy(PetscDualSpace *);
59 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetType(PetscDualSpace, PetscDualSpaceType);
60 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetType(PetscDualSpace, PetscDualSpaceType *);
61 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetUp(PetscDualSpace);
62 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetFromOptions(PetscDualSpace);
63 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegister(const char [], PetscErrorCode (*)(PetscDualSpace));
64 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterAll(void);
65 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterDestroy(void);
66 
67 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDimension(PetscDualSpace, PetscInt *);
68 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetOrder(PetscDualSpace, PetscInt);
69 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetOrder(PetscDualSpace, PetscInt *);
70 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetDM(PetscDualSpace, DM);
71 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDM(PetscDualSpace, DM *);
72 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreateReferenceCell(PetscDualSpace, PetscInt, PetscBool, DM *);
73 
74 PETSC_EXTERN PetscClassId PETSCFE_CLASSID;
75 
76 PETSC_EXTERN PetscErrorCode PetscFECreate(MPI_Comm, PetscFE *);
77 PETSC_EXTERN PetscErrorCode PetscFEDestroy(PetscFE *);
78 
79 PETSC_EXTERN PetscErrorCode PetscFEGetDimension(PetscFE, PetscInt *);
80 PETSC_EXTERN PetscErrorCode PetscFEGetSpatialDimension(PetscFE, PetscInt *);
81 PETSC_EXTERN PetscErrorCode PetscFESetNumComponents(PetscFE, PetscInt);
82 PETSC_EXTERN PetscErrorCode PetscFEGetNumComponents(PetscFE, PetscInt *);
83 PETSC_EXTERN PetscErrorCode PetscFESetBasisSpace(PetscFE, PetscSpace);
84 PETSC_EXTERN PetscErrorCode PetscFEGetBasisSpace(PetscFE, PetscSpace *);
85 PETSC_EXTERN PetscErrorCode PetscFESetDualSpace(PetscFE, PetscDualSpace);
86 PETSC_EXTERN PetscErrorCode PetscFEGetDualSpace(PetscFE, PetscDualSpace *);
87 PETSC_EXTERN PetscErrorCode PetscFESetQuadrature(PetscFE, PetscQuadrature);
88 PETSC_EXTERN PetscErrorCode PetscFEGetQuadrature(PetscFE, PetscQuadrature *);
89 PETSC_EXTERN PetscErrorCode PetscFEGetNumDof(PetscFE, const PetscInt **);
90 PETSC_EXTERN PetscErrorCode PetscFEGetTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
91 PETSC_EXTERN PetscErrorCode PetscFERestoreTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
92 
93 
94 typedef struct {
95   PetscFE         *fe;
96   PetscQuadrature *quad;
97   void (**f0Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The f_0 functions for each field */
98   void (**f1Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The f_1 functions for each field */
99   void (**g0Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The g_0 functions for each field pair */
100   void (**g1Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The g_1 functions for each field pair */
101   void (**g2Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The g_2 functions for each field pair */
102   void (**g3Funcs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]); /* The g_3 functions for each field pair */
103   void (**bcFuncs)(const PetscReal[], PetscScalar *); /* The boundary condition function for each field component */
104   PetscQuadrature *quadBd;
105   void (**f0BdFuncs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], const PetscReal[], PetscScalar[]); /* The f_0 functions for each field */
106   void (**f1BdFuncs)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], const PetscReal[], PetscScalar[]); /* The f_1 functions for each field */
107 } PetscFEM;
108 
109 PETSC_EXTERN PetscErrorCode PetscFEIntegrateResidualChunk(PetscInt, PetscInt, PetscFE[], PetscInt, PetscCellGeometry, const PetscScalar[],
110                                                           void (*)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]),
111                                                           void (*)(const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscReal[], PetscScalar[]),
112                                                           PetscScalar[]);
113 #endif
114