ParallelTetrahedralMesh.hpp

/*

Copyright (C) University of Oxford, 2005-2009

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

#include <map>
#include <vector>
#include <set>

#include "AbstractTetrahedralMesh.hpp"
#include "Node.hpp"
#include "AbstractMeshReader.hpp"

/*
 *  The following definition fixes an odd incompatibility of METIS 4.0 and Chaste. Since
 * the library was compiled with a plain-C compiler, it fails to link using a C++ compiler.
 * Note that METIS 4.0 fails to compile with g++ or icpc, so a C compiler should be used.
 *
 * Somebody had this problem before: http://www-users.cs.umn.edu/~karypis/.discus/messages/15/113.html?1119486445
 *
 * Note that it is necessary to define the function header before the #include statement.
*/
extern "C" {
extern void METIS_PartMeshNodal(int*, int*, int*, int*, int*, int*, int*, int*, int*);
};
#include "metis.h"

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class ParallelTetrahedralMesh : public AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM>
{
    friend class TestParallelTetrahedralMesh;

public:

    typedef enum
    {
        DUMB=0,
        METIS_BINARY,
        METIS_LIBRARY
    } PartitionType;

private:

    unsigned mTotalNumElements;

    unsigned mTotalNumBoundaryElements;

    unsigned mTotalNumNodes;

    std::vector<Node<SPACE_DIM>* > mHaloNodes;

    std::map<unsigned, unsigned> mNodesMapping;

    std::map<unsigned, unsigned> mHaloNodesMapping;

    std::map<unsigned, unsigned> mElementsMapping;

    std::map<unsigned, unsigned> mBoundaryElementsMapping;

    PartitionType mMetisPartitioning;

public:

    ParallelTetrahedralMesh(PartitionType metisPartitioning=METIS_LIBRARY);

    virtual ~ParallelTetrahedralMesh();

    void ConstructFromMeshReader(AbstractMeshReader<ELEMENT_DIM,SPACE_DIM>& rMeshReader,
                                 bool cullInternalFaces=false);

    unsigned GetNumLocalNodes() const;
    
    unsigned GetNumLocalElements() const;

    unsigned GetNumNodes() const;

    unsigned GetNumElements() const;
    
    unsigned GetNumBoundaryElements() const;

    void SetElementOwnerships(unsigned lo, unsigned hi);

private:

    void RegisterNode(unsigned index);

    void RegisterHaloNode(unsigned index);
    
    void RegisterElement(unsigned index);

    void RegisterBoundaryElement(unsigned index);

    unsigned SolveNodeMapping(unsigned index) const;

    unsigned SolveHaloNodeMapping(unsigned index);

    unsigned SolveElementMapping(unsigned index) const;

    unsigned SolveBoundaryElementMapping(unsigned index) const;

    void ComputeMeshPartitioning(AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>& rMeshReader,
                                 std::set<unsigned>& rNodesOwned,
                                 std::set<unsigned>& rHaloNodesOwned,
                                 std::set<unsigned>& rElementsOwned,
                                 std::vector<unsigned>& rProcessorsOffset,
                                 std::vector<unsigned>& rNodePermutation);

    void DumbNodePartitioning(AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>& rMeshReader,
                              std::set<unsigned>& rNodesOwned);

    void MetisBinaryNodePartitioning(AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>& rMeshReader,
                                     std::set<unsigned>& rNodesOwned, 
                                     std::vector<unsigned>& rProcessorsOffset,
                                     std::vector<unsigned>& rNodePermutation);

    void MetisLibraryNodePartitioning(AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>& rMeshReader,
                                      std::set<unsigned>& rNodesOwned, 
                                      std::vector<unsigned>& rProcessorsOffset,
                                      std::vector<unsigned>& rNodePermutation);

    void ReorderNodes(std::vector<unsigned>& rNodePermutation);
};

#endif /*PARALLELTETRAHEDRALMESH_HPP_*/

---