xref: /petsc/include/petscfetypes.h (revision e6f8f31134103d08b80e713a26ca64d6e7cf8e7b)
1 #if !defined(PETSCFETYPES_H)
2 #define PETSCFETYPES_H
3 
4 /* SUBMANSEC = FE */
5 
6 /*S
7   PetscSpace - PETSc object that manages a linear space, e.g. the space of d-dimensional polynomials of given degree
8 
9   Level: beginner
10 
11 .seealso: `PetscSpaceCreate()`, `PetscDualSpaceCreate()`, `PetscSpaceSetType()`, `PetscSpaceType`
12 S*/
13 typedef struct _p_PetscSpace *PetscSpace;
14 
15 /*S
16   PetscDualSpace - PETSc object that manages the dual space to a linear space, e.g. the space of evaluation functionals at the vertices of a triangle
17 
18   Level: beginner
19 
20 .seealso: `PetscDualSpaceCreate()`, `PetscSpaceCreate()`, `PetscDualSpaceSetType()`, `PetscDualSpaceType`
21 S*/
22 typedef struct _p_PetscDualSpace *PetscDualSpace;
23 
24 /*MC
25   PetscDualSpaceReferenceCell - The type of reference cell
26 
27   Notes: This is used only for automatic creation of reference cells. A `PetscDualSpace` can accept an arbitary `DM` for a reference cell.
28 
29   Level: beginner
30 
31 .seealso: `PetscSpace`
32 M*/
33 typedef enum { PETSCDUALSPACE_REFCELL_SIMPLEX, PETSCDUALSPACE_REFCELL_TENSOR } PetscDualSpaceReferenceCell;
34 PETSC_EXTERN const char * const PetscDualSpaceReferenceCells[];
35 
36 /*MC
37   PetscDualSpaceTransformType - The type of function transform
38 
39   Notes:
40   These transforms, and their inverses, are used to move functions and functionals between the reference element and real space.
41   Suppose that we have a mapping $\phi$ which maps the reference cell to real space, and its Jacobian $J$. If we want to transform function $F$ on the reference element,
42   so that it acts on real space, we use the pushforward transform $\sigma^*$. The pullback $\sigma_*$ is the inverse transform.
43 
44 $ Covariant Piola: $\sigma^*(F) = J^{-T} F \circ \phi^{-1)$
45 $ Contravariant Piola: $\sigma^*(F) = 1/|J| J F \circ \phi^{-1)$
46 
47   References:
48 .    Rognes, Kirby, and Logg, Efficient Assembly of Hdiv and Hrot Conforming Finite Elements, SISC, 31(6), 4130-4151, arXiv 1205.3085, 2010
49 
50   Level: beginner
51 
52 .seealso: `PetscDualSpaceGetDeRahm()`
53 M*/
54 typedef enum {IDENTITY_TRANSFORM, COVARIANT_PIOLA_TRANSFORM, CONTRAVARIANT_PIOLA_TRANSFORM} PetscDualSpaceTransformType;
55 
56 /*S
57   PetscFE - PETSc object that manages a finite element space, e.g. the P_1 Lagrange element
58 
59   Level: beginner
60 
61 .seealso: `PetscFECreate()`, `PetscSpaceCreate()`, `PetscDualSpaceCreate()`, `PetscFESetType()`, `PetscFEType`
62 S*/
63 typedef struct _p_PetscFE *PetscFE;
64 
65 /*MC
66   PetscFEJacobianType - indicates which pointwise functions should be used to fill the Jacobian matrix
67 
68   Level: beginner
69 
70 .seealso: `PetscFEIntegrateJacobian()`
71 M*/
72 typedef enum { PETSCFE_JACOBIAN, PETSCFE_JACOBIAN_PRE, PETSCFE_JACOBIAN_DYN } PetscFEJacobianType;
73 
74 #endif
75