/*
Copyright 2011 SINTEF ICT, Applied Mathematics.
This file is part of The Open Reservoir Simulator Project (OpenRS).
OpenRS 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.
OpenRS 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 OpenRS. If not, see .
*/
#ifndef OPM_WELLCOLLECTION_HPP
#define OPM_WELLCOLLECTION_HPP
#include
#include
#include
#include
namespace Opm
{
class WellCollection
{
public:
/// Adds and creates if necessary the child to the collection
/// and appends it to parent's children. Also adds and creates the parent
/// if necessary.
/// \param[in] child name of child node
/// \param[in] parent name of parent node
/// \param[in] deck deck from which we will extract group control data
void addChild(const std::string& child,
const std::string& parent,
const EclipseGridParser& deck);
bool conditionsMet(const std::vector& well_bhp,
const std::vector& well_rate,
const double epsilon=1e-8);
/// Adds the well pointer to each leaf node (does not take ownership).
void setWellsPointer(Wells* wells);
const std::vector& getLeafNodes() const;
void calculateGuideRates();
WellsGroupInterface* findNode(std::string name);
const WellsGroupInterface* findNode(std::string name) const;
private:
// To account for the possibility of a forest
std::vector > roots_;
// This will be used to traverse the bottom nodes.
std::vector leaf_nodes_;
};
} // namespace Opm
#endif /* OPM_WELLCOLLECTION_HPP */