IjkGridParametricRepresentation.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 "AbstractIjkGridRepresentation.h"
 
namespace RESQML2_NS
{
    class IjkGridParametricRepresentation : public AbstractIjkGridRepresentation
    {   
    public:
        DLL_IMPORT_OR_EXPORT virtual ~IjkGridParametricRepresentation() {}
 
        DLL_IMPORT_OR_EXPORT void getXyzPointsOfKInterfaceSequence(unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double * xyzPoints) final;
 
        DLL_IMPORT_OR_EXPORT void getXyzPointsOfBlock(double * xyzPoints) final;
 
        DLL_IMPORT_OR_EXPORT virtual unsigned int getControlPointMaxCountPerPillar() const = 0;
 
        DLL_IMPORT_OR_EXPORT void getControlPoints(double * controlPoints, bool reverseIAxis = false, bool reverseJAxis= false, bool reverseKAxis= false) const;
 
        DLL_IMPORT_OR_EXPORT virtual bool hasControlPointParameters() const = 0;
 
        DLL_IMPORT_OR_EXPORT void getControlPointParameters(double * controlPointParameters, bool reverseIAxis = false, bool reverseJAxis= false, bool reverseKAxis= false) const;
 
        DLL_IMPORT_OR_EXPORT virtual bool isParametricLineKindConstant() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual short getConstantParametricLineKind() const = 0;
 
        DLL_IMPORT_OR_EXPORT void getParametricLineKind(int16_t* pillarKind, bool reverseIAxis = false, bool reverseJAxis = false) const;
 
        DLL_IMPORT_OR_EXPORT void getParametersOfNodes(double * parameters, bool reverseIAxis = false, bool reverseJAxis= false, bool reverseKAxis= false) const;
 
        DLL_IMPORT_OR_EXPORT void getParametersOfNodesOfKInterfaceSequence(unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double * parameters);
 
        DLL_IMPORT_OR_EXPORT void setGeometryAsParametricNonSplittedPillarNodes(
            gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, bool isRightHanded,
            double const * parameters, double const * controlPoints, double const * controlPointParameters, unsigned int controlPointMaxCountPerPillar, short const * pillarKind,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr);
 
