Added some documentation.

This commit is contained in:
Atgeirr Flø Rasmussen 2012-06-06 13:42:25 +02:00
parent 5588d1e3e9
commit 5702695879

View File

@ -26,9 +26,11 @@
namespace Opm
{
/// The state of a set of wells.
class WellState
{
public:
/// Allocate and initialize if wells is non-null.
template <class 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_; }
const std::vector<double>& bhp() const { return bhp_; }
/// One rate per well connection.
std::vector<double>& perfRates() { return perfrates_; }
const std::vector<double>& perfRates() const { return perfrates_; }