PetscTools.hpp

Go to the documentation of this file.

/*

Copyright (C) University of Oxford, 2005-2011

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.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef PETSCTOOLS_HPP_
#define PETSCTOOLS_HPP_

#include <string>
#include <vector>
#include <cstdlib> // For EXIT_FAILURE

#include <petsc.h>
#include <petscvec.h>
#include <petscmat.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;}

#ifndef NDEBUG
// Uncomment this to trace calls to PetscTools::Barrier
//#define DEBUG_BARRIERS
#endif

class PetscTools
{
private:

    static bool mPetscIsInitialised;

    static unsigned mNumProcessors;

#ifdef DEBUG_BARRIERS

    static unsigned mNumBarriers;
#endif

    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 IsSequential();

    static bool IsParallel();

    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 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);

    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=NULL);

    static void ReadPetscObject(Vec& rVec, const std::string& rOutputFileFullPath, Vec rParallelLayout=NULL);
};

#endif /*PETSCTOOLS_HPP_*/