Actual source code: petscbm.h

      1: #pragma once

      3: #include <petscis.h>

      5: /* SUBMANSEC = Sys */

      7: /*S
      8:      PetscBench - Abstract PETSc object that manages a benchmark test

     10:    Level: intermediate

     12: .seealso: `PetscBenchCreate()`, `PetscBenchDestroy()`, `PetscBenchSetType()`, `PetscBenchType`
     13: S*/
     14: typedef struct _p_PetscBench *PetscBench;

     16: /*J
     17:     PetscBenchType - String with the name of a PETSc benchmark test

     19:    Level: intermediate

     21: .seealso: `PetscBenchCreate()`, `PetscBenchDestroy()`, `PetscBenchSetType()`, `PetscBench`
     22: J*/
     23: typedef const char *PetscBenchType;

     25: PETSC_EXTERN PetscClassId PetscBench_CLASSID;

     27: PETSC_EXTERN PetscErrorCode PetscBenchInitializePackage(void);

     29: PETSC_EXTERN PetscErrorCode PetscBenchCreate(MPI_Comm, PetscBench *);
     30: PETSC_EXTERN PetscErrorCode PetscBenchSetFromOptions(PetscBench);
     31: PETSC_EXTERN PetscErrorCode PetscBenchSetUp(PetscBench);
     32: PETSC_EXTERN PetscErrorCode PetscBenchRun(PetscBench);
     33: PETSC_EXTERN PetscErrorCode PetscBenchReset(PetscBench);
     34: PETSC_EXTERN PetscErrorCode PetscBenchSetOptionsPrefix(PetscBench, const char[]);
     35: PETSC_EXTERN PetscErrorCode PetscBenchView(PetscBench, PetscViewer);
     36: PETSC_EXTERN PetscErrorCode PetscBenchViewFromOptions(PetscBench, PetscObject, const char[]);
     37: PETSC_EXTERN PetscErrorCode PetscBenchDestroy(PetscBench *);
     38: PETSC_EXTERN PetscErrorCode PetscBenchSetType(PetscBench, PetscBenchType);
     39: PETSC_EXTERN PetscErrorCode PetscBenchGetType(PetscBench, PetscBenchType *);
     40: PETSC_EXTERN PetscErrorCode PetscBenchRegister(const char[], PetscErrorCode (*)(PetscBench));
     41: PETSC_EXTERN PetscErrorCode PetscBenchSetSize(PetscBench, PetscInt);
     42: PETSC_EXTERN PetscErrorCode PetscBenchGetSize(PetscBench, PetscInt *);