AbstractMeshReader.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 _ABSTRACTMESHREADER_HPP_
#define _ABSTRACTMESHREADER_HPP_

#include <string>
#include <vector>
#include <set>
#include <cassert>
#include <boost/iterator/iterator_facade.hpp>
#include "Exception.hpp"

struct ElementData
{
    // Constructor to initialise default values, to prevent -Werror=maybe-uninitialized on some compilers
    ElementData()
            : NodeIndices(std::vector<unsigned>()),
              AttributeValue(DOUBLE_UNSET),
              ContainingElement(UNSIGNED_UNSET) {}
    std::vector<unsigned> NodeIndices; 
    double AttributeValue; 
    unsigned ContainingElement; 
};

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractMeshReader
{

public:

    virtual ~AbstractMeshReader()
    {}

    virtual unsigned GetNumElements() const =0;

    virtual unsigned GetNumNodes() const =0;

    virtual unsigned GetNumFaces() const =0;

    virtual unsigned GetNumCableElements() const;

    virtual unsigned GetNumElementAttributes() const;

    virtual unsigned GetNumFaceAttributes() const;

    virtual unsigned GetNumCableElementAttributes() const;

    virtual std::vector<double> GetNodeAttributes();

    unsigned GetNumEdges() const;

    virtual std::vector<double> GetNextNode()=0;

    virtual void Reset()=0;

    virtual ElementData GetNextElementData()=0;

    virtual ElementData GetNextFaceData()=0;

    virtual ElementData GetNextCableElementData();

    ElementData GetNextEdgeData();


     virtual std::vector<double> GetNode(unsigned index);

    virtual ElementData GetElementData(unsigned index);

    virtual ElementData GetFaceData(unsigned index);

    ElementData GetEdgeData(unsigned index);

    virtual std::vector<unsigned> GetContainingElementIndices(unsigned index);

    virtual std::string GetMeshFileBaseName();

    virtual unsigned GetOrderOfElements();

    virtual unsigned GetOrderOfBoundaryElements();

    virtual bool GetReadContainingElementOfBoundaryElement();


    virtual bool IsFileFormatBinary();

    virtual bool HasNclFile();

    virtual bool HasNodePermutation();

    virtual const std::vector<unsigned>& rGetNodePermutation();


    // Iterator classes

    class ElementIterator : public boost::iterator_facade<ElementIterator, const ElementData,
                                                          boost::single_pass_traversal_tag>
    {
    public:
        ElementIterator(unsigned index, AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* pReader)
            : mIndex(index),
              mpIndices(nullptr),
              mpReader(pReader)
        {
            CacheData(mIndex, true);
        }

        ElementIterator(const std::set<unsigned>& rIndices,
                        AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* pReader);

        unsigned GetIndex() const
        {
            return mIndex;
        }

    private:
        friend class boost::iterator_core_access;

        void CacheData(unsigned index, bool firstRead = false);

        void increment();

        bool equal(const ElementIterator& rOther) const
        {
            return mIndex == rOther.mIndex;
        }

        const ElementData& dereference() const
        {
            assert(mpReader);
            assert(mIndex < mpReader->GetNumElements());
            // This was cached in increment()
            return mLastDataRead;
        }

        unsigned mIndex;

        const std::set<unsigned>* mpIndices;

        std::set<unsigned>::const_iterator mIndicesIterator;

        AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* mpReader;

        ElementData mLastDataRead;
    };

    ElementIterator GetElementIteratorBegin();

    ElementIterator GetElementIteratorBegin(const std::set<unsigned>& rIndices);

    ElementIterator GetElementIteratorEnd();


    class NodeIterator : public boost::iterator_facade<NodeIterator, const std::vector<double>,
                                                       boost::single_pass_traversal_tag>
    {
    public:
        NodeIterator(unsigned index, AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* pReader)
            : mIndex(index),
              mpIndices(nullptr),
              mpReader(pReader)
        {
            CacheData(mIndex, true);
        }

        NodeIterator(const std::set<unsigned>& rIndices,
                     AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* pReader);

        unsigned GetIndex() const
        {
            return mIndex;
        }

    private:
        friend class boost::iterator_core_access;

        void CacheData(unsigned index, bool firstRead = false);

        void increment();

        bool equal(const NodeIterator& rOther) const
        {
            return mIndex == rOther.mIndex;
        }

        const std::vector<double>& dereference() const
        {
            assert(mpReader);
            assert(mIndex < mpReader->GetNumNodes());
            // This was cached in increment()
            return mLastDataRead;
        }

        unsigned mIndex;

        const std::set<unsigned>* mpIndices;

        std::set<unsigned>::const_iterator mIndicesIterator;

        AbstractMeshReader<ELEMENT_DIM, SPACE_DIM>* mpReader;

        std::vector<double> mLastDataRead;
    };

    NodeIterator GetNodeIteratorBegin();

    NodeIterator GetNodeIteratorBegin(const std::set<unsigned>& rIndices);

    NodeIterator GetNodeIteratorEnd();
};

#endif //_ABSTRACTMESHREADER_HPP_