mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Add Doxygen Documentation to Well PI Calculator
Suggested by [at]atgeirr.
This commit is contained in:
parent
b6e0bd1b7b
commit
7bf4b76dac
@ -28,27 +28,76 @@ namespace Opm {
|
|||||||
} // namespace Opm
|
} // namespace Opm
|
||||||
|
|
||||||
namespace Opm {
|
namespace Opm {
|
||||||
|
|
||||||
|
/// Collect per-connection static information to enable calculating
|
||||||
|
/// connection-level or well-level productivity index values when
|
||||||
|
/// incorporating dynamic phase mobilities.
|
||||||
class WellProdIndexCalculator
|
class WellProdIndexCalculator
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
/// Constructor
|
||||||
|
///
|
||||||
|
/// \param[in] well Individual well for which to collect
|
||||||
|
/// per-connection static data.
|
||||||
explicit WellProdIndexCalculator(const Well& well);
|
explicit WellProdIndexCalculator(const Well& well);
|
||||||
|
|
||||||
|
/// Compute connection-level steady-state productivity index value
|
||||||
|
/// using dynamic phase mobility.
|
||||||
|
///
|
||||||
|
/// \param[in] connIdx Linear connection index. Must be in the
|
||||||
|
/// range 0..numConnections() - 1.
|
||||||
|
///
|
||||||
|
/// \param[in] connMobility Phase mobility at connection \p connIdx.
|
||||||
|
/// Typically derived from dynamic flow state conditions in cell
|
||||||
|
/// intersected by well's connection \p connIdx.
|
||||||
|
///
|
||||||
|
/// \return Connection-level steady-state productivity index.
|
||||||
double connectionProdIndStandard(const std::size_t connIdx,
|
double connectionProdIndStandard(const std::size_t connIdx,
|
||||||
const double connMobility) const;
|
const double connMobility) const;
|
||||||
|
|
||||||
|
/// Number of connections in this well.
|
||||||
|
///
|
||||||
|
/// Used primarily for consistency checks.
|
||||||
std::size_t numConnections() const
|
std::size_t numConnections() const
|
||||||
{
|
{
|
||||||
return this->standardConnFactors_.size();
|
return this->standardConnFactors_.size();
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
/// Static, per-connection multiplicative PI factors.
|
||||||
|
///
|
||||||
|
/// Corresponds to the well's connection transmissibility factors,
|
||||||
|
/// multiplied by a ratio of logarithms if the well has an explicit,
|
||||||
|
/// positive drainage radius.
|
||||||
std::vector<double> standardConnFactors_{};
|
std::vector<double> standardConnFactors_{};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// Compute connection-level productivity index values for all
|
||||||
|
/// connections in a well.
|
||||||
|
///
|
||||||
|
/// \param[in] wellPICalc Productivity index calculator.
|
||||||
|
///
|
||||||
|
/// \param[in] connMobility Phase mobility for each connection.
|
||||||
|
/// Typically derived from dynamic flow state conditions in cells
|
||||||
|
/// intersected by well's connections. Must have one value for each
|
||||||
|
/// \code wellPICalc.numConnections() \endcode well connection.
|
||||||
|
///
|
||||||
|
/// \return Connection-level steady-state productivity index values for
|
||||||
|
/// all connections.
|
||||||
std::vector<double>
|
std::vector<double>
|
||||||
connectionProdIndStandard(const WellProdIndexCalculator& wellPICalc,
|
connectionProdIndStandard(const WellProdIndexCalculator& wellPICalc,
|
||||||
const std::vector<double>& connMobility);
|
const std::vector<double>& connMobility);
|
||||||
|
|
||||||
|
/// Compute well-level productivity index value.
|
||||||
|
///
|
||||||
|
/// \param[in] wellPICalc Productivity index calculator.
|
||||||
|
///
|
||||||
|
/// \param[in] connMobility Phase mobility for each connection.
|
||||||
|
/// Typically derived from dynamic flow state conditions in cells
|
||||||
|
/// intersected by well's connections. Must have one value for each
|
||||||
|
/// \code wellPICalc.numConnections() \endcode well connection.
|
||||||
|
///
|
||||||
|
/// \return Well-level steady-state productivity index value.
|
||||||
double wellProdIndStandard(const WellProdIndexCalculator& wellPICalc,
|
double wellProdIndStandard(const WellProdIndexCalculator& wellPICalc,
|
||||||
const std::vector<double>& connMobility);
|
const std::vector<double>& connMobility);
|
||||||
} // namespace Opm
|
} // namespace Opm
|
||||||
|
Loading…
Reference in New Issue
Block a user