AbstractIjkGridRepresentation.h

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

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/AbstractColumnLayerGridRepresentation.h"

#include <stdexcept>

namespace resqml2_0_1
{
    class DLL_IMPORT_OR_EXPORT AbstractIjkGridRepresentation : public resqml2::AbstractColumnLayerGridRepresentation
    {
    private :

        void init(soap* soapContext, resqml2::AbstractLocal3dCrs * crs,
                const std::string & guid, const std::string & title,
                const unsigned int & iCount, const unsigned int & jCount, const unsigned int & kCount,
                bool withTruncatedPillars);

    protected :

        AbstractIjkGridRepresentation(gsoap_resqml2_0_1::_resqml2__IjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, false), splitInformation(nullptr) {}
        AbstractIjkGridRepresentation(gsoap_resqml2_0_1::_resqml2__TruncatedIjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, true), splitInformation(nullptr) {}

        gsoap_resqml2_0_1::_resqml2__IjkGridRepresentation* getSpecializedGsoapProxy() const;
        gsoap_resqml2_0_1::_resqml2__TruncatedIjkGridRepresentation* getSpecializedTruncatedGsoapProxy() const;

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

        std::vector< std::pair< unsigned int, std::vector<unsigned int> > >* splitInformation;

    public:

        enum geometryKind { UNKNOWN = 0, EXPLICIT = 1, PARAMETRIC = 2, LATTICE = 3, NO_GEOMETRY = 4}; // UNKNOWN exists in case of partial transfer

        AbstractIjkGridRepresentation(soap* soapContext, resqml2::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title,
            const unsigned int & iCount, const unsigned int & jCount, const unsigned int & kCount,
            bool withTruncatedPillars = false);

        AbstractIjkGridRepresentation(resqml2::AbstractFeatureInterpretation* interp, resqml2::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title,
            const unsigned int & iCount, const unsigned int & jCount, const unsigned int & kCount,
            bool withTruncatedPillars = false);

        AbstractIjkGridRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject,
            bool withTruncatedPillars = false) :
            AbstractColumnLayerGridRepresentation(nullptr, partialObject, withTruncatedPillars), splitInformation(nullptr)
        {
        }

        virtual ~AbstractIjkGridRepresentation() {}

        unsigned int getICellCount() const;

        void setICellCount(const unsigned int & iCount);

        unsigned int getJCellCount() const;

        void setJCellCount(const unsigned int & jCount);

        ULONG64 getCellCount() const {return getICellCount() * getJCellCount() * getKCellCount();}

        unsigned int getColumnCount() const {return getICellCount() * getJCellCount();}

        unsigned int getPillarCount() const {return (getICellCount()+1) * (getJCellCount()+1);}

        unsigned int getFaceCount() const;

        unsigned int getIPillarFromGlobalIndex(const unsigned int & globalIndex) const;

        unsigned int getJPillarFromGlobalIndex(const unsigned int & globalIndex) const;

        unsigned int getGlobalIndexPillarFromIjIndex(const unsigned int & iPillar, const unsigned int & jPillar) const;

        unsigned int getIColumnFromGlobalIndex(const unsigned int & globalIndex) const;

        unsigned int getJColumnFromGlobalIndex(const unsigned int & globalIndex) const;

        unsigned int getGlobalIndexColumnFromIjIndex(const unsigned int & iColumn, const unsigned int & jColumn) const;

        unsigned int getGlobalIndexCellFromIjkIndex(const unsigned int & iCell, const unsigned int & jCell, const unsigned int & kCell) const;

        bool isRightHanded() const;

        void getPillarsOfSplitCoordinateLines(unsigned int * pillarIndices, bool reverseIAxis = false, bool reverseJAxis = false) const;

        void getColumnsOfSplitCoordinateLines(unsigned int * columnIndices, bool reverseIAxis = false, bool reverseJAxis = false) const;
        void getColumnCountOfSplitCoordinateLines(unsigned int * columnIndexCountPerSplitCoordinateLine) const;

        unsigned long getSplitCoordinateLineCount() const;

        ULONG64 getSplitNodeCount() const;
        
        void getPillarGeometryIsDefined(bool * pillarGeometryIsDefined, bool reverseIAxis = false, bool reverseJAxis = false) const;

        bool hasEnabledCellInformation() const;

        void getEnabledCells(bool * enabledCells, bool reverseIAxis = false, bool reverseJAxis= false, bool reverseKAxis= false) const;

        void setEnabledCells(unsigned char* enabledCells);

        void loadSplitInformation();

        void unloadSplitInformation();

        bool isColumnEdgeSplitted(const unsigned int & iColumn, const unsigned int & jColumn, const unsigned int & edge) const;

        ULONG64 getXyzPointIndexFromCellCorner(const unsigned int & iCell, const unsigned int & jCell, const unsigned int & kCell, const unsigned int & corner) const;

        ULONG64 getXyzPointCountOfKInterfaceOfPatch(const unsigned int & patchIndex) const;

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

        virtual void getXyzPointsOfKInterfaceSequenceOfPatch(const unsigned int & kInterfaceStart, const unsigned int & kInterfaceEnd, const unsigned int & patchIndex, double * xyzPoints) { throw std::logic_error("Partial object"); }

        gsoap_resqml2_0_1::resqml2__KDirection getKDirection() const;

        virtual geometryKind getGeometryKind() const { return UNKNOWN; }
        virtual std::string getHdfProxyUuid() const { throw std::logic_error("Partial object"); }
        virtual ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const { throw std::logic_error("Partial object"); }
        virtual void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const { throw std::logic_error("Partial object"); }

        static const char* XML_TAG;
        static const char* XML_TAG_TRUNCATED;
        virtual std::string getXmlTag() const;

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