ResInsight/ApplicationLibCode/ProjectDataModel/Completions/RimMswCompletionParameters.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2018     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 "RiaDefines.h"
#include "RimCompletionEnums.h"

#include "cafPdmChildField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmUiGroup.h"

#include <QDateTime>

class RimDiameterRoughnessIntervalCollection;
class RimCustomSegmentIntervalCollection;

class RimMswCompletionParameters : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    using ReferenceMDType    = RimCompletionEnums::ReferenceMDType;
    using PressureDropType   = RimCompletionEnums::PressureDropType;
    using LengthAndDepthType = RimCompletionEnums::LengthAndDepthType;

    enum class DiameterRoughnessMode
    {
        UNIFORM,
        INTERVALS
    };

    using ReferenceMDEnum           = caf::AppEnum<ReferenceMDType>;
    using PressureDropEnum          = caf::AppEnum<PressureDropType>;
    using LengthAndDepthEnum        = caf::AppEnum<LengthAndDepthType>;
    using DiameterRoughnessModeEnum = caf::AppEnum<DiameterRoughnessMode>;

    RimMswCompletionParameters();
    ~RimMswCompletionParameters() override;

    RimMswCompletionParameters& operator=( const RimMswCompletionParameters& rhs );

    ReferenceMDType    referenceMDType() const;
    double             manualReferenceMD() const;
    double             linerDiameter( RiaDefines::EclipseUnitSystem unitSystem ) const;
    double             linerDiameter() const;
    double             roughnessFactor() const;
    double             roughnessFactor( RiaDefines::EclipseUnitSystem unitSystem ) const;
    PressureDropEnum   pressureDrop() const;
    LengthAndDepthEnum lengthAndDepth() const;
    double             maxSegmentLength() const;

    // Stored values for legacy migration, including settings currently disabled in the UI.
    double storedReferenceMD() const;
    bool   customValuesForLateral() const;
    bool   enforceMaxSegmentLength() const;
    double storedMaxSegmentLength() const;

    void setReferenceMDType( ReferenceMDType refType );
    void setManualReferenceMD( double manualRefMD );
    void setLinerDiameter( double diameter );
    void setRoughnessFactor( double roughnessFactor );
    void setPressureDrop( PressureDropType pressureDropType );
    void setLengthAndDepth( LengthAndDepthType lengthAndDepthType );

    // New interval-based methods
    DiameterRoughnessMode diameterRoughnessMode() const;
    void                  setDiameterRoughnessMode( DiameterRoughnessMode mode );
    bool                  isUsingIntervalSpecificValues() const;

    double getDiameterAtMD( double md, RiaDefines::EclipseUnitSystem unitSystem ) const;
    double getRoughnessAtMD( double md, RiaDefines::EclipseUnitSystem unitSystem ) const;

    // Date-aware overloads (only returns values from intervals active on the given date)
    double getDiameterAtMD( double md, RiaDefines::EclipseUnitSystem unitSystem, const QDateTime& exportDate ) const;
    double getRoughnessAtMD( double md, RiaDefines::EclipseUnitSystem unitSystem, const QDateTime& exportDate ) const;

    RimDiameterRoughnessIntervalCollection* diameterRoughnessIntervals() const;

    // Custom segment intervals
    RimCustomSegmentIntervalCollection*    customSegmentIntervals() const;
    std::vector<std::pair<double, double>> getSegmentIntervals() const;
    bool                                   hasCustomSegmentIntervals() const;

    void setUnitSystemSpecificDefaults();

    void updateFromTopLevelWell( const RimMswCompletionParameters* topLevelWellParameters );

    // Public static methods for default values - used by interval classes
    static double defaultLinerDiameter( RiaDefines::EclipseUnitSystem unitSystem );
    static double defaultRoughnessFactor( RiaDefines::EclipseUnitSystem unitSystem );

    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;

protected:
    void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
    void initAfterRead() override;
    void defineCustomContextMenu( const caf::PdmFieldHandle* fieldNeedingMenu, QMenu* menu, QWidget* fieldEditorWidget ) override;

private:
    caf::PdmField<ReferenceMDEnum> m_refMDType;
    caf::PdmField<double>          m_refMD;

    caf::PdmField<bool>   m_customValuesForLateral;
    caf::PdmField<double> m_linerDiameter;
    caf::PdmField<double> m_roughnessFactor;

    // New interval-based fields
    caf::PdmField<DiameterRoughnessModeEnum>                    m_diameterRoughnessMode;
    caf::PdmChildField<RimDiameterRoughnessIntervalCollection*> m_diameterRoughnessIntervals;

    caf::PdmField<PressureDropEnum>   m_pressureDrop;
    caf::PdmField<LengthAndDepthEnum> m_lengthAndDepth;

    caf::PdmField<bool>   m_enforceMaxSegmentLength;
    caf::PdmField<double> m_maxSegmentLength;

    caf::PdmChildField<RimCustomSegmentIntervalCollection*> m_customSegmentIntervals;
};