WgrupconWrapper.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 by Andreas Lauser
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18  */
19 #ifndef OPM_PARSER_WGRUPCON_WRAPPER_HPP
20 #define OPM_PARSER_WGRUPCON_WRAPPER_HPP
21 
23 
24 #include <vector>
25 #include <algorithm>
26 
27 namespace Opm {
29  public:
35  : m_keyword(keyword)
36  {
37  }
38 
42  int numGroups() const
43  { return m_keyword->size(); }
44 
49  std::string groupName(int groupIdx) const
50  { return m_keyword->getRecord(groupIdx)->getItem(0)->getString(0); }
51 
56  bool isUnconstraint(int groupIdx) const
57  { return m_keyword->getRecord(groupIdx)->getItem(1)->getString(0) == "YES"; }
58 
62  double guideRate(int groupIdx) const
63  { return m_keyword->getRecord(groupIdx)->getItem(2)->getSIDouble(0); }
64 
79  std::string controlPhase(int groupIdx) const
80  { return m_keyword->getRecord(groupIdx)->getItem(3)->getString(0); }
81 
85  double guideRateScalingFactor(int groupIdx) const
86  { return m_keyword->getRecord(groupIdx)->getItem(4)->getSIDouble(0); }
87 
88  private:
89  Opm::DeckKeywordConstPtr m_keyword;
90  };
91 }
92 
93 #endif // OPM_PARSER_WGRUPCON_WRAPPER_HPP
94 
int numGroups() const
Return the number of well groups to which this keyword applies.
Definition: WgrupconWrapper.hpp:42
Definition: Deck.hpp:29
double guideRate(int groupIdx) const
Return the guide rate for the group.
Definition: WgrupconWrapper.hpp:62
std::shared_ptr< const DeckKeyword > DeckKeywordConstPtr
Definition: DeckKeyword.hpp:71
WgrupconWrapper(Opm::DeckKeywordConstPtr keyword)
A wrapper class to provide convenient access to the data of the 'WGRUPCON' keyword.
Definition: WgrupconWrapper.hpp:34
std::string controlPhase(int groupIdx) const
Return the type of a well group.
Definition: WgrupconWrapper.hpp:79
Definition: WgrupconWrapper.hpp:28
bool isUnconstraint(int groupIdx) const
Return whether the group is available for higher level groups to control.
Definition: WgrupconWrapper.hpp:56
double guideRateScalingFactor(int groupIdx) const
Return the scaling factor for the guide rate of a group.
Definition: WgrupconWrapper.hpp:85
std::string groupName(int groupIdx) const
Return the human-readable name of a well group with a given index.
Definition: WgrupconWrapper.hpp:49