Files
ResInsight/ApplicationLibCode/ProjectDataModel/WellEvents/RimWellEventValve.h
T

113 lines
3.7 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// 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 "RimWellEventEnums.h"
#include "RimWellEvent.h"
#include "cafAppEnum.h"
#include "cafPdmField.h"
#include "cafPdmPtrField.h"
class RimValveTemplate;
//==================================================================================================
///
/// Valve event - defines when a valve opens or closes
///
//==================================================================================================
class RimWellEventValve : public RimWellEvent
{
CAF_PDM_HEADER_INIT;
public:
using State = RimWellEventEnums::State;
enum class ValveType
{
ICV,
ICD,
AICD
};
RimWellEventValve();
~RimWellEventValve() override;
// Getters
double measuredDepth() const;
ValveType valveType() const;
State state() const;
double flowCoefficient() const;
double area() const;
RimValveTemplate* valveTemplate() const;
double aicdStrength() const;
double aicdDensityCalibFluid() const;
double aicdViscosityCalibFluid() const;
double aicdVolFlowExp() const;
double aicdViscFuncExp() const;
// Setters
void setMeasuredDepth( double md );
void setValveType( ValveType type );
void setState( State state );
void setFlowCoefficient( double coefficient );
void setArea( double area );
void setValveTemplate( RimValveTemplate* valveTemplate );
void setAicdStrength( double value );
void setAicdDensityCalibFluid( double value );
void setAicdViscosityCalibFluid( double value );
void setAicdVolFlowExp( double value );
void setAicdViscFuncExp( double value );
// Override from RimWellEvent
EventType eventType() const override;
QString generateScheduleKeyword( const QString& wellName ) const override;
protected:
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;
QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;
private:
caf::PdmField<double> m_measuredDepth;
caf::PdmField<caf::AppEnum<ValveType>> m_valveType;
caf::PdmField<caf::AppEnum<State>> m_state;
caf::PdmField<double> m_flowCoefficient;
caf::PdmField<double> m_area;
caf::PdmPtrField<RimValveTemplate*> m_valveTemplate;
caf::PdmField<double> m_aicdStrength;
caf::PdmField<double> m_aicdDensityCalibFluid;
caf::PdmField<double> m_aicdViscosityCalibFluid;
caf::PdmField<double> m_aicdVolFlowExp;
caf::PdmField<double> m_aicdViscFuncExp;
};
namespace caf
{
template <>
void caf::AppEnum<RimWellEventValve::State>::setUp();
template <>
void caf::AppEnum<RimWellEventValve::ValveType>::setUp();
} // namespace caf