xref: /petsc/include/petsccharacteristic.h (revision 98d129c30f3ee9fdddc40fdbc5a989b7be64f888)
1 /*
2    Defines the interface functions for the method of characteristics solvers
3 */
4 #pragma once
5 
6 #include <petscvec.h>
7 #include <petscdmdatypes.h>
8 
9 /* SUBMANSEC = Characteristic */
10 
11 PETSC_EXTERN PetscErrorCode CharacteristicInitializePackage(void);
12 PETSC_EXTERN PetscErrorCode CharacteristicFinalizePackage(void);
13 
14 /*S
15      Characteristic - Abstract PETSc object that manages method of characteristics solves
16 
17    Level: beginner
18 
19 .seealso: `CharacteristicCreate()`, `CharacteristicSetType()`, `CharacteristicType`, `SNES`, `TS`, `PC`, `KSP`
20 S*/
21 typedef struct _p_Characteristic *Characteristic;
22 
23 /*J
24     CharacteristicType - String with the name of a characteristics method.
25 
26    Level: beginner
27 
28 .seealso: `CharacteristicSetType()`, `Characteristic`
29 J*/
30 #define CHARACTERISTICDA "da"
31 typedef const char *CharacteristicType;
32 
33 PETSC_EXTERN PetscErrorCode CharacteristicCreate(MPI_Comm, Characteristic *);
34 PETSC_EXTERN PetscErrorCode CharacteristicSetType(Characteristic, CharacteristicType);
35 PETSC_EXTERN PetscErrorCode CharacteristicSetUp(Characteristic);
36 PETSC_EXTERN PetscErrorCode CharacteristicSetVelocityInterpolation(Characteristic, DM, Vec, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(Vec, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *);
37 PETSC_EXTERN PetscErrorCode CharacteristicSetVelocityInterpolationLocal(Characteristic, DM, Vec, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(void *, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *);
38 PETSC_EXTERN PetscErrorCode CharacteristicSetFieldInterpolation(Characteristic, DM, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(Vec, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *);
39 PETSC_EXTERN PetscErrorCode CharacteristicSetFieldInterpolationLocal(Characteristic, DM, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(void *, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *);
40 PETSC_EXTERN PetscErrorCode CharacteristicSolve(Characteristic, PetscReal, Vec);
41 PETSC_EXTERN PetscErrorCode CharacteristicDestroy(Characteristic *);
42 
43 PETSC_EXTERN PetscFunctionList CharacteristicList;
44 
45 PETSC_EXTERN PetscErrorCode CharacteristicRegister(const char[], PetscErrorCode (*)(Characteristic));
46