xref: /petsc/src/sys/objects/package.c (revision 2fe279fdf3e687a416e4eadb7d3c7a82d60442c6)
160fbe2beSVaclav Hapla 
260fbe2beSVaclav Hapla #include <petsc/private/petscimpl.h> /*I    "petscsys.h"   I*/
360fbe2beSVaclav Hapla 
460fbe2beSVaclav Hapla /*@C
560fbe2beSVaclav Hapla    PetscHasExternalPackage - Determine whether PETSc has been configured with the given package
660fbe2beSVaclav Hapla 
760fbe2beSVaclav Hapla    Not Collective
860fbe2beSVaclav Hapla 
9*2fe279fdSBarry Smith    Input Parameter:
1060fbe2beSVaclav Hapla .  pkg - external package name
1160fbe2beSVaclav Hapla 
12*2fe279fdSBarry Smith    Output Parameter:
13811af0c4SBarry Smith .  has - `PETSC_TRUE` if PETSc is configured with the given package, else `PETSC_FALSE`.
1460fbe2beSVaclav Hapla 
1560fbe2beSVaclav Hapla    Level: intermediate
1660fbe2beSVaclav Hapla 
1760fbe2beSVaclav Hapla    Notes:
1860fbe2beSVaclav Hapla    This is basically an alternative for PETSC_HAVE_XXX whenever a preprocessor macro is not available/desirable, e.g. in Python.
1960fbe2beSVaclav Hapla 
2060fbe2beSVaclav Hapla    The external package name pkg is e.g. "hdf5", "yaml", "parmetis".
2160fbe2beSVaclav Hapla    It should correspond to the name listed in  ./configure --help  or e.g. in PetscViewerType, MatPartitioningType, MatSolverType.
2260fbe2beSVaclav Hapla 
2360fbe2beSVaclav Hapla    The lookup is case insensitive, i.e. looking for "HDF5" or "hdf5" is the same.
2460fbe2beSVaclav Hapla 
25db781477SPatrick Sanan .seealso: `PetscViewerType`, `MatPartitioningType`, `MatSolverType`
2660fbe2beSVaclav Hapla @*/
27d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscHasExternalPackage(const char pkg[], PetscBool *has)
28d71ae5a4SJacob Faibussowitsch {
2960fbe2beSVaclav Hapla   char   pkgstr[128], *loc;
3060fbe2beSVaclav Hapla   size_t cnt;
3160fbe2beSVaclav Hapla 
3260fbe2beSVaclav Hapla   PetscFunctionBegin;
335f80ce2aSJacob Faibussowitsch   PetscValidCharPointer(pkg, 1);
345f80ce2aSJacob Faibussowitsch   PetscValidBoolPointer(has, 2);
359566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintfCount(pkgstr, sizeof(pkgstr), ":%s:", &cnt, pkg));
365f80ce2aSJacob Faibussowitsch   PetscCheck(cnt < sizeof(pkgstr), PETSC_COMM_SELF, PETSC_ERR_SUP, "Package name is too long: \"%s\"", pkg);
379566063dSJacob Faibussowitsch   PetscCall(PetscStrtolower(pkgstr));
3860fbe2beSVaclav Hapla #if defined(PETSC_HAVE_PACKAGES)
399566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(PETSC_HAVE_PACKAGES, pkgstr, &loc));
4060fbe2beSVaclav Hapla #else
4160fbe2beSVaclav Hapla   #error "PETSC_HAVE_PACKAGES macro undefined. Please reconfigure"
4260fbe2beSVaclav Hapla #endif
4360fbe2beSVaclav Hapla   *has = loc ? PETSC_TRUE : PETSC_FALSE;
443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4560fbe2beSVaclav Hapla }
46