130a76a96SBarry Smith /* 230a76a96SBarry Smith Defines the interface functions for the method of characteristics solvers 330a76a96SBarry Smith */ 426bd1501SBarry Smith #ifndef PETSCCHARACTERISTICS_H 526bd1501SBarry Smith #define PETSCCHARACTERISTICS_H 630a76a96SBarry Smith 72c8e378dSBarry Smith #include <petscvec.h> 81e25c274SJed Brown #include <petscdmdatypes.h> 930a76a96SBarry Smith 10607a6623SBarry Smith PETSC_EXTERN PetscErrorCode CharacteristicInitializePackage(void); 1130a76a96SBarry Smith 1230a76a96SBarry Smith /*S 1330a76a96SBarry Smith Characteristic - Abstract PETSc object that manages method of characteristics solves 1430a76a96SBarry Smith 1530a76a96SBarry Smith Level: beginner 1630a76a96SBarry Smith 17*db781477SPatrick Sanan .seealso: `CharacteristicCreate()`, `CharacteristicSetType()`, `CharacteristicType`, `SNES`, `TS`, `PC`, `KSP` 1830a76a96SBarry Smith S*/ 1930a76a96SBarry Smith typedef struct _p_Characteristic *Characteristic; 2030a76a96SBarry Smith 2176bdecfbSBarry Smith /*J 228f6c3df8SBarry Smith CharacteristicType - String with the name of a characteristics method. 2330a76a96SBarry Smith 2430a76a96SBarry Smith Level: beginner 2530a76a96SBarry Smith 26*db781477SPatrick Sanan .seealso: `CharacteristicSetType()`, `Characteristic` 2776bdecfbSBarry Smith J*/ 2830a76a96SBarry Smith #define CHARACTERISTICDA "da" 2919fd82e9SBarry Smith typedef const char* CharacteristicType; 3030a76a96SBarry Smith 31014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicCreate(MPI_Comm, Characteristic *); 3219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode CharacteristicSetType(Characteristic, CharacteristicType); 33014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSetUp(Characteristic); 34014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSetVelocityInterpolation(Characteristic, DM, Vec, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(Vec, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *); 35014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSetVelocityInterpolationLocal(Characteristic, DM, Vec, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(void *, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *); 36014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSetFieldInterpolation(Characteristic, DM, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(Vec, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *); 37014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSetFieldInterpolationLocal(Characteristic, DM, Vec, PetscInt, PetscInt[], PetscErrorCode (*)(void *, PetscReal[], PetscInt, PetscInt[], PetscScalar[], void *), void *); 38014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicSolve(Characteristic, PetscReal, Vec); 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode CharacteristicDestroy(Characteristic*); 4030a76a96SBarry Smith 41140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList CharacteristicList; 4230a76a96SBarry Smith 43bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode CharacteristicRegister(const char[],PetscErrorCode (*)(Characteristic)); 4430a76a96SBarry Smith 4526bd1501SBarry Smith #endif /* PETSCCHARACTERISTICS_H */ 46