ResInsight/ApplicationLibCode/ReservoirDataModel/RigFault.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) Statoil ASA
//  Copyright (C) Ceetron Solutions AS
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "cvfBoundingBox.h"
#include "cvfCellRange.h"
#include "cvfObject.h"
#include "cvfStructGrid.h"
#include "cvfVector3.h"

#include <QString>

#include <array>
#include <utility>
#include <vector>

class RigMainGrid;

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class RigFaultsPrCellAccumulator : public cvf::Object
{
public:
    enum
    {
        NO_FAULT      = -1,
        UNKNOWN_FAULT = -2
    };

public:
    explicit RigFaultsPrCellAccumulator( size_t reservoirCellCount );

    int faultIdx( size_t reservoirCellIndex, cvf::StructGridInterface::FaceType face ) const;

    void setFaultIdx( size_t reservoirCellIndex, cvf::StructGridInterface::FaceType face, int faultIdx );

private:
    std::vector<std::array<int, 6>> m_faultIdxForCellFace;
};

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class RigFault : public cvf::Object
{
public:
    using CellAndFace = std::tuple<size_t, size_t, size_t, cvf::StructGridInterface::FaceType>;

    struct FaultFace
    {
        FaultFace( size_t nativeReservoirCellIndex, cvf::StructGridInterface::FaceType nativeFace, size_t oppositeReservoirCellIndex )
            : m_nativeReservoirCellIndex( nativeReservoirCellIndex )
            , m_nativeFace( nativeFace )
            , m_oppositeReservoirCellIndex( oppositeReservoirCellIndex )
        {
        }

        size_t                             m_nativeReservoirCellIndex;
        cvf::StructGridInterface::FaceType m_nativeFace;
        size_t                             m_oppositeReservoirCellIndex;
    };

public:
    RigFault();

    void    setName( const QString& name );
    QString name() const;

    void addCellRangeForFace( cvf::StructGridInterface::FaceType face, const cvf::CellRange& cellRange );
    void computeFaultFacesFromCellRanges( const RigMainGrid* grid );

    void accumulateFaultsPrCell( RigFaultsPrCellAccumulator* faultsPrCellAcc, int faultIdx );

    std::vector<FaultFace>&       faultFaces();
    const std::vector<FaultFace>& faultFaces() const;

    std::vector<size_t>&       connectionIndices();
    const std::vector<size_t>& connectionIndices() const;

    static bool ordering( CellAndFace first, CellAndFace second );

private:
    QString m_name;

    std::array<std::vector<cvf::CellRange>, 6> m_cellRangesForFaces;

    std::vector<FaultFace> m_faultFaces;
    std::vector<size_t>    m_connectionIndices;

    static cvf::ref<RigFaultsPrCellAccumulator> m_faultsPrCellAcc;
};