AbstractIjkGridRepresentation.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
  http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once
 
#include "AbstractColumnLayerGridRepresentation.h"
 
#include <stdexcept>
#include <map>
 
namespace RESQML2_NS
{
    class AbstractIjkGridRepresentation : public RESQML2_NS::AbstractColumnLayerGridRepresentation
    {
    public:
 
        enum geometryKind { UNKNOWN = 0, EXPLICIT = 1, PARAMETRIC = 2, LATTICE = 3, NO_GEOMETRY = 4}; // UNKNOWN exists in case of partial transfer
 
        AbstractIjkGridRepresentation(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid, const std::string & title,
            unsigned int iCount, unsigned int jCount, unsigned int kCount, bool* kGaps = nullptr, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        AbstractIjkGridRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp,
            const std::string & guid, const std::string & title,
            unsigned int iCount, unsigned int jCount, unsigned int kCount, bool* kGaps = nullptr, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        /*
        AbstractIjkGridRepresentation(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid, const std::string & title,
            unsigned int iCount, unsigned int jCount, unsigned int kCount,
            unsigned int truncationNodeCount, unsigned int truncationFaceCount, unsigned int truncationCellCount);
            */
        /*
        AbstractIjkGridRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp,
            const std::string & guid, const std::string & title,
            unsigned int iCount, unsigned int jCount, unsigned int kCount,
            unsigned int truncationNodeCount, unsigned int truncationFaceCount, unsigned int truncationCellCount);
            */
        DLL_IMPORT_OR_EXPORT AbstractIjkGridRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject, bool withTruncatedPillars = false);
 
        DLL_IMPORT_OR_EXPORT virtual ~AbstractIjkGridRepresentation()
        {
            if (blockInformation != nullptr)
                delete blockInformation;
        }
 
        DLL_IMPORT_OR_EXPORT unsigned int getICellCount() const;
 
        DLL_IMPORT_OR_EXPORT void setICellCount(unsigned int iCount);
 
        DLL_IMPORT_OR_EXPORT unsigned int getJCellCount() const;
 
        DLL_IMPORT_OR_EXPORT void setJCellCount(unsigned int jCount);
 
        DLL_IMPORT_OR_EXPORT uint64_t getCellCount() const final { return getICellCount() * getJCellCount() * getKCellCount(); }
 
        DLL_IMPORT_OR_EXPORT unsigned int getColumnCount() const { return getICellCount() * getJCellCount(); }
 
        DLL_IMPORT_OR_EXPORT unsigned int getPillarCount() const { return (getICellCount()+1) * (getJCellCount()+1); }
 
        DLL_IMPORT_OR_EXPORT unsigned int getKGapsCount() const;
 
