TrianglesMeshReader.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 _TRIANGLESMESHREADER_HPP_
#define _TRIANGLESMESHREADER_HPP_

#include <vector>
#include <string>
#include <fstream>
#include "AbstractMeshReader.hpp"

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class TrianglesMeshReader : public AbstractMeshReader<ELEMENT_DIM,SPACE_DIM>
{

    friend class TestTrianglesMeshReader;//for testing

private:

    bool mIndexFromZero;            
    std::string mFilesBaseName;     
    std::ifstream mNodesFile;       
    std::ifstream mElementsFile;    
    std::ifstream mFacesFile;       
    std::ifstream mNclFile;         
    std::ifstream mCableElementsFile; 
    std::streampos mNodeFileDataStart; 
    std::streamoff mNodeItemWidth;  
    std::streampos mElementFileDataStart; 
    std::streamoff mElementItemWidth;  
    std::streampos mFaceFileDataStart; 
    std::streamoff mFaceItemWidth;  
    std::streampos mNclFileDataStart; 
    std::streamoff mNclItemWidth;  
    unsigned mNumNodes;             
    unsigned mNumElements;          
    unsigned mNumFaces;             
    unsigned mNumCableElements;     
    unsigned mNodesRead;            
    unsigned mElementsRead;         
    unsigned mCableElementsRead;    
    unsigned mFacesRead;            
    unsigned mBoundaryFacesRead;    
    unsigned mNclItemsRead;         
     std::vector<unsigned> mOneDimBoundary; 
    unsigned mNumNodeAttributes;    
    std::vector<double> mNodeAttributes; 
    unsigned mMaxNodeBdyMarker;     
    unsigned mNumElementNodes;      
    unsigned mNumElementAttributes; 
    unsigned mNumFaceAttributes;    
    unsigned mNumCableElementAttributes; 
    unsigned mOrderOfElements;      
    unsigned mOrderOfBoundaryElements; 
    unsigned mNodesPerElement;      
    unsigned mNodesPerBoundaryElement; 
    unsigned mMaxContainingElements; 
    bool mEofException; 
    bool mReadContainingElementOfBoundaryElement; 
    bool mFilesAreBinary; 
    bool mMeshIsHexahedral; 
    bool mNclFileAvailable; 
    char* mNodeFileReadBuffer; 
    char* mElementFileReadBuffer; 
    char* mFaceFileReadBuffer; 
    bool mNodePermutationDefined; 
    std::vector<unsigned> mPermutationVector; 
    std::vector<unsigned> mInversePermutationVector; 
//    /** The containing element for each boundary element (obtaining by doing tetgen with the -nn flag).
//     *  In a std::vector rather than the struct to save space if not read.
//     */
//    std::vector<unsigned> mContainingElementsOfBoundaryElement;
//
//    unsigned mIndexIntoContainingElementsVector; /**< Which index to use when GetNextContainingElementOfBoundaryElement() is called */

public:

    TrianglesMeshReader(std::string pathBaseName,
                        unsigned orderOfElements=1,
                        unsigned orderOfBoundaryElements=1,
                        bool readContainingElementsForBoundaryElements=false);

    ~TrianglesMeshReader();

    unsigned GetNumElements() const;

    unsigned GetNumNodes() const;

    unsigned GetNumFaces() const;

    unsigned GetNumCableElements() const;

    unsigned GetNumElementAttributes() const;

    unsigned GetNumFaceAttributes() const;

    unsigned GetNumCableElementAttributes() const;

    void Reset();

    std::vector<double> GetNextNode();

    ElementData GetNextElementData();

    ElementData GetNextFaceData();

    ElementData GetNextCableElementData();


    unsigned GetOrderOfElements()
    {
        return mOrderOfElements;
    }
    unsigned GetOrderOfBoundaryElements()
    {
        return mOrderOfBoundaryElements;
    }

    bool GetReadContainingElementOfBoundaryElement()
    {
        return mReadContainingElementOfBoundaryElement;
    }

    std::vector<double> GetNodeAttributes();

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

    ElementData GetElementData(unsigned index);

    ElementData GetFaceData(unsigned index);

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


    /*** @return true if reading binary files, false if reading ascii files */
    bool IsFileFormatBinary();

    bool HasNclFile();

    void SetReadBufferSize(unsigned bufferSize);

    void SetNodePermutation(std::vector<unsigned>& rPermutationVector);

    bool HasNodePermutation();

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


private:

    void OpenFiles();

    void OpenNodeFile();

    void OpenElementsFile();

    void OpenFacesFile();

    void OpenNclFile();

    void OpenCableElementsFile();

    void ReadHeaders();

    void CloseFiles();

    void GetNextLineFromStream(std::ifstream& rFileStream, std::string& rRawLine);

    template<class T_DATA>
    void GetNextItemFromStream(std::ifstream& rFileStream, unsigned expectedItemNumber,
                               std::vector<T_DATA>& rDataPacket, const unsigned& rNumAttributes,
                               std::vector<double>& rAttributes);

    std::string GetMeshFileBaseName();

    void GetOneDimBoundary();

    void EnsureIndexingFromZero(std::vector<unsigned>& rNodeIndices);
};

#endif //_TRIANGLESMESHREADER_HPP_