DistributedVectorFactory.hpp

/*

Copyright (C) University of Oxford, 2005-2010

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 DISTRIBUTEDVECTORFACTORY_HPP_
#define DISTRIBUTEDVECTORFACTORY_HPP_

#include "ChasteSerialization.hpp"
#include <petscvec.h>

#include "DistributedVector.hpp"
#include "Exception.hpp"
#include "PetscTools.hpp"

 class DistributedVectorFactory
{
private:
    // Data global to all vectors created by this factory.
    unsigned mLo;
    unsigned mHi;
    unsigned mProblemSize;
    unsigned mNumProcs;
    bool mPetscStatusKnown;

    static bool msCheckNumberOfProcessesOnLoad;
    DistributedVectorFactory* mpOriginalFactory;

    void CheckForPetsc();

    void CalculateOwnership(Vec vec);

    friend class boost::serialization::access;

    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // Nothing to do - all done in load_construct_data
    }

public:
    DistributedVectorFactory(Vec vec);

    DistributedVectorFactory(unsigned size, PetscInt local=PETSC_DECIDE);

    DistributedVectorFactory(DistributedVectorFactory* pOriginalFactory);

    DistributedVectorFactory(unsigned lo, unsigned hi, unsigned size, unsigned numProcs=PetscTools::GetNumProcs());

    ~DistributedVectorFactory();

    Vec CreateVec();

    Vec CreateVec(unsigned stride);

    DistributedVector CreateDistributedVector(Vec vec);

    bool IsGlobalIndexLocal(unsigned globalIndex);

    unsigned GetLocalOwnership() const
    {
        return mHi - mLo;
    }

    unsigned GetHigh() const
    {
        return mHi;
    }

    unsigned GetLow() const
    {
        return mLo;
    }

    unsigned GetProblemSize() const
    {
        return mProblemSize;
    }

    unsigned GetNumProcs() const
    {
        return mNumProcs;
    }

    static void SetCheckNumberOfProcessesOnLoad(bool checkNumberOfProcessesOnLoad=true)
    {
        msCheckNumberOfProcessesOnLoad = checkNumberOfProcessesOnLoad;
    }

    static bool CheckNumberOfProcessesOnLoad()
    {
        return msCheckNumberOfProcessesOnLoad;
    }

    DistributedVectorFactory* GetOriginalFactory()
    {
        return mpOriginalFactory;
    }

    void SetFromFactory(DistributedVectorFactory* pFactory);

//    /**
//     * For debugging.
//     */
//    void Dump(std::string msg=std::string())
//    {
//        std::cout << "DVF(" << this << "): " << msg;
//        std::cout << " lo=" << mLo << " hi=" << mHi << " size=" << mProblemSize << " np=" << mNumProcs;
//        std::cout << " [running np=" << PetscTools::GetNumProcs() << " rank=" << PetscTools::GetMyRank() << "]\n" << std::flush;
//    }
};
#include "SerializationExportWrapper.hpp"
// Declare identifier for the serializer
CHASTE_CLASS_EXPORT(DistributedVectorFactory);

namespace boost
{
namespace serialization
{

template<class Archive>
inline void save_construct_data(
    Archive & ar, const DistributedVectorFactory * t, const unsigned int file_version)
{
    unsigned num_procs, lo, hi, size;
    hi = t->GetHigh();
    ar << hi;
    lo = t->GetLow();
    ar << lo;
    size = t->GetProblemSize();
    ar << size;
    num_procs = PetscTools::GetNumProcs();
    ar << num_procs;
}

template<class Archive>
inline void load_construct_data(
    Archive & ar, DistributedVectorFactory * t, const unsigned int file_version)
{
    unsigned num_procs, lo, hi, size;
    ar >> hi;
    ar >> lo;
    ar >> size;
    ar >> num_procs;

    if (!DistributedVectorFactory::CheckNumberOfProcessesOnLoad())
    {
        DistributedVectorFactory* p_original_factory = new DistributedVectorFactory(lo, hi, size, num_procs);
        ::new(t)DistributedVectorFactory(p_original_factory);
    }
    else
    {
        if (num_procs != PetscTools::GetNumProcs())
        {
            // We need to have a ::new here, or Boost will try to free non-allocated memory
            // when the exception is thrown.  However, if we use the ::new line after this if,
            // then PETSc complains about wrong sizes.
            ::new(t)DistributedVectorFactory(size);
            EXCEPTION("This archive was written for a different number of processors");
        }
        ::new(t)DistributedVectorFactory(size, hi-lo);
    }
}

}
} // namespace ...

#endif /*DISTRIBUTEDVECTORFACTORY_HPP_*/