Actual source code: version.c

petsc-main 2021-03-01
Report Typos and Errors
  1: #include <petscsys.h>
  2: /*@C
  3:     PetscGetVersion - Gets the PETSc version information in a string.

  5:     Input Parameter:
  6: .   len - length of the string

  8:     Output Parameter:
  9: .   version - version string

 11:     Level: developer

 13:     Fortran Note:
 14:     This routine is not supported in Fortran.

 16:     For doing runtime checking off supported versions we recommend using PetscGetVersionNumber() instead of this routine.

 18:     Developer Note: The version information is also listed in
 19: $    src/docs/website/index.html.

 21: .seealso: PetscGetProgramName(), PetscGetVersionNumber()

 23: @*/

 25: PetscErrorCode PetscGetVersion(char version[], size_t len)
 26: {

 30: #if (PETSC_VERSION_RELEASE == 1)
 31:   PetscSNPrintf(version,len,"Petsc Release Version %d.%d.%d, %s ",PETSC_VERSION_MAJOR,PETSC_VERSION_MINOR, PETSC_VERSION_SUBMINOR,PETSC_VERSION_DATE);
 32: #else
 33:   PetscSNPrintf(version,len,"Petsc Development GIT revision: %s  GIT Date: %s",PETSC_VERSION_GIT, PETSC_VERSION_DATE_GIT);
 34: #endif
 35:   return(0);
 36: }

 38: /*@C
 39:     PetscGetVersionNumber - Gets the PETSc version information from the library

 41:     Not collective

 43:     Output Parameter:
 44: +   major - the major version (optional, pass NULL if not requested)
 45: .   minor - the minor version (optional, pass NULL if not requested)
 46: .   subminor - the subminor version (patch number)  (optional, pass NULL if not requested)
 47: -   release - indicates the library is from a release, not random git repository  (optional, pass NULL if not requested)

 49:     Level: developer

 51:     Notes:
 52:     The C macros PETSC_VERSION_MAJOR, PETSC_VERSION_MINOR, PETSC_VERSION_SUBMINOR, PETSC_VERSION_RELEASE provide the information at
 53:        compile time. This can be used to confirm that the shared library being loaded at runtime has the appropriate version updates.

 55:        This function can be called before PetscInitialize()

 57: .seealso: PetscGetProgramName(), PetscGetVersion(), PetscInitialize()

 59: @*/
 60: PetscErrorCode PetscGetVersionNumber(PetscInt *major, PetscInt *minor, PetscInt *subminor,PetscInt *release)
 61: {
 62:   if (major) *major = PETSC_VERSION_MAJOR;
 63:   if (minor) *minor = PETSC_VERSION_MINOR;
 64:   if (subminor) *subminor = PETSC_VERSION_SUBMINOR;
 65:   if (release) *release = PETSC_VERSION_RELEASE;
 66:   return 0;
 67: }