mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Added some documentation.
This commit is contained in:
@@ -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_; }
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user