UnstructuredGridRepresentation.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2016)

philippe.verney@f2i-consulting.com

This software is a computer program whose purpose is to access to data formatted using Energistics standards.

This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.  You can  use,
modify and/ or redistribute the software under the terms of the CeCILL-B
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability.

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and,  more generally, to use and operate it in the
same conditions as regards security.

The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms.
-----------------------------------------------------------------------*/
#pragma once

#include "resqml2/AbstractGridRepresentation.h"

namespace resqml2_0_1
{
    class DLL_IMPORT_OR_EXPORT UnstructuredGridRepresentation : public resqml2::AbstractGridRepresentation
    {
    private :

        void init(soap* soapContext, resqml2::AbstractLocal3dCrs * crs,
                const std::string & guid, const std::string & title,
                const ULONG64 & cellCount);
        
        gsoap_resqml2_0_1::_resqml2__UnstructuredGridRepresentation* getSpecializedGsoapProxy() const;

        gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const;

        void setConstantCellShapeGeometryUsingExistingDatasets(const std::string& cellFaceIsRightHanded, const std::string& points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            const std::string& faceIndicesPerCell, ULONG64 faceCountPerCell,
            const std::string& nodeIndicesPerFace, ULONG64 nodeCountPerFace);

        void setConstantCellShapeGeometry(unsigned char * cellFaceIsRightHanded, double * points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            ULONG64 * faceIndicesPerCell, ULONG64 faceCountPerCell,
            ULONG64 * nodeIndicesPerFace, ULONG64 nodeCountPerFace);

        unsigned int constantNodeCountPerFace;
        unsigned int constantFaceCountPerCell;
        ULONG64 * cumulativeNodeCountPerFace;
        ULONG64 * cumulativeFaceCountPerCell;
        ULONG64 * nodeIndicesOfFaces;
        ULONG64 * faceIndicesOfCells;

    public:

        UnstructuredGridRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject):
            resqml2::AbstractGridRepresentation(partialObject, false), constantNodeCountPerFace(0), constantFaceCountPerCell(0),
            cumulativeNodeCountPerFace(nullptr), cumulativeFaceCountPerCell(nullptr),
            nodeIndicesOfFaces(nullptr), faceIndicesOfCells(nullptr)
        {
        }

        UnstructuredGridRepresentation(soap* soapContext, resqml2::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title,
            const ULONG64 & cellCount);

        UnstructuredGridRepresentation(resqml2::AbstractFeatureInterpretation* interp, resqml2::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title,
            const ULONG64 & cellCount);

        UnstructuredGridRepresentation(gsoap_resqml2_0_1::_resqml2__UnstructuredGridRepresentation* fromGsoap):
            resqml2::AbstractGridRepresentation(fromGsoap, false), constantNodeCountPerFace(0), constantFaceCountPerCell(0),
            cumulativeNodeCountPerFace(nullptr), cumulativeFaceCountPerCell(nullptr),
            nodeIndicesOfFaces(nullptr), faceIndicesOfCells(nullptr) {}

        virtual ~UnstructuredGridRepresentation() {}

        bool hasGeometry() const;

        std::string getHdfProxyUuid() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

        void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const;

        void getFaceIndicesOfCells(ULONG64 * faceIndices) const;

        void getCumulativeFaceCountPerCell(ULONG64 * cumulativeFaceCountPerCell) const;

        void getFaceCountPerCell(ULONG64 * faceCountPerCell) const;

        bool isFaceCountOfCellsConstant() const;

        /*
        * Get the constant face count per cell in the grid.
        */
        unsigned int getConstantFaceCountOfCells() const;

        void getNodeIndicesOfFaces(ULONG64 * nodeIndices) const;

        void getCumulativeNodeCountPerFace(ULONG64 * nodeCountPerFace) const;

        void getNodeCountPerFace(ULONG64 * nodeCountPerFace) const;

        bool isNodeCountOfFacesConstant() const;

        /*
        * Get the constant node count per face in the grid.
        */
        unsigned int getConstantNodeCountOfFaces() const;

        void loadGeometry();

        void unloadGeometry();

        unsigned int getFaceCountOfCell(const ULONG64 & cellIndex) const;
    
        unsigned int getNodeCountOfFaceOfCell(const ULONG64 & cellIndex, const unsigned int & localFaceIndex) const;

        ULONG64 * getNodeIndicesOfFaceOfCell(const ULONG64 & cellIndex, const unsigned int & localFaceIndex) const;

        ULONG64 getCellCount() const;

        ULONG64 getFaceCount() const;

        ULONG64 getNodeCount() const;

        void getCellFaceIsRightHanded(unsigned char* cellFaceIsRightHanded) const;

        void setGeometryUsingExistingDatasets(const std::string& cellFaceIsRightHanded, const std::string& points, ULONG64 pointCount, common::AbstractHdfProxy* proxy,
            const std::string& faceIndicesPerCell, const std::string&faceIndicesCumulativeCountPerCell,
            ULONG64 faceCount, const std::string& nodeIndicesPerFace, const std::string& nodeIndicesCumulativeCountPerFace,
            const gsoap_resqml2_0_1::resqml2__CellShape & cellShape);

        void setGeometry(unsigned char * cellFaceIsRightHanded, double * points, ULONG64 pointCount, common::AbstractHdfProxy* proxy,
            ULONG64 * faceIndicesPerCell, ULONG64 * faceIndicesCumulativeCountPerCell,
            ULONG64 faceCount, ULONG64 * nodeIndicesPerFace, ULONG64 * nodeIndicesCumulativeCountPerFace,
            const gsoap_resqml2_0_1::resqml2__CellShape & cellShape);

        void setTetrahedraOnlyGeometryUsingExistingDatasets(const std::string& cellFaceIsRightHanded, const std::string& points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            const std::string& faceIndicesPerCell, const std::string& nodeIndicesPerFace);

        void setTetrahedraOnlyGeometry(unsigned char * cellFaceIsRightHanded, double * points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            ULONG64 * faceIndicesPerCell, ULONG64 * nodeIndicesPerFace);

        void setHexahedraOnlyGeometryUsingExistingDatasets(const std::string& cellFaceIsRightHanded, const std::string& points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            const std::string& faceIndicesPerCell, const std::string& nodeIndicesPerFace);

        void setHexahedraOnlyGeometry(unsigned char * cellFaceIsRightHanded, double * points,
            ULONG64 pointCount, ULONG64 faceCount, common::AbstractHdfProxy* proxy,
            ULONG64 * faceIndicesPerCell, ULONG64 * nodeIndicesPerFace);

        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

        unsigned int getPatchCount() const {return 1;}
    };
}