        DLL_IMPORT_OR_EXPORT void getKGaps(bool * kGaps) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getFaceCount() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getIPillarFromGlobalIndex(unsigned int globalIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getJPillarFromGlobalIndex(unsigned int globalIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getGlobalIndexPillarFromIjIndex(unsigned int iPillar, unsigned int jPillar) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getIColumnFromGlobalIndex(unsigned int globalIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getJColumnFromGlobalIndex(unsigned int globalIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getGlobalIndexColumnFromIjIndex(unsigned int iColumn, unsigned int jColumn) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getGlobalIndexCellFromIjkIndex(unsigned int iCell, unsigned int jCell, unsigned int kCell) const;
 
        DLL_IMPORT_OR_EXPORT bool isRightHanded() const;
 
        DLL_IMPORT_OR_EXPORT void getPillarsOfSplitCoordinateLines(unsigned int * pillarIndices, bool reverseIAxis = false, bool reverseJAxis = false) const;
 
        DLL_IMPORT_OR_EXPORT void getColumnsOfSplitCoordinateLines(unsigned int * columnIndices, bool reverseIAxis = false, bool reverseJAxis = false) const;
 
        DLL_IMPORT_OR_EXPORT void getColumnCountOfSplitCoordinateLines(unsigned int * columnIndexCountPerSplitCoordinateLine) const;
 
        DLL_IMPORT_OR_EXPORT unsigned long getSplitCoordinateLineCount() const;
 
        DLL_IMPORT_OR_EXPORT unsigned long getBlockSplitCoordinateLineCount() const;
 
        DLL_IMPORT_OR_EXPORT uint64_t getSplitNodeCount() const;
 
        DLL_IMPORT_OR_EXPORT void getPillarGeometryIsDefined(bool * pillarGeometryIsDefined, bool reverseIAxis = false, bool reverseJAxis = false) const;
 
        DLL_IMPORT_OR_EXPORT bool hasCellGeometryIsDefinedFlags() const;
 
        DLL_IMPORT_OR_EXPORT void getCellGeometryIsDefinedFlags(bool* cellGeometryIsDefinedFlags, bool reverseIAxis = false, bool reverseJAxis= false, bool reverseKAxis= false) const;
 
        DLL_IMPORT_OR_EXPORT void setCellGeometryIsDefinedFlags(unsigned char* cellGeometryIsDefinedFlags, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void setAllCellGeometryFlagsToDefined();
 
        DLL_IMPORT_OR_EXPORT void loadSplitInformation();
 
        DLL_IMPORT_OR_EXPORT void loadBlockInformation(unsigned int iInterfaceStart, unsigned int iInterfaceEnd, unsigned int jInterfaceStart, unsigned int jInterfaceEnd, unsigned int kInterfaceStart, unsigned int kInterfaceEnd);
 
        DLL_IMPORT_OR_EXPORT void unloadSplitInformation();
 
        DLL_IMPORT_OR_EXPORT bool isColumnEdgeSplitted(unsigned int iColumn, unsigned int jColumn, unsigned int edge) const;
 
        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointIndexFromCellCorner(unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner) const;
 
        DLL_IMPORT_OR_EXPORT void getXyzPointOfBlockFromCellCorner(unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner,
            const double* xyzPoints, double & x, double & y, double & z) const;
 
        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfKInterface() const;
 
        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfBlock() const;
 
        /*
         * Gets all the XYZ points of a particular K interface. XYZ points are given in the local CRS.
         * This method is not const since it is optimized in order not to recompute the pillar
         * information but to get it as input.
         *
         * @param           kInterface  The K interface index starting from zero to kCellCount.
         * @param [out] xyzPoints       A linearized 2d array where the first (quickest) dimension is
         *                              coordinate dimension (XYZ) and second dimension is vertex
         *                              dimension. It must be pre allocated with a size of
         *                              <tt>3 * getXyzPointCountOfKInterface()</tt>.
         */
        DLL_IMPORT_OR_EXPORT void getXyzPointsOfKInterface(unsigned int kInterface, double * xyzPoints);
 
        DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfKInterfaceSequence(unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double * xyzPoints);
 
        DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfBlock(double * xyzPoints);
 
        DLL_IMPORT_OR_EXPORT virtual bool isNodeGeometryCompressed() const { return false; }
 
        DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__KDirection getKDirection() const override;
 
        DLL_IMPORT_OR_EXPORT virtual geometryKind getGeometryKind() const { return UNKNOWN; }
 
        virtual COMMON_NS::DataObjectReference getHdfProxyDor() const override { throw std::logic_error("Partial object"); }
 
        DLL_IMPORT_OR_EXPORT virtual uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const override;
 
        DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfPatch(unsigned int patchIndex, double * xyzPoints) const override;
 
        DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
 
        DLL_IMPORT_OR_EXPORT static const char* XML_TAG_TRUNCATED;
 
        DLL_IMPORT_OR_EXPORT std::string getXmlTag() const final;
 
        DLL_IMPORT_OR_EXPORT unsigned int getPatchCount() const override {return 1;}
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlNamespace() const override {
            if (gsoapProxy2_0_1 != nullptr) { return "resqml20"; }
            if (gsoapProxy2_3 != nullptr) { return "resqml22"; }
 
 
            if (partialObject != nullptr) {
                if (partialObject->ContentType.find("x-resqml+xml;version=2.0") != std::string::npos) { return "resqml20"; }
                if (partialObject->ContentType.find("x-resqml+xml;version=2.2") != std::string::npos) { return "resqml22"; }
            }
 
            throw std::logic_error("Cannot infer what is the Energistics namespace of this instance.");
        }
 
    protected:
 
        AbstractIjkGridRepresentation(gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, false), splitInformation(nullptr), kCellIndexWithGapLayer(nullptr), blockInformation(nullptr) {}
 
        AbstractIjkGridRepresentation(gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, true), splitInformation(nullptr), kCellIndexWithGapLayer(nullptr), blockInformation(nullptr) {}
        AbstractIjkGridRepresentation(gsoap_eml2_3::_resqml22__IjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, false), splitInformation(nullptr), kCellIndexWithGapLayer(nullptr), blockInformation(nullptr) {}
        AbstractIjkGridRepresentation(gsoap_eml2_3::_resqml22__TruncatedIjkGridRepresentation* fromGsoap) : AbstractColumnLayerGridRepresentation(fromGsoap, true), splitInformation(nullptr), kCellIndexWithGapLayer(nullptr), blockInformation(nullptr) {}
 
        gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation* getSpecializedGsoapProxy2_0_1() const;
        gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation* getSpecializedTruncatedGsoapProxy2_0_1() const;
        gsoap_eml2_3::_resqml22__IjkGridRepresentation* getSpecializedGsoapProxy2_2() const;
        gsoap_eml2_3::_resqml22__TruncatedIjkGridRepresentation* getSpecializedTruncatedGsoapProxy2_2() const;
 
        gsoap_resqml2_0_1::resqml20__PointGeometry* getPointGeometry2_0_1(unsigned int patchIndex) const final;
        gsoap_eml2_3::resqml22__PointGeometry* getPointGeometry2_2(unsigned int patchIndex) const final;
 
        std::vector< std::pair< unsigned int, std::vector<unsigned int> > >* splitInformation;
 
        unsigned int* kCellIndexWithGapLayer;
 
        class BlockInformation
        {
        public:
 
            unsigned int iInterfaceStart;
            unsigned int iInterfaceEnd;
            unsigned int jInterfaceStart;
            unsigned int jInterfaceEnd;
            unsigned int kInterfaceStart;
            unsigned int kInterfaceEnd;
 
            std::map<unsigned int, unsigned int> globalToLocalSplitCoordinateLinesIndex;
 
            BlockInformation() = default;
 
            ~BlockInformation() = default;
        };
 
        BlockInformation* blockInformation;
 
    private:
 
        void init(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid, const std::string & title,
            unsigned int iCount, unsigned int jCount, unsigned int kCount, bool* kGaps, EML2_NS::AbstractHdfProxy* proxy = nullptr);
    };
}