AbstractGridRepresentation.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 "AbstractRepresentation.h"
 
namespace RESQML2_NS
{
    class AbstractGridRepresentation : public AbstractRepresentation
    {
    public:

        virtual ~AbstractGridRepresentation() = default;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getCellCount() const = 0;
 
        //************************************************************
        //****************** GRID CONNECTION SET *********************
        //************************************************************

        DLL_IMPORT_OR_EXPORT std::vector<class GridConnectionSetRepresentation*> getGridConnectionSetRepresentationSet() const;

        DLL_IMPORT_OR_EXPORT uint64_t getGridConnectionSetRepresentationCount() const; // It is mainly used in SWIG context for parsing the vector from a non C++ language.

        DLL_IMPORT_OR_EXPORT class GridConnectionSetRepresentation * getGridConnectionSetRepresentation(uint64_t index) const; // It is mainly used in SWIG context for parsing the vector from a non C++ language.
 
 
        //************************************************************
        //******************** GRID PARENTAGE ************************
        //************************************************************

        DLL_IMPORT_OR_EXPORT AbstractGridRepresentation* getParentGrid() const;

        COMMON_NS::DataObjectReference getParentGridDor() const;

        DLL_IMPORT_OR_EXPORT std::vector<RESQML2_NS::AbstractGridRepresentation *> getChildGridSet() const;

        DLL_IMPORT_OR_EXPORT uint64_t getChildGridCount() const;

