6a0afc8a80
dynamicstate.get returns a const reference rather than a by-value copy, in order to be consistent with other container classes. This introduces a problem for std::vector<bool> with its specialisation, so all DynamicState<bool> instances has been replaced by DynamicState<int> and explicit bool conversions.
182 lines
8.1 KiB
C++
182 lines
8.1 KiB
C++
/*
|
|
Copyright 2013 Statoil ASA.
|
|
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM 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.
|
|
|
|
OPM 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 for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
|
|
#ifndef WELL_HPP_
|
|
#define WELL_HPP_
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/WellInjectionProperties.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/WellPolymerProperties.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/WellProductionProperties.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/WellEconProductionLimits.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Util/Value.hpp>
|
|
#include <opm/parser/eclipse/Parser/MessageContainer.hpp>
|
|
|
|
namespace Opm {
|
|
|
|
template< typename > class DynamicState;
|
|
|
|
class Completion;
|
|
class CompletionSet;
|
|
class Segment;
|
|
class SegmentSet;
|
|
class TimeMap;
|
|
|
|
class Well {
|
|
public:
|
|
Well(const std::string& name, int headI,
|
|
int headJ, Value<double> refDepth , Phase::PhaseEnum preferredPhase,
|
|
std::shared_ptr< const TimeMap > timeMap, size_t creationTimeStep,
|
|
WellCompletion::CompletionOrderEnum completionOrdering = WellCompletion::TRACK,
|
|
bool allowCrossFlow = true, bool automaticShutIn = true);
|
|
const std::string& name() const;
|
|
|
|
bool hasBeenDefined(size_t timeStep) const;
|
|
const std::string getGroupName(size_t timeStep) const;
|
|
void setGroupName(size_t timeStep , const std::string& groupName);
|
|
|
|
WellCommon::StatusEnum getStatus(size_t timeStep) const;
|
|
bool setStatus(size_t timeStep, WellCommon::StatusEnum Status);
|
|
|
|
int getHeadI() const;
|
|
int getHeadJ() const;
|
|
double getRefDepth() const;
|
|
Phase::PhaseEnum getPreferredPhase() const;
|
|
|
|
bool isAvailableForGroupControl(size_t timeStep) const;
|
|
void setAvailableForGroupControl(size_t timeStep, bool isAvailableForGroupControl);
|
|
double getGuideRate(size_t timeStep) const;
|
|
void setGuideRate(size_t timeStep, double guideRate);
|
|
GuideRate::GuideRatePhaseEnum getGuideRatePhase(size_t timeStep) const;
|
|
void setGuideRatePhase(size_t timeStep, GuideRate::GuideRatePhaseEnum phase);
|
|
double getGuideRateScalingFactor(size_t timeStep) const;
|
|
void setGuideRateScalingFactor(size_t timeStep, double scalingFactor);
|
|
|
|
void switchToInjector( size_t timeStep);
|
|
void switchToProducer( size_t timeStep);
|
|
|
|
bool isProducer(size_t timeStep) const;
|
|
bool isInjector(size_t timeStep) const;
|
|
void addWELSPECS(const DeckRecord& deckRecord);
|
|
void addCompletions(size_t time_step , const std::vector<std::shared_ptr< Completion >>& newCompletions);
|
|
void addCompletionSet(size_t time_step, const std::shared_ptr< const CompletionSet > newCompletionSet);
|
|
std::shared_ptr< const CompletionSet > getCompletions(size_t timeStep) const;
|
|
|
|
/* The rate of a given phase under the following assumptions:
|
|
* * Returns zero if production is requested for an injector (and vice
|
|
* versa)
|
|
* * If this is an injector and something else than the
|
|
* requested phase is injected, returns 0, i.e.
|
|
* water_injector.injection_rate( gas ) == 0
|
|
* * Mixed injection is not supported and always returns 0.
|
|
*/
|
|
double production_rate( Phase::PhaseEnum phase, size_t timestep ) const;
|
|
double injection_rate( Phase::PhaseEnum phase, size_t timestep ) const;
|
|
|
|
bool setProductionProperties(size_t timeStep , const WellProductionProperties properties);
|
|
WellProductionProperties getProductionPropertiesCopy(size_t timeStep) const;
|
|
const WellProductionProperties& getProductionProperties(size_t timeStep) const;
|
|
|
|
bool setInjectionProperties(size_t timeStep , const WellInjectionProperties properties);
|
|
WellInjectionProperties getInjectionPropertiesCopy(size_t timeStep) const;
|
|
const WellInjectionProperties& getInjectionProperties(size_t timeStep) const;
|
|
|
|
bool setPolymerProperties(size_t timeStep , const WellPolymerProperties properties);
|
|
WellPolymerProperties getPolymerPropertiesCopy(size_t timeStep) const;
|
|
const WellPolymerProperties& getPolymerProperties(size_t timeStep) const;
|
|
|
|
bool setSolventFraction(size_t timeStep , const double fraction);
|
|
const double& getSolventFraction(size_t timeStep) const;
|
|
|
|
bool setEconProductionLimits(const size_t timeStep, const WellEconProductionLimits& productionlimits);
|
|
const WellEconProductionLimits& getEconProductionLimits(const size_t timeStep) const;
|
|
|
|
int firstRFTOutput( ) const;
|
|
bool getRFTActive(size_t time_step) const;
|
|
void setRFTActive(size_t time_step, bool value);
|
|
bool getPLTActive(size_t time_step) const;
|
|
void setPLTActive(size_t time_step, bool value);
|
|
int findWellFirstOpen(int startTimeStep) const;
|
|
void setRFTForWellWhenFirstOpen(int numSteps,size_t currentStep);
|
|
|
|
static bool wellNameInWellNamePattern(const std::string& wellName, const std::string& wellNamePattern);
|
|
|
|
WellCompletion::CompletionOrderEnum getWellCompletionOrdering() const;
|
|
|
|
bool getAllowCrossFlow() const;
|
|
bool getAutomaticShutIn() const;
|
|
bool canOpen(size_t time_step) const;
|
|
|
|
|
|
// for multi-segment wells
|
|
bool isMultiSegment(size_t time_step) const;
|
|
std::shared_ptr< const SegmentSet > getSegmentSet(size_t time_step) const;
|
|
|
|
void addSegmentSet(size_t time_step, std::shared_ptr< const SegmentSet > new_segmentset);
|
|
|
|
const MessageContainer& getMessageContainer() const;
|
|
private:
|
|
void setRefDepthFromCompletions() const;
|
|
size_t m_creationTimeStep;
|
|
std::string m_name;
|
|
|
|
std::shared_ptr<DynamicState<WellCommon::StatusEnum> > m_status;
|
|
|
|
std::shared_ptr<DynamicState<int> > m_isAvailableForGroupControl;
|
|
std::shared_ptr<DynamicState<double> > m_guideRate;
|
|
std::shared_ptr<DynamicState<GuideRate::GuideRatePhaseEnum> > m_guideRatePhase;
|
|
std::shared_ptr<DynamicState<double> > m_guideRateScalingFactor;
|
|
|
|
std::shared_ptr<DynamicState<int> > m_isProducer;
|
|
std::shared_ptr<DynamicState<std::shared_ptr< const CompletionSet >> > m_completions;
|
|
std::shared_ptr<DynamicState<WellProductionProperties> > m_productionProperties;
|
|
std::shared_ptr<DynamicState<WellInjectionProperties> > m_injectionProperties;
|
|
std::shared_ptr<DynamicState<WellPolymerProperties> > m_polymerProperties;
|
|
std::shared_ptr<DynamicState<WellEconProductionLimits> > m_econproductionlimits;
|
|
std::shared_ptr<DynamicState<double> > m_solventFraction;
|
|
std::shared_ptr<DynamicState<std::string> > m_groupName;
|
|
std::shared_ptr<DynamicState<int> > m_rft;
|
|
std::shared_ptr<DynamicState<int> > m_plt;
|
|
|
|
// WELSPECS data - assumes this is not dynamic
|
|
|
|
std::shared_ptr< const TimeMap > m_timeMap;
|
|
int m_headI;
|
|
int m_headJ;
|
|
mutable Value<double> m_refDepth;
|
|
Phase::PhaseEnum m_preferredPhase;
|
|
|
|
WellCompletion::CompletionOrderEnum m_comporder;
|
|
bool m_allowCrossFlow;
|
|
bool m_automaticShutIn;
|
|
MessageContainer m_messages;
|
|
// WELSEGS DATA - for mutli-segment wells
|
|
// flag indicating if the well is a multi-segment well
|
|
std::shared_ptr<DynamicState<std::shared_ptr< const SegmentSet >>> m_segmentset;
|
|
};
|
|
}
|
|
|
|
|
|
|
|
#endif /* WELL_HPP_ */
|