OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-12-19 05:53:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added some documentation

Browse Source
This commit is contained in:
Kjetil Olsen Lye 2012-04-25 16:40:31 +02:00
parent 7d25e9c6a0
commit 06d83e669b
3 changed files with 83 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
opm/core/WellCollection.hpp
View File

@ -43,6 +43,24 @@ namespace Opm
const std::string& parent,
const EclipseGridParser& deck);
/// Checks if each condition is met, applies well controls where needed
/// (that is, it either changes the active control of violating wells, or shuts
/// down wells). Only one change is applied per invocation. Typical use will be
/// \code
/// solve_pressure();
/// while(!collection.conditionsMet(well_bhp, well_rate, summed_phases)) {
/// solve_pressure();
/// }
/// \endcode
///
/// \note It's highly recommended to use the conditionsMet found in WellsManager.
/// \param[in] well_bhp A vector containing the bhp for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \param[in] well_rate A vector containing the rate for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \param[in] epsilon The error tolerated for each inequality. Formally, it will accept
/// (a - b <= epsilon) as (a <= b).
/// \return true if no violations were found, false otherwise (false also implies a change).
bool conditionsMet(const std::vector<double>& well_bhp,
const std::vector<double>& well_rate,
const double epsilon=1e-8);
@ -50,11 +68,22 @@ namespace Opm
/// Adds the well pointer to each leaf node (does not take ownership).
void setWellsPointer(Wells* wells);
/// \return A set of pointers to every well in the collection
const std::vector<WellNode*>& getLeafNodes() const;
/// This will, for each group \f$G\f$ for each well \f$w\in G\f$ calculate
/// the new guide rate \f$\tilde{g}_w\f$ for each well as
/// \f[ \tilde{g}_w := \frac{g_w}{\sum_{w'\in G} g_{w'}}\f]
void calculateGuideRates();
/// Finds the group with the given name.
/// \param[in] the name of the group
/// \return the pointer to the group if found, NULL otherwise
WellsGroupInterface* findNode(std::string name);
/// Finds the group with the given name.
/// \param[in] the name of the group
/// \return the pointer to the group if found, NULL otherwise
const WellsGroupInterface* findNode(std::string name) const;
private:

39
opm/core/WellsGroup.hpp
View File

@ -10,12 +10,18 @@
namespace Opm
{
// Need to forward declare this one, some of the methods in the base
// class returns pointers to it.
class WellNode;
/// Basic information needed for group control (each group should typically
/// not exceed the sum of its leaf nodes)
struct WellPhasesSummed {
WellPhasesSummed();
double bhp_sum;
double rate_sum;
/// Sums each component
void operator+=(const WellPhasesSummed& other);
};
@ -50,7 +56,11 @@ namespace Opm
/// the name is not found.a
virtual WellsGroupInterface* findGroup(std::string name_of_node) = 0;
/// Sets the parent
/// \param[in] parent the pointer to the parent
void setParent(WellsGroupInterface* parent);
/// Gets the parent of the group, NULL if no parent.
const WellsGroupInterface* getParent() const;
/// Recursively calculate the guide rate for each member of the well group.
@ -61,14 +71,40 @@ namespace Opm
/// A leaf node is defined to have one leaf node in its group.
virtual int numberOfLeafNodes() = 0;
/// Fills the WellControlResult parameter with all exceed information
/// Checks if each condition is met, applies well controls where needed
/// (that is, it either changes the active control of violating wells, or shuts
/// down wells). Only one change is applied per invocation. Typical use will be
/// \code
/// solve_pressure();
/// while(!group.conditionsMet(well_bhp, well_rate, summed_phases)) {
/// solve_pressure();
/// }
/// \endcode
///
/// \note It's highly recommended to use the conditionsMet found in WellsManager.
/// \param[in] well_bhp A vector containing the bhp for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \param[in] well_rate A vector containing the rate for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \param[out] summed_phases Will at end of invocation contain the summed phases
/// (bhp, rate ,etc.) for the group.
/// \param[in] epsilon The error tolerated for each inequality. Formally, it will accept
/// (a - b <= epsilon) as (a <= b).
/// \return true if no violations were found, false otherwise (false also implies a change).
virtual bool conditionsMet(const std::vector<double>& well_bhp,
const std::vector<double>& well_rate,
WellPhasesSummed& summed_phases,
const double epsilon = 1e-8) = 0;
/// Sets the current active control to the provided one for all wells within the group
/// \note Also changes the target based on type.
/// \param[in] type the type to change to which the control is changed.
virtual void applyControl(const WellControlType type) = 0;
/// Gets the worst offending well based on the input
/// \param values A vector of a values for each well. This is assumed to be ordered the same way as the
/// relevant Wells struct.
/// \return first will be a pointer to the worst offending well, second will be the obtained value at that well.
virtual std::pair<WellNode*, double> getWorstOffending(const std::vector<double>& values) = 0;
protected:
@ -131,6 +167,7 @@ namespace Opm
virtual void calculateGuideRates();
virtual int numberOfLeafNodes();
// Shuts the well (in the well struct)
void shutWell();
virtual std::pair<WellNode*, double> getWorstOffending(const std::vector<double>& values);

15
opm/core/WellsManager.hpp
View File

@ -60,6 +60,21 @@ namespace Opm
/// Access the well group hierarchy.
const WellCollection& wellCollection() const;
/// Checks if each condition is met, applies well controls where needed
/// (that is, it either changes the active control of violating wells, or shuts
/// down wells). Only one change is applied per invocation. Typical use will be
/// \code
/// solve_pressure();
/// while(!wells.conditionsMet(well_bhp, well_rate)) {
/// solve_pressure();
/// }
/// \endcode
///
/// \param[in] well_bhp A vector containing the bhp for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \param[in] well_rate A vector containing the rate for each well. Is assumed
/// to be ordered the same way as the related Wells-struct.
/// \return true if no violations were found, false otherwise (false also implies a change).
bool conditionsMet(const std::vector<double>& well_bhp,
const std::vector<double>& well_rate);