ResInsight/ApplicationLibCode/ReservoirDataModel/SimulationFile/RigSimulationInputSettings.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2025-     Equinor ASA
//
//  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 "RiaModelExportDefines.h"
#include "RigModelPaddingSettings.h"
#include "RigRefinement.h"

#include "cafAppEnum.h"
#include "cafVecIjk.h"

#include <QString>

#include <expected>
#include <memory>
#include <string>
#include <vector>

namespace Opm
{
class DeckRecord;
}

//==================================================================================================
///
/// Settings for exporting simulation input files (sector models)
///
//==================================================================================================
class RigSimulationInputSettings
{
public:
    using BoundaryConditionEnum = caf::AppEnum<RiaModelExportDefines::BoundaryCondition>;

    RigSimulationInputSettings();

    // Sector bounds (0-based grid coordinates)
    caf::VecIjk0 min() const;
    caf::VecIjk0 max() const;
    void         setMin( const caf::VecIjk0& min );
    void         setMax( const caf::VecIjk0& max );

    std::expected<void, QString> validateBox() const;

    // Unified refinement interface
    const RigRefinement& refinement() const;
    void                 setRefinement( std::unique_ptr<RigRefinement> refinement );
    bool                 hasRefinement() const;

    // Keyword handling
    const std::vector<std::string>& keywordsToRemove() const;
    void                            setKeywordsToRemove( const std::vector<std::string>& keywords );

    // Boundary conditions
    std::vector<Opm::DeckRecord> bcpropKeywords() const;
    void                         setBcpropKeywords( const std::vector<Opm::DeckRecord>& keywords );

    RiaModelExportDefines::BoundaryCondition boundaryCondition() const;
    void                                     setBoundaryCondition( RiaModelExportDefines::BoundaryCondition value );

    double porvMultiplier() const;
    void   setPorvMultiplier( double value );

    // File paths
    QString inputDeckFileName() const;
    void    setInputDeckFileName( const QString& fileName );

    QString outputDeckFileName() const;
    void    setOutputDeckFileName( const QString& fileName );

    // Model padding
    const RigModelPaddingSettings& paddingSettings() const;
    void                           setPaddingSettings( const RigModelPaddingSettings& settings );

private:
    caf::VecIjk0                   m_min;
    caf::VecIjk0                   m_max;
    std::unique_ptr<RigRefinement> m_refinement;
    std::vector<std::string>       m_keywordsToRemove;
    std::vector<Opm::DeckRecord>   m_bcpropKeywords;
    BoundaryConditionEnum          m_boundaryCondition;
    double                         m_porvMultiplier;
    QString                        m_inputDeckFileName;
    QString                        m_outputDeckFileName;
    RigModelPaddingSettings        m_paddingSettings;
};