xref: /petsc/src/sys/objects/version.c (revision ff87db43c5082475ccdd828c5a732608447f441c)
1 #include <petscsys.h>
2 /*@C
3     PetscGetVersion - Gets the PETSc version information in a string.
4 
5     Input Parameter:
6 .   len - length of the string
7 
8     Output Parameter:
9 .   version - version string
10 
11     Level: developer
12 
13     Note:
14     For doing runtime checking of supported versions we recommend using `PetscGetVersionNumber()` instead of this routine.
15 
16     Fortran Note:
17     This routine is not supported in Fortran.
18 
19 .seealso: `PetscGetProgramName()`, `PetscGetVersionNumber()`
20 @*/
21 
22 PetscErrorCode PetscGetVersion(char version[], size_t len) {
23   PetscFunctionBegin;
24 #if (PETSC_VERSION_RELEASE == 1)
25   PetscCall(PetscSNPrintf(version, len, "Petsc Release Version %d.%d.%d, %s ", PETSC_VERSION_MAJOR, PETSC_VERSION_MINOR, PETSC_VERSION_SUBMINOR, PETSC_VERSION_DATE));
26 #else
27   PetscCall(PetscSNPrintf(version, len, "Petsc Development GIT revision: %s  GIT Date: %s", PETSC_VERSION_GIT, PETSC_VERSION_DATE_GIT));
28 #endif
29   PetscFunctionReturn(0);
30 }
31 
32 /*@C
33     PetscGetVersionNumber - Gets the PETSc version information from the library
34 
35     Not collective
36 
37     Output Parameters:
38 +   major - the major version (optional, pass NULL if not requested)
39 .   minor - the minor version (optional, pass NULL if not requested)
40 .   subminor - the subminor version (patch number)  (optional, pass NULL if not requested)
41 -   release - indicates the library is from a release, not random git repository  (optional, pass NULL if not requested)
42 
43     Level: developer
44 
45     Notes:
46     The C macros `PETSC_VERSION_MAJOR`, `PETSC_VERSION_MINOR`, `PETSC_VERSION_SUBMINOR`, `PETSC_VERSION_RELEASE` provide the information at
47     compile time. This can be used to confirm that the shared library being loaded at runtime has the appropriate version updates.
48 
49     This function can be called before `PetscInitialize()`
50 
51 .seealso: `PetscGetProgramName()`, `PetscGetVersion()`, `PetscInitialize()`
52 @*/
53 PetscErrorCode PetscGetVersionNumber(PetscInt *major, PetscInt *minor, PetscInt *subminor, PetscInt *release) {
54   if (major) *major = PETSC_VERSION_MAJOR;
55   if (minor) *minor = PETSC_VERSION_MINOR;
56   if (subminor) *subminor = PETSC_VERSION_SUBMINOR;
57   if (release) *release = PETSC_VERSION_RELEASE;
58   return 0;
59 }
60