Files
ResInsight/ApplicationLibCode/ProjectDataModel/WellEvents/RimWellEventControl.h
T
Kristian Bendiksen a4dad97024 #13425 Add time-dependent well events and schedule data generation
Implement timeline-based event system for managing temporal changes in
well completions, perforations, valves, and production controls.

Features:
- Event timeline container with date-based querying
- Six event types: PERF, VALVE, TUBING, WSTATE, WTYPE, WCONTROL
- Schedule keyword generation (DATES, COMPDAT, WELSEGS, WCONPROD, WCONINJE)
- Multi-well schedule generation support
- Python GRPC API for event management
- YAML configuration file support
- Comprehensive test suite

Implementation:
- New directory: ApplicationLibCode/ProjectDataModel/WellEvents/
- Event classes inherit from RimWellEvent base class
- RimWellEventTimeline integrated into RimWellPath
- RicScheduleDataGenerator for multi-well schedule export
- Python API: event_timeline(), add_perf_event(), add_valve_event(), etc.
- Tests verify all event types and YAML config parsing

#13425 Add date tracking to valves and diameter/roughness intervals

Add creation date fields to RimWellPathValve and RimDiameterRoughnessInterval
to support filtering objects by date during completion data export.

- Add m_useCustomStartDate and m_startDate fields
- Add enableCustomStartDate(), setCustomStartDate(), isActiveOnDate() methods
- Set creation dates when applying valve and tubing events in RimWellEventTimeline

#13425 Add date-based filtering for schedule data export

Add optional export date parameter to MSW data collection functions to filter
valves and perforations based on their creation dates during schedule export.

- Add exportDate parameter to collectWsegvalvData, collectWsegAicdData,
  collectWsegSicdData, and collectCompsegData functions
- Filter valves by checking isActiveOnDate() on the associated RimWellPathValve
- Add RimPerforationInterval reference to RicMswPerforation for date filtering
- Pass export date from RicScheduleDataGenerator through the extraction chain

This ensures segment numbers reflect the full model while only including
objects active on the export date in output keywords.

Add test to prove compsegs changes over time.

#13425 Fix mypy type checking errors in well_events.py

- Add type annotations to all function parameters
- Fix generic type hints (dict -> Dict[str, Any])
- Import Any type for proper type safety
- Add type: ignore for method reassignment
- All 31 tests pass

#13425 Add schedule-level keyword events for non-well-specific keywords

Add a new event type called "Keyword Event" for schedule-level Eclipse
keywords (RPTRST, GRUPTREE, RPTSCHED, etc.) that are NOT tied to a
specific well path. This complements the existing RimWellEventKeyword
which operates at the well level.

- Add RimKeywordEvent class inheriting from RimWellEvent with null wellPath
- Add SCHEDULE_KEYWORD enum value to EventType
- Add addKeywordEvent() method to RimWellEventTimeline
- Add AddKeywordEvent Python API method to RimcWellEventTimeline
- Update RicScheduleDataGenerator to output global keywords after well sections
- Add Python wrapper add_keyword_event() with type inference
- Add tests and examples for RPTRST, GRUPTREE keywords
2026-02-12 08:15:22 +01:00

114 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 "RimWellEvent.h"
#include "cafAppEnum.h"
#include "cafPdmField.h"
//==================================================================================================
///
/// Well control event - defines production/injection control changes (WCONPROD/WCONINJE)
///
//==================================================================================================
class RimWellEventControl : public RimWellEvent
{
CAF_PDM_HEADER_INIT;
public:
enum class ControlMode
{
ORAT, // Oil rate control
WRAT, // Water rate control
GRAT, // Gas rate control
LRAT, // Liquid rate control
RESV, // Reservoir volume rate control
BHP, // Bottom hole pressure control
THP // Tubing head pressure control
};
enum class WellStatus
{
OPEN,
SHUT,
STOP
};
RimWellEventControl();
~RimWellEventControl() override;
// Getters
ControlMode controlMode() const;
WellStatus wellStatus() const;
double controlValue() const;
double bhpLimit() const;
double thpLimit() const;
double oilRate() const;
double waterRate() const;
double gasRate() const;
double liquidRate() const;
bool isProducer() const;
// Setters
void setControlMode( ControlMode mode );
void setWellStatus( WellStatus status );
void setControlValue( double value );
void setBhpLimit( double limit );
void setThpLimit( double limit );
void setOilRate( double rate );
void setWaterRate( double rate );
void setGasRate( double rate );
void setLiquidRate( double rate );
void setIsProducer( bool isProducer );
// Override from RimWellEvent
EventType eventType() const override;
QString generateScheduleKeyword( const QString& wellName ) const override;
// Generate specific keywords
QString generateWCONPROD( const QString& wellName ) const;
QString generateWCONINJE( const QString& wellName, const QString& injectorType ) const;
protected:
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;
private:
caf::PdmField<caf::AppEnum<ControlMode>> m_controlMode;
caf::PdmField<caf::AppEnum<WellStatus>> m_wellStatus;
caf::PdmField<double> m_controlValue;
caf::PdmField<double> m_bhpLimit;
caf::PdmField<double> m_thpLimit;
caf::PdmField<double> m_oilRate;
caf::PdmField<double> m_waterRate;
caf::PdmField<double> m_gasRate;
caf::PdmField<double> m_liquidRate;
caf::PdmField<bool> m_isProducer;
};
namespace caf
{
template <>
void caf::AppEnum<RimWellEventControl::ControlMode>::setUp();
template <>
void caf::AppEnum<RimWellEventControl::WellStatus>::setUp();
} // namespace caf