        DLL_IMPORT_OR_EXPORT AbstractGridRepresentation * getChildGrid(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT void setParentWindow(uint64_t* cellIndices, uint64_t cellIndexCount, class UnstructuredGridRepresentation* parentGrid, EML2_NS::AbstractHdfProxy* proxy = nullptr);

        DLL_IMPORT_OR_EXPORT void setParentWindow(unsigned int * columnIndices, uint64_t columnIndexCount,
            unsigned int kLayerIndexRegridStart,
            unsigned int * childCellCountPerInterval, unsigned int * parentCellCountPerInterval, uint64_t intervalCount,
            class AbstractColumnLayerGridRepresentation* parentGrid,
            EML2_NS::AbstractHdfProxy * proxy = nullptr, double * childCellWeights = nullptr);

        DLL_IMPORT_OR_EXPORT void setParentWindow(
            unsigned int iCellIndexRegridStart, unsigned int * childCellCountPerIInterval, unsigned int * parentCellCountPerIInterval, uint64_t iIntervalCount,
            unsigned int jCellIndexRegridStart, unsigned int * childCellCountPerJInterval, unsigned int * parentCellCountPerJInterval, uint64_t jIntervalCount,
            unsigned int kCellIndexRegridStart, unsigned int * childCellCountPerKInterval, unsigned int * parentCellCountPerKInterval, uint64_t kIntervalCount,
            class AbstractIjkGridRepresentation* parentGrid, EML2_NS::AbstractHdfProxy * proxy = nullptr, double * iChildCellWeights = nullptr, double * jChildCellWeights = nullptr, double * kChildCellWeights = nullptr);

        DLL_IMPORT_OR_EXPORT void setParentWindow(
            unsigned int iCellIndexRegridStart, unsigned int constantChildCellCountPerIInterval, unsigned int constantParentCellCountPerIInterval, uint64_t iIntervalCount,
            unsigned int jCellIndexRegridStart, unsigned int constantChildCellCountPerJInterval, unsigned int constantParentCellCountPerJInterval, uint64_t jIntervalCount,
            unsigned int kCellIndexRegridStart, unsigned int constantChildCellCountPerKInterval, unsigned int constantParentCellCountPerKInterval, uint64_t kIntervalCount,
            class AbstractIjkGridRepresentation* parentGrid, EML2_NS::AbstractHdfProxy * proxy = nullptr, double * iChildCellWeights = nullptr, double * jChildCellWeights = nullptr, double * kChildCellWeights = nullptr);

        DLL_IMPORT_OR_EXPORT void setParentWindow(
            unsigned int iCellIndexRegridStart, unsigned int iChildCellCount, unsigned int iParentCellCount,
            unsigned int jCellIndexRegridStart, unsigned int jChildCellCount, unsigned int jParentCellCount,
            unsigned int kCellIndexRegridStart, unsigned int kChildCellCount, unsigned int kParentCellCount,
            class AbstractIjkGridRepresentation* parentGrid, EML2_NS::AbstractHdfProxy * proxy = nullptr, double * iChildCellWeights = nullptr, double * jChildCellWeights = nullptr, double * kChildCellWeights = nullptr);

        DLL_IMPORT_OR_EXPORT void setForcedNonRegridedParentCell(uint64_t* cellIndices, uint64_t cellIndexCount);

        DLL_IMPORT_OR_EXPORT void setCellOverlap(uint64_t parentChildCellPairCount, uint64_t* parentChildCellPair,
            const std::string& volumeUom, double* overlapVolumes = nullptr);

        DLL_IMPORT_OR_EXPORT uint64_t getParentCellIndexCount() const;

        DLL_IMPORT_OR_EXPORT void getParentCellIndices(uint64_t * parentCellIndices) const;

        DLL_IMPORT_OR_EXPORT uint64_t getParentColumnIndexCount() const;

        DLL_IMPORT_OR_EXPORT void getParentColumnIndices(uint64_t * parentColumnIndices) const;

        DLL_IMPORT_OR_EXPORT uint64_t getRegridStartIndexOnParentGrid(char dimension) const;

        DLL_IMPORT_OR_EXPORT uint64_t getRegridIntervalCount(char dimension) const;

        DLL_IMPORT_OR_EXPORT bool isRegridCellCountPerIntervalConstant(char dimension, bool childVsParentCellCount) const;

        DLL_IMPORT_OR_EXPORT uint64_t getRegridConstantCellCountPerInterval(char dimension, bool childVsParentCellCount) const;

        DLL_IMPORT_OR_EXPORT void getRegridCellCountPerInterval(char dimension, uint64_t* childCellCountPerInterval, bool childVsParentCellCount) const;

        DLL_IMPORT_OR_EXPORT bool hasRegridChildCellWeights(char dimension) const;

        DLL_IMPORT_OR_EXPORT void getRegridChildCellWeights(char dimension, double* childCellWeights) const;

        DLL_IMPORT_OR_EXPORT bool hasForcedNonRegridedParentCell() const;
 
        //************************************************************
        //**************** LINK WITH STRATIGRAPHY ********************
        //************************************************************

        DLL_IMPORT_OR_EXPORT void setCellAssociationWithStratigraphicOrganizationInterpretation(int64_t* stratiUnitIndices, int64_t nullValue, class AbstractStratigraphicOrganizationInterpretation* stratiOrgInterp);
        
        DLL_IMPORT_OR_EXPORT class AbstractStratigraphicOrganizationInterpretation* getStratigraphicOrganizationInterpretation() const;

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getStratigraphicOrganizationInterpretationDor() const;

        DLL_IMPORT_OR_EXPORT bool hasCellStratigraphicUnitIndices() const;

        DLL_IMPORT_OR_EXPORT int64_t getCellStratigraphicUnitIndices(int64_t * stratiUnitIndices);
 
        //************************************************************
        //**************** LINK WITH ROCKFLUID ********************
        //************************************************************

        DLL_IMPORT_OR_EXPORT void setCellAssociationWithRockFluidOrganizationInterpretation(int64_t* rockFluidUnitIndices, int64_t nullValue, class RockFluidOrganizationInterpretation* rockFluidOrgInterp);
        
        DLL_IMPORT_OR_EXPORT class RockFluidOrganizationInterpretation* getRockFluidOrganizationInterpretation() const;

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getRockFluidOrganizationInterpretationDor() const;

        DLL_IMPORT_OR_EXPORT bool hasCellFluidPhaseUnitIndices() const;

        DLL_IMPORT_OR_EXPORT int64_t getCellFluidPhaseUnitIndices(int64_t * rockfluidUnitIndices);
 
 
        //************************************************************
        //********************** TRUNCATION **************************
        //************************************************************

        DLL_IMPORT_OR_EXPORT bool isTruncated() const;

        DLL_IMPORT_OR_EXPORT uint64_t getTruncatedFaceCount() const;

        DLL_IMPORT_OR_EXPORT void getNodeIndicesOfTruncatedFaces(uint64_t * nodeIndices) const;

        DLL_IMPORT_OR_EXPORT void getCumulativeNodeCountPerTruncatedFace(uint64_t * nodeCountPerFace) const;

        DLL_IMPORT_OR_EXPORT void getNodeCountPerTruncatedFace(uint64_t * nodeCountPerFace) const;

        DLL_IMPORT_OR_EXPORT uint64_t getTruncatedCellCount() const;

        DLL_IMPORT_OR_EXPORT void getTruncatedCellIndices(uint64_t* cellIndices) const;

        DLL_IMPORT_OR_EXPORT void getTruncatedFaceIndicesOfTruncatedCells(uint64_t * faceIndices) const;

        DLL_IMPORT_OR_EXPORT void getCumulativeTruncatedFaceCountPerTruncatedCell(uint64_t * cumulativeFaceCountPerCell) const;

        DLL_IMPORT_OR_EXPORT void getTruncatedFaceCountPerTruncatedCell(uint64_t * faceCountPerCell) const;

        DLL_IMPORT_OR_EXPORT void getNonTruncatedFaceIndicesOfTruncatedCells(uint64_t * faceIndices) const;

        DLL_IMPORT_OR_EXPORT void getCumulativeNonTruncatedFaceCountPerTruncatedCell(uint64_t * cumulativeFaceCountPerCell) const;

        DLL_IMPORT_OR_EXPORT void getNonTruncatedFaceCountPerTruncatedCell(uint64_t * faceCountPerCell) const;

        DLL_IMPORT_OR_EXPORT void getTruncatedFaceIsRightHanded(uint8_t* cellFaceIsRightHanded) const;

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "AbstractGridRepresentation";

        void loadTargetRelationships() override;
 
    protected:

        AbstractGridRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject, bool withTruncatedPillars) :AbstractRepresentation(partialObject), withTruncatedPillars(withTruncatedPillars) {}

