xref: /petsc/include/petscconvest.h (revision 87497f523770ea28bdc907071c6e8146b51bca00)
16af0ca60SMatthew G. Knepley /*
26af0ca60SMatthew G. Knepley       Objects which encapsulate discretizations+continuum residuals
36af0ca60SMatthew G. Knepley */
426bd1501SBarry Smith #if !defined(PETSCCE_H)
526bd1501SBarry Smith #define PETSCCE_H
6ac09b921SBarry Smith 
76af0ca60SMatthew G. Knepley #include <petscsnes.h>
86af0ca60SMatthew G. Knepley 
9ac09b921SBarry Smith /* SUBMANSEC = SNES */
10ac09b921SBarry Smith 
116af0ca60SMatthew G. Knepley /*S
12*87497f52SBarry Smith   PetscConvEst - Object that manages convergence rate estimates for a discretized problem
136af0ca60SMatthew G. Knepley 
146af0ca60SMatthew G. Knepley   Level: developer
156af0ca60SMatthew G. Knepley 
16*87497f52SBarry Smith .seealso: `PetscConvEstCreate()`, `PetscConvEstDestroy()`, `PetscConvEstView()`, `PetscConvEstSetFromOptions()`,
17*87497f52SBarry Smith           `PetscConvEstGetSolver()`, `PetscConvEstSetSolver()`, `PetscConvEstSetUp()`, `PetscConvEstComputeInitialGuess()`,
18*87497f52SBarry Smith           `PetscConvEstComputeError()`, `PetscConvEstGetConvRate()`, `PetscConvEstMonitorDefault()`, `PetscConvEstRateView()`
196af0ca60SMatthew G. Knepley S*/
206af0ca60SMatthew G. Knepley typedef struct _p_PetscConvEst *PetscConvEst;
216af0ca60SMatthew G. Knepley 
226af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstCreate(MPI_Comm, PetscConvEst *);
236af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstDestroy(PetscConvEst *);
246af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstView(PetscConvEst, PetscViewer);
256af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetFromOptions(PetscConvEst);
26900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstGetSolver(PetscConvEst, PetscObject *);
27900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetSolver(PetscConvEst, PetscObject);
280955ed61SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetUp(PetscConvEst);
29900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstComputeInitialGuess(PetscConvEst, PetscInt, DM, Vec);
30900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstComputeError(PetscConvEst, PetscInt, DM, Vec, PetscReal[]);
3146079b62SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstGetConvRate(PetscConvEst, PetscReal[]);
32f2cacb80SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstMonitorDefault(PetscConvEst, PetscInt);
33a56d3bf6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstRateView(PetscConvEst, const PetscReal[], PetscViewer);
346af0ca60SMatthew G. Knepley 
356af0ca60SMatthew G. Knepley #endif
36