Actual source code: dpause.c

  1: /*
  2:        Provides the calling sequences for all the basic PetscDraw routines.
  3: */
  4: #include <petsc/private/drawimpl.h>

  6: /*@
  7:    PetscDrawPause - Waits n seconds or until user input, depending on input
  8:                to `PetscDrawSetPause()`.

 10:    Collective

 12:    Input Parameter:
 13: .  draw - the drawing context

 15:    Level: beginner

 17: .seealso: `PetscDraw`, `PetscDrawSetPause()`, `PetscDrawGetPause()`
 18: @*/
 19: PetscErrorCode PetscDrawPause(PetscDraw draw)
 20: {
 21:   PetscFunctionBegin;
 23:   PetscTryTypeMethod(draw, pause);
 24:   PetscFunctionReturn(PETSC_SUCCESS);
 25: }

 27: /*@
 28:    PetscDrawSetPause - Sets the amount of time that program pauses after
 29:    a `PetscDrawPause()` is called.

 31:    Logically Collective

 33:    Input Parameters:
 34: +  draw   - the drawing object
 35: -  lpause - number of seconds to pause, -1 implies until user input, -2 pauses only on the `PetscDrawDestroy()`

 37:    Options Database Key:
 38: .  -draw_pause value - set the time to pause

 40:    Level: intermediate

 42:    Note:
 43:    By default the pause time is zero unless the -draw_pause option is given
 44:    during PetscDrawCreate().

 46: .seealso: `PetscDraw`, `PetscDrawGetPause()`, `PetscDrawPause()`
 47: @*/
 48: PetscErrorCode PetscDrawSetPause(PetscDraw draw, PetscReal lpause)
 49: {
 50:   PetscFunctionBegin;
 53:   draw->pause = lpause;
 54:   PetscFunctionReturn(PETSC_SUCCESS);
 55: }

 57: /*@
 58:    PetscDrawGetPause - Gets the amount of time that program pauses after
 59:    a `PetscDrawPause()` is called.

 61:    Not collective

 63:    Input Parameters:
 64: +  draw   - the drawing object
 65: -  lpause - number of seconds to pause, -1 implies until user input

 67:    Level: intermediate

 69:    Note:
 70:    By default the pause time is zero unless the -draw_pause option is given

 72: .seealso: `PetscDraw`, `PetscDrawSetPause()`, `PetscDrawPause()`
 73: @*/
 74: PetscErrorCode PetscDrawGetPause(PetscDraw draw, PetscReal *lpause)
 75: {
 76:   PetscFunctionBegin;
 79:   *lpause = draw->pause;
 80:   PetscFunctionReturn(PETSC_SUCCESS);
 81: }