mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-19 05:53:28 -06:00
542 lines
28 KiB
C++
542 lines
28 KiB
C++
/*
|
|
Copyright 2012 SINTEF ICT, Applied Mathematics.
|
|
|
|
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 OPM_WELLSGROUP_HPP
|
|
#define OPM_WELLSGROUP_HPP
|
|
|
|
#include <opm/core/wells/InjectionSpecification.hpp>
|
|
#include <opm/core/wells/ProductionSpecification.hpp>
|
|
#include <opm/core/grid.h>
|
|
#include <opm/core/props/BlackoilPhases.hpp>
|
|
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/Well.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/Group.hpp>
|
|
|
|
#include <string>
|
|
#include <memory>
|
|
|
|
namespace Opm
|
|
{
|
|
// Need to forward declare this one, some of the methods in the base
|
|
// class returns pointers to it.
|
|
class WellNode;
|
|
|
|
/// Basic information needed for group control (each group should typically
|
|
/// not exceed the sum of its leaf nodes)
|
|
struct WellPhasesSummed
|
|
{
|
|
WellPhasesSummed();
|
|
double res_inj_rates[3];
|
|
double res_prod_rates[3];
|
|
double surf_inj_rates[3];
|
|
double surf_prod_rates[3];
|
|
|
|
/// Sums each component
|
|
void operator+=(const WellPhasesSummed& other);
|
|
};
|
|
|
|
class WellsGroupInterface
|
|
{
|
|
public:
|
|
WellsGroupInterface(const std::string& name,
|
|
const double efficiency_factor,
|
|
const ProductionSpecification& prod_spec,
|
|
const InjectionSpecification& inj_spec,
|
|
const PhaseUsage& phase_usage);
|
|
virtual ~WellsGroupInterface();
|
|
|
|
/// The unique identifier for the well or well group.
|
|
const std::string& name() const;
|
|
|
|
/// Production specifications for the well or well group.
|
|
const ProductionSpecification& prodSpec() const;
|
|
|
|
/// Injection specifications for the well or well group.
|
|
const InjectionSpecification& injSpec() const;
|
|
|
|
/// Production specifications for the well or well group.
|
|
ProductionSpecification& prodSpec();
|
|
|
|
/// Injection specifications for the well or well group.
|
|
InjectionSpecification& injSpec();
|
|
|
|
/// Phase usage information.
|
|
const PhaseUsage& phaseUsage() const;
|
|
|
|
/// \returns true if the object is a leaf node (WellNode), false otherwise.
|
|
virtual bool isLeafNode() const;
|
|
|
|
/// \returns the pointer to the WellsGroupInterface with the given name. NULL if
|
|
/// the name is not found.a
|
|
virtual WellsGroupInterface* findGroup(const std::string& name_of_node) = 0;
|
|
|
|
/// Sets the parent
|
|
/// \param[in] parent the pointer to the parent
|
|
void setParent(WellsGroupInterface* parent);
|
|
|
|
/// Gets the parent of the group, NULL if no parent.
|
|
const WellsGroupInterface* getParent() const;
|
|
|
|
WellsGroupInterface* getParent();
|
|
|
|
/// Calculates the number of leaf nodes in the given group.
|
|
/// A leaf node is defined to have one leaf node in its group.
|
|
virtual int numberOfLeafNodes() = 0;
|
|
|
|
/// Checks if each condition is met, applies well controls where needed
|
|
/// (that is, it either changes the active control of violating wells, or shuts
|
|
/// down wells). Only one change is applied per invocation. Typical use will be
|
|
/// \code
|
|
/// solve_pressure();
|
|
/// while(!group.conditionsMet(...)) {
|
|
/// solve_pressure();
|
|
/// }
|
|
/// \endcode
|
|
///
|
|
/// \note It's highly recommended to use the conditionsMet found in WellsManager.
|
|
/// \param[in] well_bhp A vector containing the bhp for each well. Is assumed
|
|
/// to be ordered the same way as the related Wells-struct.
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[out] summed_phases Will at end of invocation contain the summed phase rates
|
|
/// (rate ,etc.) for the group.
|
|
/// \return true if no violations were found, false otherwise (false also implies a change).
|
|
virtual bool conditionsMet(const std::vector<double>& well_bhp,
|
|
const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
WellPhasesSummed& summed_phases) = 0;
|
|
|
|
/// Sets the current active control to the provided one for all injectors within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
// otherwise, all children will be set under group control
|
|
virtual void applyInjGroupControl(const InjectionSpecification::ControlMode control_mode,
|
|
const InjectionSpecification::InjectorType injector_type,
|
|
const double target,
|
|
const bool only_group) = 0;
|
|
/// Sets the current active control to the provided one for all producers within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
// otherwise, all children will be set under group control
|
|
virtual void applyProdGroupControl(const ProductionSpecification::ControlMode control_mode,
|
|
const double target,
|
|
const bool only_group) = 0;
|
|
|
|
/// Gets the worst offending well based on the input
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] mode
|
|
/// The relevant control mode to find the maximum over.
|
|
/// \return first will be a pointer to the worst offending well, second will be the obtained value at that well.
|
|
virtual std::pair<WellNode*, double> getWorstOffending(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
ProductionSpecification::ControlMode mode) = 0;
|
|
|
|
/// Gets the target rate for the given mode.
|
|
double getTarget(ProductionSpecification::ControlMode mode);
|
|
|
|
/// Gets the target rate for the given mode.
|
|
double getTarget(InjectionSpecification::ControlMode mode);
|
|
|
|
/// Applies any production group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyProdGroupControls() = 0;
|
|
|
|
/// Applies any injection group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyInjGroupControls() = 0;
|
|
|
|
/// Calculates the production guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double productionGuideRate(bool only_group) = 0;
|
|
|
|
/// Calculates the injection guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double injectionGuideRate(bool only_group) = 0;
|
|
|
|
/// Gets the total production flow of the given phase.
|
|
/// \param[in] phase_flows A vector containing rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] phase The phase for which to sum up.
|
|
virtual double getTotalProductionFlow(const std::vector<double>& phase_flows,
|
|
const BlackoilPhases::PhaseIndex phase) const = 0;
|
|
|
|
/// Applies explicit reinjection controls. This must be called at each timestep to be correct.
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
virtual void applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase) = 0;
|
|
|
|
/// TODO: prototyping a VREP enforcement function.
|
|
virtual void applyVREPGroupControls(const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs) = 0;
|
|
|
|
virtual void applyVREPGroupControl(const double target,
|
|
const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs,
|
|
const bool only_group) = 0;
|
|
|
|
virtual double getTotalVoidageRate(const std::vector<double>& well_voidage_rates) = 0;
|
|
|
|
/// Return whether the well is running under group control target
|
|
/// or under their own limit.
|
|
/// True under their own limit.
|
|
/// False running under group control target
|
|
bool individualControl() const;
|
|
|
|
/// Update the status for individual contrl
|
|
void setIndividualControl(const bool);
|
|
|
|
/// Whether it is a production well
|
|
/// Should only appy for WellNode
|
|
virtual bool isProducer() const = 0;
|
|
|
|
/// Whether it is an injection well
|
|
/// Should only appy for WellNode
|
|
virtual bool isInjector() const = 0;
|
|
|
|
virtual double getProductionRate(const std::vector<double>& well_rates,
|
|
const ProductionSpecification::ControlMode prod_mode) const = 0;
|
|
|
|
virtual void updateWellProductionTargets(const std::vector<double>& well_rates) = 0;
|
|
|
|
virtual void updateWellInjectionTargets(const std::vector<double>& well_rates) = 0;
|
|
|
|
virtual void setTargetUpdated(const bool flag) = 0;
|
|
|
|
double efficiencyFactor() const;
|
|
|
|
void setEfficiencyFactor(const double efficiency_factor);
|
|
|
|
protected:
|
|
/// Calculates the correct rate for the given ProductionSpecification::ControlMode
|
|
double rateByMode(const double* res_rates,
|
|
const double* surf_rates,
|
|
const ProductionSpecification::ControlMode mode);
|
|
|
|
/// Calculates the correct rate for the given InjectionSpecification::ControlMode
|
|
double rateByMode(const double* res_rates,
|
|
const double* surf_rates,
|
|
const InjectionSpecification::ControlMode mode);
|
|
|
|
WellsGroupInterface* parent_;
|
|
|
|
// Whether well is running under the group control target.
|
|
// Current only consider one level of control.
|
|
// So not putting it in the WellsGroupInterface yet.
|
|
bool individual_control_;
|
|
|
|
// Efficiency factor
|
|
double efficiency_factor_;
|
|
|
|
private:
|
|
std::string name_;
|
|
ProductionSpecification production_specification_;
|
|
InjectionSpecification injection_specification_;
|
|
PhaseUsage phase_usage_;
|
|
};
|
|
|
|
|
|
|
|
class WellsGroup : public WellsGroupInterface
|
|
{
|
|
public:
|
|
WellsGroup(const std::string& name,
|
|
const double efficiency_factor,
|
|
const ProductionSpecification& prod_spec,
|
|
const InjectionSpecification& inj_spec,
|
|
const PhaseUsage& phase_usage);
|
|
|
|
virtual WellsGroupInterface* findGroup(const std::string& name_of_node);
|
|
|
|
void addChild(std::shared_ptr<WellsGroupInterface> child);
|
|
|
|
virtual bool conditionsMet(const std::vector<double>& well_bhp,
|
|
const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
WellPhasesSummed& summed_phases);
|
|
|
|
virtual int numberOfLeafNodes();
|
|
virtual std::pair<WellNode*, double> getWorstOffending(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
ProductionSpecification::ControlMode mode);
|
|
|
|
/// Sets the current active control to the provided one for all injectors within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
// otherwise, all children will be set under group control
|
|
virtual void applyInjGroupControl(const InjectionSpecification::ControlMode control_mode,
|
|
const InjectionSpecification::InjectorType injector_type,
|
|
const double target,
|
|
bool only_group);
|
|
|
|
/// Sets the current active control to the provided one for all producers within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
// otherwise, all children will be set under group control
|
|
virtual void applyProdGroupControl(const ProductionSpecification::ControlMode control_mode,
|
|
const double target,
|
|
bool only_group);
|
|
|
|
/// Applies any production group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyProdGroupControls();
|
|
|
|
/// Applies any injection group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyInjGroupControls();
|
|
|
|
/// Calculates the production guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double productionGuideRate(bool only_group);
|
|
|
|
/// Calculates the injection guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double injectionGuideRate(bool only_group);
|
|
|
|
/// Gets the total production flow of the given phase.
|
|
/// \param[in] phase_flows A vector containing rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] phase The phase for which to sum up.
|
|
virtual double getTotalProductionFlow(const std::vector<double>& phase_flows,
|
|
const BlackoilPhases::PhaseIndex phase) const;
|
|
|
|
/// Applies explicit reinjection controls. This must be called at each timestep to be correct.
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
virtual void applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase);
|
|
|
|
/// TODO: prototyping a VREP enforcement function.
|
|
virtual void applyVREPGroupControls(const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs);
|
|
|
|
virtual void applyVREPGroupControl(const double target,
|
|
const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs,
|
|
const bool only_group);
|
|
|
|
virtual double getTotalVoidageRate(const std::vector<double>& well_voidage_rates);
|
|
|
|
virtual void updateWellProductionTargets(const std::vector<double>& well_rates);
|
|
|
|
virtual void updateWellInjectionTargets(const std::vector<double>& well_rates);
|
|
|
|
virtual void setTargetUpdated(const bool flag);
|
|
|
|
/// Whether it is a production well
|
|
/// Should only appy for WellNode
|
|
virtual bool isProducer() const;
|
|
|
|
/// Whether it is an injection well
|
|
/// Should only appy for WellNode
|
|
virtual bool isInjector() const;
|
|
|
|
virtual double getProductionRate(const std::vector<double>& well_rates,
|
|
const ProductionSpecification::ControlMode prod_mode) const;
|
|
|
|
private:
|
|
std::vector<std::shared_ptr<WellsGroupInterface> > children_;
|
|
};
|
|
|
|
|
|
|
|
class WellNode : public WellsGroupInterface
|
|
{
|
|
public:
|
|
WellNode(const std::string& name,
|
|
const double efficiency_factor,
|
|
const ProductionSpecification& prod_spec,
|
|
const InjectionSpecification& inj_spec,
|
|
const PhaseUsage& phase_usage);
|
|
|
|
virtual WellsGroupInterface* findGroup(const std::string& name_of_node);
|
|
virtual bool conditionsMet(const std::vector<double>& well_bhp,
|
|
const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
WellPhasesSummed& summed_phases);
|
|
|
|
virtual bool isLeafNode() const;
|
|
|
|
void setWellsPointer(Wells* wells, int self_index);
|
|
|
|
virtual int numberOfLeafNodes();
|
|
|
|
// Shuts the well (in the well struct)
|
|
void shutWell();
|
|
|
|
virtual std::pair<WellNode*, double> getWorstOffending(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase,
|
|
ProductionSpecification::ControlMode mode);
|
|
|
|
/// Sets the current active control to the provided one for all injectors within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
/// otherwise, all children will be set under group control
|
|
virtual void applyInjGroupControl(const InjectionSpecification::ControlMode control_mode,
|
|
const InjectionSpecification::InjectorType injector_type,
|
|
const double target,
|
|
bool only_group);
|
|
|
|
/// Sets the current active control to the provided one for all producers within the group.
|
|
/// After this call, the combined rate (which rate depending on control_mode) of the group
|
|
/// shall be equal to target.
|
|
/// \param[in] only_group if true, only children that are under group control will be changed.
|
|
/// otherwise, all children will be set under group control
|
|
virtual void applyProdGroupControl(const ProductionSpecification::ControlMode control_mode,
|
|
const double target,
|
|
bool only_group);
|
|
|
|
/// Applies any production group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyProdGroupControls();
|
|
|
|
/// Applies any injection group control relevant to all children nodes.
|
|
/// If no group control is set, this is called recursively to the children.
|
|
virtual void applyInjGroupControls();
|
|
|
|
/// Calculates the production guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double productionGuideRate(bool only_group);
|
|
|
|
/// Calculates the injection guide rate for the group.
|
|
/// \param[in] only_group If true, will only accumelate guide rates for
|
|
/// wells under group control
|
|
virtual double injectionGuideRate(bool only_group);
|
|
|
|
/// Gets the total production flow of the given phase.
|
|
/// \param[in] phase_flows A vector containing rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] phase The phase for which to sum up.
|
|
virtual double getTotalProductionFlow(const std::vector<double>& phase_flows,
|
|
const BlackoilPhases::PhaseIndex phase) const;
|
|
|
|
/// Returns the type of the well.
|
|
WellType type() const;
|
|
|
|
/// Applies explicit reinjection controls. This must be called at each timestep to be correct.
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
virtual void applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase);
|
|
|
|
/// TODO: prototyping a VREP enforcement function.
|
|
virtual void applyVREPGroupControls(const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs);
|
|
|
|
virtual void applyVREPGroupControl(const double target,
|
|
const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs,
|
|
const bool only_group);
|
|
|
|
virtual double getTotalVoidageRate(const std::vector<double>& well_voidage_rates);
|
|
|
|
int groupControlIndex() const;
|
|
|
|
virtual bool isProducer() const;
|
|
|
|
virtual bool isInjector() const;
|
|
|
|
virtual double getProductionRate(const std::vector<double>& well_rates,
|
|
const ProductionSpecification::ControlMode prod_mode) const;
|
|
|
|
virtual void updateWellProductionTargets(const std::vector<double>& well_rates);
|
|
|
|
virtual void updateWellInjectionTargets(const std::vector<double>& well_rates);
|
|
|
|
/// the efficiency factor for groups are muliplitive, this function return the resulted final efficiency factor
|
|
/// to the well in a multi-layer group structure.
|
|
double getAccumulativeEfficiencyFactor() const;
|
|
|
|
int selfIndex() const;
|
|
|
|
bool targetUpdated() const;
|
|
|
|
virtual void setTargetUpdated(const bool flag);
|
|
|
|
private:
|
|
Wells* wells_;
|
|
int self_index_;
|
|
int group_control_index_;
|
|
bool shut_well_;
|
|
// TODO: used when updating well targets
|
|
bool target_updated_;
|
|
};
|
|
|
|
/// Creates the WellsGroupInterface for the given well
|
|
/// \param[in] well the Well to construct object for
|
|
/// \param[in] timeStep the time step in question
|
|
/// \param[in] the phase usage
|
|
std::shared_ptr<WellsGroupInterface> createWellWellsGroup(const Well* well, size_t timeStep,
|
|
const PhaseUsage& phase_usage );
|
|
|
|
/// Creates the WellsGroupInterface for the given Group
|
|
/// \param[in] group the Group to construct object for
|
|
/// \param[in] timeStep the time step in question
|
|
/// \param[in] the phase usage
|
|
std::shared_ptr<WellsGroupInterface> createGroupWellsGroup(const Group& group, size_t timeStep,
|
|
const PhaseUsage& phase_usage );
|
|
}
|
|
|
|
#endif /* OPM_WELLSGROUP_HPP */
|
|
|