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