xref: /petsc/include/petscfetypes.h (revision ac09b9214d23ea9ad238aa607de9fa447fd4e91b)
126bd1501SBarry Smith #if !defined(PETSCFETYPES_H)
226bd1501SBarry Smith #define PETSCFETYPES_H
3dbe77d9eSMatthew G. Knepley 
4*ac09b921SBarry Smith /* SUBMANSEC = FE */
5*ac09b921SBarry 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 
2755cc6565SMatthew G. Knepley   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 
394bee2e38SMatthew G. Knepley   Notes: These transforms, and their inverses, are used to move functions and functionals between the reference element and real space. 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, so that it acts on real space, we use the pushforward transform $\sigma^*$. The pullback $\sigma_*$ is the inverse transform.
404bee2e38SMatthew G. Knepley 
414bee2e38SMatthew G. Knepley $ Covariant Piola: $\sigma^*(F) = J^{-T} F \circ \phi^{-1)$
424bee2e38SMatthew G. Knepley $ Contravariant Piola: $\sigma^*(F) = 1/|J| J F \circ \phi^{-1)$
434bee2e38SMatthew G. Knepley 
444bee2e38SMatthew G. Knepley   Note: For details, please see Rognes, Kirby, and Logg, Efficient Assembly of Hdiv and Hrot Conforming Finite Elements, SISC, 31(6), 4130-4151, arXiv 1205.3085, 2010
454bee2e38SMatthew G. Knepley 
46a4ce7ad1SMatthew G. Knepley   Level: beginner
474bee2e38SMatthew G. Knepley 
48db781477SPatrick Sanan .seealso: `PetscDualSpaceGetDeRahm()`
494bee2e38SMatthew G. Knepley M*/
504bee2e38SMatthew G. Knepley typedef enum {IDENTITY_TRANSFORM, COVARIANT_PIOLA_TRANSFORM, CONTRAVARIANT_PIOLA_TRANSFORM} PetscDualSpaceTransformType;
514bee2e38SMatthew G. Knepley 
52dbe77d9eSMatthew G. Knepley /*S
53dbe77d9eSMatthew G. Knepley   PetscFE - PETSc object that manages a finite element space, e.g. the P_1 Lagrange element
54dbe77d9eSMatthew G. Knepley 
55a4ce7ad1SMatthew G. Knepley   Level: beginner
56dbe77d9eSMatthew G. Knepley 
57db781477SPatrick Sanan .seealso: `PetscFECreate()`, `PetscSpaceCreate()`, `PetscDualSpaceCreate()`, `PetscFESetType()`, `PetscFEType`
58dbe77d9eSMatthew G. Knepley S*/
59dbe77d9eSMatthew G. Knepley typedef struct _p_PetscFE *PetscFE;
60dbe77d9eSMatthew G. Knepley 
61b7e05686SMatthew G. Knepley /*MC
629c3cf19fSMatthew G. Knepley   PetscFEJacobianType - indicates which pointwise functions should be used to fill the Jacobian matrix
63b7e05686SMatthew G. Knepley 
64a4ce7ad1SMatthew G. Knepley   Level: beginner
65b7e05686SMatthew G. Knepley 
66db781477SPatrick Sanan .seealso: `PetscFEIntegrateJacobian()`
67b7e05686SMatthew G. Knepley M*/
68b7e05686SMatthew G. Knepley typedef enum { PETSCFE_JACOBIAN, PETSCFE_JACOBIAN_PRE, PETSCFE_JACOBIAN_DYN } PetscFEJacobianType;
69b7e05686SMatthew G. Knepley 
70dbe77d9eSMatthew G. Knepley #endif
71