xref: /petsc/src/sys/objects/version.c (revision 8cf9f3d7787c9e0f463716f0fe761611b2bbfbe5)

#include <petscsys.h>
/*@C
    PetscGetVersion - Gets the PETSc version information in a string.

    Input Parameter:
.   len - length of the string

    Output Parameter:
.   version - version string

    Level: developer

    Fortran Note:
    This routine is not supported in Fortran.

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

    Developer Note: The version information is also listed in
$    src/docs/tex/manual/intro.tex,
$    src/docs/tex/manual/manual.tex.
$    src/docs/website/index.html.

.seealso: PetscGetProgramName(), PetscGetVersionNumber()

@*/

#undef __FUNCT__
#define __FUNCT__ "PetscGetVersion"
PetscErrorCode PetscGetVersion(char version[], size_t len)
{
  PetscErrorCode ierr;

  PetscFunctionBegin;
#if (PETSC_VERSION_RELEASE == 1)
  ierr = PetscSNPrintf(version,len,"Petsc Release Version %d.%d.%d, %s ",PETSC_VERSION_MAJOR,PETSC_VERSION_MINOR, PETSC_VERSION_SUBMINOR,PETSC_VERSION_DATE);CHKERRQ(ierr);
#else
  ierr = PetscSNPrintf(version,len,"Petsc Development GIT revision: %s  GIT Date: %s",PETSC_VERSION_GIT, PETSC_VERSION_DATE_GIT);CHKERRQ(ierr);
#endif
  PetscFunctionReturn(0);
}

#undef __FUNCT__
#define __FUNCT__ "PetscGetVersionNumber"
/*@C
    PetscGetVersionNumber - Gets the PETSc version information from the library

    Not collective

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

    Level: developer

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

       This function can be called before PetscInitialize()

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

@*/
PetscErrorCode PetscGetVersionNumber(PetscInt *major, PetscInt *minor, PetscInt *subminor,PetscInt *release)
{
  if (major) *major = PETSC_VERSION_MAJOR;
  if (minor) *minor = PETSC_VERSION_MINOR;
  if (subminor) *subminor = PETSC_VERSION_SUBMINOR;
  if (release) *release = PETSC_VERSION_RELEASE;
  return 0;
}