xref: /petsc/include/petscconvest.h (revision 9dd11ecf0918283bb567d8b33a92f53ac4ea7840)
16af0ca60SMatthew G. Knepley /*
26af0ca60SMatthew G. Knepley       Objects which encapsulate discretizations+continuum residuals
36af0ca60SMatthew G. Knepley */
4*a4963045SJacob Faibussowitsch #pragma once
5ac09b921SBarry Smith 
66af0ca60SMatthew G. Knepley #include <petscsnes.h>
76af0ca60SMatthew G. Knepley 
8ac09b921SBarry Smith /* SUBMANSEC = SNES */
9ac09b921SBarry Smith 
106af0ca60SMatthew G. Knepley /*S
1187497f52SBarry Smith   PetscConvEst - Object that manages convergence rate estimates for a discretized problem
126af0ca60SMatthew G. Knepley 
136af0ca60SMatthew G. Knepley   Level: developer
146af0ca60SMatthew G. Knepley 
1587497f52SBarry Smith .seealso: `PetscConvEstCreate()`, `PetscConvEstDestroy()`, `PetscConvEstView()`, `PetscConvEstSetFromOptions()`,
1687497f52SBarry Smith           `PetscConvEstGetSolver()`, `PetscConvEstSetSolver()`, `PetscConvEstSetUp()`, `PetscConvEstComputeInitialGuess()`,
1787497f52SBarry Smith           `PetscConvEstComputeError()`, `PetscConvEstGetConvRate()`, `PetscConvEstMonitorDefault()`, `PetscConvEstRateView()`
186af0ca60SMatthew G. Knepley S*/
196af0ca60SMatthew G. Knepley typedef struct _p_PetscConvEst *PetscConvEst;
206af0ca60SMatthew G. Knepley 
216af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstCreate(MPI_Comm, PetscConvEst *);
226af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstDestroy(PetscConvEst *);
236af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstView(PetscConvEst, PetscViewer);
246af0ca60SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetFromOptions(PetscConvEst);
25900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstGetSolver(PetscConvEst, PetscObject *);
26900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetSolver(PetscConvEst, PetscObject);
270955ed61SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstSetUp(PetscConvEst);
28900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstComputeInitialGuess(PetscConvEst, PetscInt, DM, Vec);
29900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstComputeError(PetscConvEst, PetscInt, DM, Vec, PetscReal[]);
3046079b62SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstGetConvRate(PetscConvEst, PetscReal[]);
31f2cacb80SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstMonitorDefault(PetscConvEst, PetscInt);
32a56d3bf6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstRateView(PetscConvEst, const PetscReal[], PetscViewer);
33