xref: /petsc/include/petscfetypes.h (revision 87497f523770ea28bdc907071c6e8146b51bca00)
126bd1501SBarry Smith #if !defined(PETSCFETYPES_H)
226bd1501SBarry Smith #define PETSCFETYPES_H
3dbe77d9eSMatthew G. Knepley 
4ac09b921SBarry Smith /* SUBMANSEC = FE */
5ac09b921SBarry Smith 
6dbe77d9eSMatthew G. Knepley /*S
7dbe77d9eSMatthew G. Knepley   PetscSpace - PETSc object that manages a linear space, e.g. the space of d-dimensional polynomials of given degree
8dbe77d9eSMatthew G. Knepley 
929b5c115SMatthew G. Knepley   Level: beginner
10dbe77d9eSMatthew G. Knepley 
11db781477SPatrick Sanan .seealso: `PetscSpaceCreate()`, `PetscDualSpaceCreate()`, `PetscSpaceSetType()`, `PetscSpaceType`
12dbe77d9eSMatthew G. Knepley S*/
13dbe77d9eSMatthew G. Knepley typedef struct _p_PetscSpace *PetscSpace;
14dbe77d9eSMatthew G. Knepley 
15dbe77d9eSMatthew G. Knepley /*S
16dbe77d9eSMatthew G. Knepley   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
17dbe77d9eSMatthew G. Knepley 
18a4ce7ad1SMatthew G. Knepley   Level: beginner
19dbe77d9eSMatthew G. Knepley 
20db781477SPatrick Sanan .seealso: `PetscDualSpaceCreate()`, `PetscSpaceCreate()`, `PetscDualSpaceSetType()`, `PetscDualSpaceType`
21dbe77d9eSMatthew G. Knepley S*/
22dbe77d9eSMatthew G. Knepley typedef struct _p_PetscDualSpace *PetscDualSpace;
23dbe77d9eSMatthew G. Knepley 
2455cc6565SMatthew G. Knepley /*MC
2555cc6565SMatthew G. Knepley   PetscDualSpaceReferenceCell - The type of reference cell
2655cc6565SMatthew G. Knepley 
27*87497f52SBarry Smith   Notes: This is used only for automatic creation of reference cells. A `PetscDualSpace` can accept an arbitary `DM` for a reference cell.
2855cc6565SMatthew G. Knepley 
29a4ce7ad1SMatthew G. Knepley   Level: beginner
3055cc6565SMatthew G. Knepley 
31db781477SPatrick Sanan .seealso: `PetscSpace`
3255cc6565SMatthew G. Knepley M*/
3355cc6565SMatthew G. Knepley typedef enum { PETSCDUALSPACE_REFCELL_SIMPLEX, PETSCDUALSPACE_REFCELL_TENSOR } PetscDualSpaceReferenceCell;
3455cc6565SMatthew G. Knepley PETSC_EXTERN const char * const PetscDualSpaceReferenceCells[];
3555cc6565SMatthew G. Knepley 
364bee2e38SMatthew G. Knepley /*MC
374bee2e38SMatthew G. Knepley   PetscDualSpaceTransformType - The type of function transform
384bee2e38SMatthew G. Knepley 
39*87497f52SBarry Smith   Notes:
40*87497f52SBarry Smith   These transforms, and their inverses, are used to move functions and functionals between the reference element and real space.
41*87497f52SBarry Smith   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*87497f52SBarry Smith   so that it acts on real space, we use the pushforward transform $\sigma^*$. The pullback $\sigma_*$ is the inverse transform.
434bee2e38SMatthew G. Knepley 
444bee2e38SMatthew G. Knepley $ Covariant Piola: $\sigma^*(F) = J^{-T} F \circ \phi^{-1)$
454bee2e38SMatthew G. Knepley $ Contravariant Piola: $\sigma^*(F) = 1/|J| J F \circ \phi^{-1)$
464bee2e38SMatthew G. Knepley 
47*87497f52SBarry Smith   References:
48*87497f52SBarry Smith .    Rognes, Kirby, and Logg, Efficient Assembly of Hdiv and Hrot Conforming Finite Elements, SISC, 31(6), 4130-4151, arXiv 1205.3085, 2010
494bee2e38SMatthew G. Knepley 
50a4ce7ad1SMatthew G. Knepley   Level: beginner
514bee2e38SMatthew G. Knepley 
52db781477SPatrick Sanan .seealso: `PetscDualSpaceGetDeRahm()`
534bee2e38SMatthew G. Knepley M*/
544bee2e38SMatthew G. Knepley typedef enum {IDENTITY_TRANSFORM, COVARIANT_PIOLA_TRANSFORM, CONTRAVARIANT_PIOLA_TRANSFORM} PetscDualSpaceTransformType;
554bee2e38SMatthew G. Knepley 
56dbe77d9eSMatthew G. Knepley /*S
57dbe77d9eSMatthew G. Knepley   PetscFE - PETSc object that manages a finite element space, e.g. the P_1 Lagrange element
58dbe77d9eSMatthew G. Knepley 
59a4ce7ad1SMatthew G. Knepley   Level: beginner
60dbe77d9eSMatthew G. Knepley 
61db781477SPatrick Sanan .seealso: `PetscFECreate()`, `PetscSpaceCreate()`, `PetscDualSpaceCreate()`, `PetscFESetType()`, `PetscFEType`
62dbe77d9eSMatthew G. Knepley S*/
63dbe77d9eSMatthew G. Knepley typedef struct _p_PetscFE *PetscFE;
64dbe77d9eSMatthew G. Knepley 
65b7e05686SMatthew G. Knepley /*MC
669c3cf19fSMatthew G. Knepley   PetscFEJacobianType - indicates which pointwise functions should be used to fill the Jacobian matrix
67b7e05686SMatthew G. Knepley 
68a4ce7ad1SMatthew G. Knepley   Level: beginner
69b7e05686SMatthew G. Knepley 
70db781477SPatrick Sanan .seealso: `PetscFEIntegrateJacobian()`
71b7e05686SMatthew G. Knepley M*/
72b7e05686SMatthew G. Knepley typedef enum { PETSCFE_JACOBIAN, PETSCFE_JACOBIAN_PRE, PETSCFE_JACOBIAN_DYN } PetscFEJacobianType;
73b7e05686SMatthew G. Knepley 
74dbe77d9eSMatthew G. Knepley #endif
75