        AbstractGridRepresentation(bool withTruncatedPillars) : withTruncatedPillars(withTruncatedPillars) {}

        AbstractGridRepresentation(gsoap_resqml2_0_1::resqml20__AbstractGridRepresentation* fromGsoap, bool withTruncatedPillars) : AbstractRepresentation(fromGsoap), withTruncatedPillars(withTruncatedPillars) {}
        AbstractGridRepresentation(gsoap_eml2_3::resqml22__AbstractGridRepresentation* fromGsoap, bool withTruncatedPillars) : AbstractRepresentation(fromGsoap), withTruncatedPillars(withTruncatedPillars) {}

        bool withTruncatedPillars;
 
    private:

        gsoap_resqml2_0_1::resqml20__Regrid* createRegrid2_0_1(uint32_t indexRegridStart, uint32_t* childCellCountPerInterval, uint32_t* parentCellCountPerInterval, uint64_t intervalCount, double* childCellWeights,
            const std::string& dimension, EML2_NS::AbstractHdfProxy* proxy, bool forceConstantCellCountPerInterval = false);
        gsoap_eml2_3::resqml22__Regrid* createRegrid2_2(uint32_t indexRegridStart, uint32_t* childCellCountPerInterval, uint32_t* parentCellCountPerInterval, uint64_t intervalCount, double* childCellWeights,
            const std::string& dimension, EML2_NS::AbstractHdfProxy* proxy, bool forceConstantCellCountPerInterval = false);
 
        /*
        * @param    dimension                   It must be either 'i', 'j' ou 'k' (upper or lower case) for an ijk parent grid. 'k' for a strict column layer parent grid.
        * @param    childVsParentCellCount      If true return the child cell count per interval. If false return the parent cell count per interval.
        */
        gsoap_resqml2_0_1::resqml20__AbstractIntegerArray* getCellCountPerInterval2_0_1(char dimension, bool childVsParentCellCount) const;
        gsoap_eml2_3::eml23__AbstractIntegerArray* getCellCountPerInterval2_2(char dimension, bool childVsParentCellCount) const;

        gsoap_resqml2_0_1::resqml20__AbstractParentWindow* getParentWindow2_0_1() const;
        gsoap_eml2_3::resqml22__AbstractParentWindow* getParentWindow2_2() const;
    };
}