256 lines
8.3 KiB
C++
256 lines
8.3 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 COMPLETION_HPP_
|
|
#define COMPLETION_HPP_
|
|
|
|
#include <array>
|
|
#include <cstddef>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <opm/parser/eclipse/Parser/ParseContext.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Util/Value.hpp>
|
|
|
|
namespace Opm {
|
|
|
|
namespace RestartIO {
|
|
struct RstConnection;
|
|
}
|
|
|
|
class DeckKeyword;
|
|
class DeckRecord;
|
|
class EclipseGrid;
|
|
class FieldPropsManager;
|
|
|
|
class Connection {
|
|
public:
|
|
enum class State {
|
|
OPEN = 1,
|
|
SHUT = 2,
|
|
AUTO = 3 // Seems like the AUTO state can not be serialized to restart files.
|
|
};
|
|
|
|
static const std::string State2String( State enumValue );
|
|
static State StateFromString( const std::string& stringValue );
|
|
|
|
|
|
enum class Direction{
|
|
X = 1,
|
|
Y = 2,
|
|
Z = 3
|
|
};
|
|
|
|
static std::string Direction2String(const Direction enumValue);
|
|
static Direction DirectionFromString(const std::string& stringValue);
|
|
|
|
|
|
enum class Order {
|
|
DEPTH,
|
|
INPUT,
|
|
TRACK
|
|
};
|
|
|
|
static const std::string Order2String( Order enumValue );
|
|
static Order OrderFromString(const std::string& comporderStringValue);
|
|
|
|
enum class CTFKind {
|
|
DeckValue,
|
|
Defaulted,
|
|
};
|
|
|
|
|
|
Connection();
|
|
Connection(int i, int j , int k ,
|
|
std::size_t global_index,
|
|
int complnum,
|
|
double depth,
|
|
State state,
|
|
double CF,
|
|
double Kh,
|
|
double rw,
|
|
double r0,
|
|
double skin_factor,
|
|
const int satTableId,
|
|
const Direction direction,
|
|
const CTFKind ctf_kind,
|
|
const std::size_t sort_value,
|
|
const double segDistStart,
|
|
const double segDistEnd,
|
|
const bool defaultSatTabId);
|
|
|
|
Connection(const RestartIO::RstConnection& rst_connection, const EclipseGrid& grid, const FieldPropsManager& fp);
|
|
|
|
static Connection serializeObject();
|
|
|
|
bool attachedToSegment() const;
|
|
bool sameCoordinate(const int i, const int j, const int k) const;
|
|
int getI() const;
|
|
int getJ() const;
|
|
int getK() const;
|
|
std::size_t global_index() const;
|
|
State state() const;
|
|
Direction dir() const;
|
|
double depth() const;
|
|
int satTableId() const;
|
|
int complnum() const;
|
|
int segment() const;
|
|
double CF() const;
|
|
double Kh() const;
|
|
double rw() const;
|
|
double r0() const;
|
|
double skinFactor() const;
|
|
double wellPi() const;
|
|
CTFKind kind() const;
|
|
|
|
void setState(State state);
|
|
void setComplnum(int compnum);
|
|
void scaleWellPi(double wellPi);
|
|
void updateSegmentRST(int segment_number_arg,
|
|
double center_depth_arg);
|
|
void updateSegment(int segment_number_arg,
|
|
double center_depth_arg,
|
|
std::size_t compseg_insert_index,
|
|
double start,
|
|
double end);
|
|
std::size_t sort_value() const;
|
|
const bool& getDefaultSatTabId() const;
|
|
void setDefaultSatTabId(bool id);
|
|
const double& getSegDistStart() const;
|
|
const double& getSegDistEnd() const;
|
|
std::string str() const;
|
|
bool ctfAssignedFromInput() const
|
|
{
|
|
return this->m_ctfkind == CTFKind::DeckValue;
|
|
}
|
|
|
|
bool operator==( const Connection& ) const;
|
|
bool operator!=( const Connection& ) const;
|
|
|
|
template<class Serializer>
|
|
void serializeOp(Serializer& serializer)
|
|
{
|
|
serializer(direction);
|
|
serializer(center_depth);
|
|
serializer(open_state);
|
|
serializer(sat_tableId);
|
|
serializer(m_complnum);
|
|
serializer(m_CF);
|
|
serializer(m_Kh);
|
|
serializer(m_rw);
|
|
serializer(m_r0);
|
|
serializer(m_skin_factor);
|
|
serializer(ijk);
|
|
serializer(m_global_index);
|
|
serializer(m_ctfkind);
|
|
serializer(m_sort_value);
|
|
serializer(m_segDistStart);
|
|
serializer(m_segDistEnd);
|
|
serializer(m_defaultSatTabId);
|
|
serializer(segment_number);
|
|
serializer(wPi);
|
|
}
|
|
|
|
private:
|
|
Direction direction;
|
|
double center_depth;
|
|
State open_state;
|
|
int sat_tableId;
|
|
int m_complnum;
|
|
double m_CF;
|
|
double m_Kh;
|
|
double m_rw;
|
|
double m_r0;
|
|
double m_skin_factor;
|
|
|
|
std::array<int,3> ijk;
|
|
CTFKind m_ctfkind;
|
|
std::size_t m_global_index;
|
|
/*
|
|
The sort_value member is a peculiar quantity. The connections are
|
|
assembled in the WellConnections class. During the lifetime of the
|
|
connections there are three different sort orders which are all
|
|
relevant:
|
|
|
|
input: This is the ordering implied be the order of the
|
|
connections in the input deck.
|
|
|
|
simulation: This is the ordering the connections have in
|
|
WellConnections container during the simulation and RFT output.
|
|
|
|
restart: This is the ordering the connections have when they are
|
|
written out to a restart file.
|
|
|
|
Exactly what consitutes input, simulation and restart ordering, and
|
|
how the connections transition between the three during application
|
|
lifetime is different from MSW and normal wells.
|
|
|
|
normal wells: For normal wells the simulation order is given by the
|
|
COMPORD keyword, and then when the connections are serialized to the
|
|
restart file they are written in input order; i.e. we have:
|
|
|
|
input == restart and simulation given COMPORD
|
|
|
|
To recover the input order when creating the restart files the
|
|
sort_value member corresponds to the insert index for normal wells.
|
|
|
|
MSW wells: For MSW wells the wells simulator order[*] is given by
|
|
COMPSEGS keyword, the COMPORD keyword is ignored. The connections are
|
|
sorted in WellConnections::order() and then retain that order for all
|
|
eternity i.e.
|
|
|
|
input and simulation == restart
|
|
|
|
Now the important point is that the COMPSEGS detail used to perform
|
|
this sorting is not available when loading from a restart file, but
|
|
then the connections are already sorted correctly. I.e. *after* a
|
|
restart we will have:
|
|
|
|
input(from restart) == simulation == restart
|
|
|
|
The sort_value member is used to sort the connections into restart
|
|
ordering. In the case of normal wells this corresponds to recovering
|
|
the input order, whereas for MSW wells this is equivalent to the
|
|
simulation order.
|
|
|
|
[*]: For MSW wells the topology is given by the segments and entered
|
|
explicitly, so the truth is probably that the storage order
|
|
during simulation makes no difference?
|
|
*/
|
|
|
|
std::size_t m_sort_value;
|
|
double m_segDistStart;
|
|
double m_segDistEnd;
|
|
bool m_defaultSatTabId;
|
|
|
|
// related segment number
|
|
// 0 means the completion is not related to segment
|
|
int segment_number = 0;
|
|
double wPi = 1.0;
|
|
|
|
static std::string CTFKindToString(const CTFKind);
|
|
};
|
|
}
|
|
|
|
#endif /* COMPLETION_HPP_ */
|
|
|