xref: /petsc/include/petscconvest.h (revision d5b43468fb8780a8feea140ccd6fa3e6a50411cc)
1 /*
2       Objects which encapsulate discretizations+continuum residuals
3 */
4 #ifndef PETSCCE_H
5 #define PETSCCE_H
6 
7 #include <petscsnes.h>
8 
9 /* SUBMANSEC = SNES */
10 
11 /*S
12   PetscConvEst - Object that manages convergence rate estimates for a discretized problem
13 
14   Level: developer
15 
16 .seealso: `PetscConvEstCreate()`, `PetscConvEstDestroy()`, `PetscConvEstView()`, `PetscConvEstSetFromOptions()`,
17           `PetscConvEstGetSolver()`, `PetscConvEstSetSolver()`, `PetscConvEstSetUp()`, `PetscConvEstComputeInitialGuess()`,
18           `PetscConvEstComputeError()`, `PetscConvEstGetConvRate()`, `PetscConvEstMonitorDefault()`, `PetscConvEstRateView()`
19 S*/
20 typedef struct _p_PetscConvEst *PetscConvEst;
21 
22 PETSC_EXTERN PetscErrorCode PetscConvEstCreate(MPI_Comm, PetscConvEst *);
23 PETSC_EXTERN PetscErrorCode PetscConvEstDestroy(PetscConvEst *);
24 PETSC_EXTERN PetscErrorCode PetscConvEstView(PetscConvEst, PetscViewer);
25 PETSC_EXTERN PetscErrorCode PetscConvEstSetFromOptions(PetscConvEst);
26 PETSC_EXTERN PetscErrorCode PetscConvEstGetSolver(PetscConvEst, PetscObject *);
27 PETSC_EXTERN PetscErrorCode PetscConvEstSetSolver(PetscConvEst, PetscObject);
28 PETSC_EXTERN PetscErrorCode PetscConvEstSetUp(PetscConvEst);
29 PETSC_EXTERN PetscErrorCode PetscConvEstComputeInitialGuess(PetscConvEst, PetscInt, DM, Vec);
30 PETSC_EXTERN PetscErrorCode PetscConvEstComputeError(PetscConvEst, PetscInt, DM, Vec, PetscReal[]);
31 PETSC_EXTERN PetscErrorCode PetscConvEstGetConvRate(PetscConvEst, PetscReal[]);
32 PETSC_EXTERN PetscErrorCode PetscConvEstMonitorDefault(PetscConvEst, PetscInt);
33 PETSC_EXTERN PetscErrorCode PetscConvEstRateView(PetscConvEst, const PetscReal[], PetscViewer);
34 
35 #endif
36