        DLL_IMPORT_OR_EXPORT void setGeometryAsParametricNonSplittedPillarNodesUsingExistingDatasets(
            gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded,
            const std::string & parameters, const std::string & controlPoints, const std::string & controlPointParameters, unsigned int controlPointMaxCountPerPillar, const std::string & pillarKind, const std::string & definedPillars,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr);
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsParametricSplittedPillarNodes(
            gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, bool isRightHanded,
            double const * parameters, double const * controlPoints, double const * controlPointParameters, unsigned int controlPointMaxCountPerPillar, short const * pillarKind, EML2_NS::AbstractHdfProxy* proxy,
            uint64_t splitCoordinateLineCount, unsigned int const * pillarOfCoordinateLine,
            unsigned int const * splitCoordinateLineColumnCumulativeCount, unsigned int const * splitCoordinateLineColumns, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets(
            gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded,
            const std::string & parameters, const std::string & controlPoints, const std::string & controlPointParameters, unsigned int controlPointMaxCountPerPillar, const std::string & pillarKind, const std::string & definedPillars, EML2_NS::AbstractHdfProxy* proxy,
            uint64_t splitCoordinateLineCount, const std::string & pillarOfCoordinateLine,
            const std::string & splitCoordinateLineColumnCumulativeCount, const std::string & splitCoordinateLineColumns, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT void setGeometryAsParametricSplittedPillarNodes(bool isRightHanded,
            double const * parameters, double const * controlPoints, double const * controlPointParameters, unsigned int controlPointCountPerPillar, short pillarKind, EML2_NS::AbstractHdfProxy* proxy,
            uint64_t splitCoordinateLineCount, unsigned int const * pillarOfCoordinateLine,
            unsigned int const * splitCoordinateLineColumnCumulativeCount, unsigned int const * splitCoordinateLineColumns, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr);
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets(
            gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded,
            const std::string & parameters, const std::string & controlPoints, const std::string & controlPointParameters, unsigned int controlPointCountPerPillar, short pillarKind, EML2_NS::AbstractHdfProxy* proxy,
            uint64_t splitCoordinateLineCount, const std::string & pillarOfCoordinateLine,
            const std::string & splitCoordinateLineColumnCumulativeCount, const std::string & splitCoordinateLineColumns, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT bool isNodeGeometryCompressed() const final;
 
        DLL_IMPORT_OR_EXPORT geometryKind getGeometryKind() const final;
 
    protected:
        IjkGridParametricRepresentation(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(repo, guid, title, iCount, jCount, kCount, kGaps, proxy) {}
 
        IjkGridParametricRepresentation(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(interp, guid, title, iCount, jCount, kCount, kGaps, proxy) {}
 
        IjkGridParametricRepresentation(gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation* fromGsoap) : AbstractIjkGridRepresentation(fromGsoap) {}
        IjkGridParametricRepresentation(gsoap_eml2_3::_resqml22__IjkGridRepresentation* fromGsoap) : AbstractIjkGridRepresentation(fromGsoap) {}
        IjkGridParametricRepresentation(gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation* fromGsoap) : AbstractIjkGridRepresentation(fromGsoap) {}
        IjkGridParametricRepresentation(gsoap_eml2_3::_resqml22__TruncatedIjkGridRepresentation* fromGsoap) : AbstractIjkGridRepresentation(fromGsoap) {}
 
        gsoap_resqml2_0_1::resqml20__KDirection computeKDirection(double const * controlPoints, unsigned int controlPointCountPerPillar, short const * pillarKind, EML2_NS::AbstractLocal3dCrs const * localCrs);
 
        void writeGeometryOnHdf(double const * parameters,
            double const * controlPoints, double const * controlPointParameters, unsigned int controlPointCountPerPillar,
            uint64_t splitCoordinateLineCount, unsigned int const * pillarOfCoordinateLine,
            unsigned int const * splitCoordinateLineColumnCumulativeCount, unsigned int const * splitCoordinateLineColumns, EML2_NS::AbstractHdfProxy * proxy);
 
        virtual EML2_NS::AbstractHdfProxy* getParameterDatasetPath(std::string & datasetPathInExternalFile) const = 0;
        virtual EML2_NS::AbstractHdfProxy* getControlPointDatasetPath(std::string & datasetPathInExternalFile) const = 0;
        virtual EML2_NS::AbstractHdfProxy* getControlPointParametersDatasetPath(std::string & datasetPathInExternalFile) const = 0;
        virtual EML2_NS::AbstractHdfProxy* getParametersOfNodesDatasetPath(std::string & datasetPathInExternalFile) const = 0;
        virtual void getRawParametricLineKind(short * pillarKind) const = 0;
        void getXyzPointsFromParametricPoints(double * xyzPoints) const;
 
    private:
        class BSpline
        {
        public:
            BSpline() {};
            BSpline(const std::vector<double>& parametersAtControlPoint, const std::vector<double>& valuesAtControlPoint);
            ~BSpline() = default;
 
            double getValueFromParameter(double param) const;
            void setParameterAndValueAtControlPoint(const std::vector<double>& parametersAtControlPoint, const std::vector<double>& valuesAtControlPoint);
 
        private:
 
            void checkIfParametersIncreaseOrDecrease();
            std::size_t getSplineIndexFromParameter(double param) const;
 
            bool areParametersIncreasing;
 
            // basically each of set of 5 double describe a spline
            std::vector<double> a;
            std::vector<double> b;
            std::vector<double> c;
            std::vector<double> d;
            std::vector<double> parameter; //named x in the wiki link
        };
 
        class PillarInformation
        {
        public:
            uint32_t maxControlPointCount = 0;
            uint32_t parametricLineCount = 0;
            uint64_t splitLineCount = 0;
            std::unique_ptr<double[]> controlPoints;
            std::unique_ptr<double[]> controlPointParameters;
            std::unique_ptr<int16_t[]> pillarKind;
            std::unique_ptr<uint32_t[]> pillarOfSplitCoordLines;
            std::vector< std::vector< BSpline > > splines;
 
            PillarInformation() {}
        };
 
        void loadPillarInformation() const;
 
        void getXyzPointsAlongACoordinateLine(uint64_t pillarIndex, uint64_t coordLineIndex, uint64_t ijNodeCount, uint64_t kNodeCount, double const* parameters, double* xyzPoints) const;
 
        // Use a pointer to keep the instance of this class const when modified (i.e when computed for getting XYZ Points)
        std::unique_ptr<PillarInformation> pillarInformation{ new PillarInformation() };
    };
}