PetscTools.hpp

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2024, University of Oxford.
All rights reserved.
 
University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.
 
This file is part of Chaste.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
#ifndef PETSCTOOLS_HPP_
#define PETSCTOOLS_HPP_
 
#include <string>
#include <vector>
#include <cstdlib> // For EXIT_FAILURE
 
#include <petsc.h>
#include <petscvec.h>
#include <petscmat.h>
#include <petscsys.h>
 
#define EXIT_IF_PARALLEL if(PetscTools::IsParallel()){TS_TRACE("This test does not pass in parallel yet.");return;}
#define EXIT_IF_SEQUENTIAL if(PetscTools::IsSequential()){TS_TRACE("This test is not meant to be executed in sequential.");return;}
 
#if PETSC_VERSION_GE(3, 19, 0)
#define CHASTE_PETSC_NULLPTR PETSC_NULLPTR
#else
#define CHASTE_PETSC_NULLPTR PETSC_NULL
#endif
 
#if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR < 2 || PETSC_VERSION_MAJOR<3 ) // Before PETSc 3.2
typedef PetscTruth PetscBool;
#define PETSC_DESTROY_PARAM(x) x
#else
#define PETSC_DESTROY_PARAM(x) &x
#endif
 
#define TRY_IF_MASTER(method) {              \
    if (PetscTools::AmMaster())              \
    { try {                                  \
        method;                              \
    } catch (Exception& e) {                 \
        PetscTools::ReplicateException(true);\
        throw(e);                            \
    } }                                      \
    PetscTools::ReplicateException(false);   \
    }
 
class PetscTools
{
private:
 
    static bool mPetscIsInitialised;
 
    static unsigned mNumProcessors;
 
    static unsigned mRank;
 
    static bool mIsolateProcesses;
 
    static inline void CheckCache()
    {
        if (mNumProcessors == 0)
        {
            ResetCache();
        }
    }
 
public:
 
    static const unsigned MASTER_RANK=0;
 
    static void ResetCache();
 
    static bool IsInitialised();
 
    static bool IsSequential();
 
    static bool IsParallel();
 
    static bool IsIsolated();
 
    static unsigned GetNumProcs();
 
    static unsigned GetMyRank();
 
    static bool AmMaster();
 
    static bool AmTopMost();
 
    static void Barrier(const std::string callerId="");
 
    static void BeginRoundRobin();
 
    static void EndRoundRobin();
 
    static void IsolateProcesses(bool isolate=true);
 
    static MPI_Comm GetWorld();
 
    static Vec CreateVec(int size, int localSize=PETSC_DECIDE, bool ignoreOffProcEntries = true);
 
    static Vec CreateVec(std::vector<double> data);
 
    static Vec CreateAndSetVec(int size, double value);
 
    static void SetupMat(Mat& rMat, int numRows, int numColumns,
                         unsigned rowPreallocation,
                         int numLocalRows=PETSC_DECIDE,
                         int numLocalColumns=PETSC_DECIDE,
                         bool ignoreOffProcEntries=true,
                         bool newAllocationError=true);
 
    static bool ReplicateBool(bool flag);
 
    static void ReplicateException(bool flag);
 
    static void DumpPetscObject(const Mat& rMat, const std::string& rOutputFileFullPath);
 
    static void DumpPetscObject(const Vec& rVec, const std::string& rOutputFileFullPath);
 
    static void ReadPetscObject(Mat& rMat, const std::string& rOutputFileFullPath, Vec rParallelLayout=nullptr);
 
    static void ReadPetscObject(Vec& rVec, const std::string& rOutputFileFullPath, Vec rParallelLayout=nullptr);
 
    static bool HasParMetis();
 
     static inline void Destroy(Vec& rVec)
     {
#if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 2) //PETSc 3.2 or later
        VecDestroy(&rVec);
#else
        VecDestroy(rVec);
#endif
     }
 
     static inline void Destroy(Mat& rMat)
     {
#if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 2) //PETSc 3.2 or later
        MatDestroy(&rMat);
#else
        MatDestroy(rMat);
#endif
     }
 
     static inline void SetOption(const char* pOptionName, const char* pOptionValue)
     {
         // If this option turns on logging, PETSc needs to be made aware in different ways for different versions
         // See #2933 for details
         const std::string str_option_name(pOptionName);
         if (str_option_name.find("log") != std::string::npos)
         {
#if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR == 6) // PETSc 3.6
             PetscLogBegin();
#elif (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 7) // PETSc 3.7 or later
             PetscLogDefaultBegin();
#endif
         }
 
#if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 7) // PETSc 3.7 or later
         PetscOptionsSetValue(NULL, pOptionName, pOptionValue);
#else
         PetscOptionsSetValue(pOptionName, pOptionValue);
#endif
     }
 
#if PETSC_VERSION_GE(3, 11, 2) // PETSc 3.11.2 or newer
     static PetscErrorCode ChasteMatCopy(Mat A, Mat B, MatStructure str);
#endif
};
 
#endif /*PETSCTOOLS_HPP_*/