OilfieldToolsNet/opm-core
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some documentation.

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen 2012-06-06 13:42:25 +02:00
parent 5588d1e3e9
commit 5702695879
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
opm/core/simulator/WellState.hpp
View File

@ -26,9 +26,11 @@
namespace Opm namespace Opm
{ {
/// The state of a set of wells.
class WellState class WellState
{ {
public: public:
/// Allocate and initialize if wells is non-null.
template <class State> template <class State>
void init(const Wells* wells, const State& state) void init(const Wells* wells, const State& state)
{ {
@ -44,9 +46,11 @@ namespace Opm
} }
} }
/// One bhp pressure per well.
std::vector<double>& bhp() { return bhp_; } std::vector<double>& bhp() { return bhp_; }
const std::vector<double>& bhp() const { return bhp_; } const std::vector<double>& bhp() const { return bhp_; }
/// One rate per well connection.
std::vector<double>& perfRates() { return perfrates_; } std::vector<double>& perfRates() { return perfrates_; }
const std::vector<double>& perfRates() const { return perfrates_; } const std::vector<double>& perfRates() const { return perfrates_; }