DistributedVectorFactory.hpp

/*

Copyright (c) 2005-2018, 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 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;

    std::vector<unsigned> mGlobalLows;

    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 readOnly=false);

    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 SetOriginalFactory(DistributedVectorFactory* pOriginalFactory)
    {
        mpOriginalFactory = pOriginalFactory;
    }

    void SetFromFactory(DistributedVectorFactory* pFactory);

    std::vector<unsigned> &rGetGlobalLows();

//    /**
//     * 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;
    DistributedVectorFactory* p_original_factory = new DistributedVectorFactory(lo, hi, size, num_procs);

    if (!DistributedVectorFactory::CheckNumberOfProcessesOnLoad())
    {
        ::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);
        t->SetOriginalFactory(p_original_factory);
    }
}

}
} // namespace ...

#endif /*DISTRIBUTEDVECTORFACTORY_HPP_*/