xref: /petsc/include/petscfe.h (revision e759306c81bae4223bce90effddf19e923653c3b)
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 <petscfetypes.h>
8 
9 PETSC_EXTERN PetscErrorCode PetscFEInitializePackage(void);
10 
11 PETSC_EXTERN PetscClassId PETSCSPACE_CLASSID;
12 
13 /*J
14   PetscSpaceType - String with the name of a PETSc linear space
15 
16   Level: beginner
17 
18 .seealso: PetscSpaceSetType(), PetscSpace
19 J*/
20 typedef const char *PetscSpaceType;
21 #define PETSCSPACEPOLYNOMIAL "poly"
22 
23 PETSC_EXTERN PetscFunctionList PetscSpaceList;
24 PETSC_EXTERN PetscBool         PetscSpaceRegisterAllCalled;
25 PETSC_EXTERN PetscErrorCode PetscSpaceCreate(MPI_Comm, PetscSpace *);
26 PETSC_EXTERN PetscErrorCode PetscSpaceDestroy(PetscSpace *);
27 PETSC_EXTERN PetscErrorCode PetscSpaceSetType(PetscSpace, PetscSpaceType);
28 PETSC_EXTERN PetscErrorCode PetscSpaceGetType(PetscSpace, PetscSpaceType *);
29 PETSC_EXTERN PetscErrorCode PetscSpaceSetUp(PetscSpace);
30 PETSC_EXTERN PetscErrorCode PetscSpaceSetFromOptions(PetscSpace);
31 PETSC_EXTERN PetscErrorCode PetscSpaceRegister(const char [], PetscErrorCode (*)(PetscSpace));
32 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterAll(void);
33 PETSC_EXTERN PetscErrorCode PetscSpaceRegisterDestroy(void);
34 
35 PETSC_EXTERN PetscErrorCode PetscSpaceGetDimension(PetscSpace, PetscInt *);
36 PETSC_EXTERN PetscErrorCode PetscSpaceSetOrder(PetscSpace, PetscInt);
37 PETSC_EXTERN PetscErrorCode PetscSpaceGetOrder(PetscSpace, PetscInt *);
38 
39 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialSetNumVariables(PetscSpace, PetscInt);
40 PETSC_EXTERN PetscErrorCode PetscSpacePolynomialGetNumVariables(PetscSpace, PetscInt *);
41 
42 PETSC_EXTERN PetscClassId PETSCDUALSPACE_CLASSID;
43 
44 /*J
45   PetscDualSpaceType - String with the name of a PETSc dual space
46 
47   Level: beginner
48 
49 .seealso: PetscDualSpaceSetType(), PetscDualSpace
50 J*/
51 typedef const char *PetscDualSpaceType;
52 #define PETSCDUALSPACELAGRANGE "lagrange"
53 
54 PETSC_EXTERN PetscFunctionList PetscDualSpaceList;
55 PETSC_EXTERN PetscBool         PetscDualSpaceRegisterAllCalled;
56 PETSC_EXTERN PetscErrorCode PetscDualSpaceCreate(MPI_Comm, PetscDualSpace *);
57 PETSC_EXTERN PetscErrorCode PetscDualSpaceDestroy(PetscDualSpace *);
58 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetType(PetscDualSpace, PetscDualSpaceType);
59 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetType(PetscDualSpace, PetscDualSpaceType *);
60 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetUp(PetscDualSpace);
61 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetFromOptions(PetscDualSpace);
62 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegister(const char [], PetscErrorCode (*)(PetscDualSpace));
63 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterAll(void);
64 PETSC_EXTERN PetscErrorCode PetscDualSpaceRegisterDestroy(void);
65 
66 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDimension(PetscDualSpace, PetscInt *);
67 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetOrder(PetscDualSpace, PetscInt);
68 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetOrder(PetscDualSpace, PetscInt *);
69 PETSC_EXTERN PetscErrorCode PetscDualSpaceSetDM(PetscDualSpace, DM);
70 PETSC_EXTERN PetscErrorCode PetscDualSpaceGetDM(PetscDualSpace, DM *);
71 
72 PETSC_EXTERN PetscClassId PETSCFE_CLASSID;
73 
74 PETSC_EXTERN PetscErrorCode PetscFECreate(MPI_Comm, PetscFE *);
75 PETSC_EXTERN PetscErrorCode PetscFEDestroy(PetscFE *);
76 
77 PETSC_EXTERN PetscErrorCode PetscFEGetDimension(PetscFE, PetscInt *);
78 PETSC_EXTERN PetscErrorCode PetscFESetNumComponents(PetscFE, PetscInt);
79 PETSC_EXTERN PetscErrorCode PetscFEGetNumComponents(PetscFE, PetscInt *);
80 PETSC_EXTERN PetscErrorCode PetscFESetBasisSpace(PetscFE, PetscSpace);
81 PETSC_EXTERN PetscErrorCode PetscFEGetBasisSpace(PetscFE, PetscSpace *);
82 PETSC_EXTERN PetscErrorCode PetscFESetDualSpace(PetscFE, PetscDualSpace);
83 PETSC_EXTERN PetscErrorCode PetscFEGetDualSpace(PetscFE, PetscDualSpace *);
84 PETSC_EXTERN PetscErrorCode PetscFESetQuadrature(PetscFE, PetscQuadrature);
85 PETSC_EXTERN PetscErrorCode PetscFEGetQuadrature(PetscFE, PetscQuadrature *);
86 PETSC_EXTERN PetscErrorCode PetscFEGetTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
87 PETSC_EXTERN PetscErrorCode PetscFERestoreTabulation(PetscFE, PetscReal **, PetscReal **, PetscReal **);
88 #endif
89