OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some missing docs for parameters.

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen 2012-05-30 15:09:57 +02:00
parent 299ea28afe
commit c9c2794176
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
opm/core/pressure/IncompTpfa.hpp
View File

@ -50,6 +50,7 @@ namespace Opm
/// and N == g.number_of_cells. /// and N == g.number_of_cells.
/// \param[in] gravity Gravity vector. If nonzero, the array should /// \param[in] gravity Gravity vector. If nonzero, the array should
/// have D elements. /// have D elements.
/// \param[in] linsolver A linear solver.
/// \param[in] wells The wells argument. Will be used in solution, /// \param[in] wells The wells argument. Will be used in solution,
/// is ignored if NULL /// is ignored if NULL
IncompTpfa(const UnstructuredGrid& g, IncompTpfa(const UnstructuredGrid& g,
@ -70,6 +71,9 @@ namespace Opm
/// \param[in] src Must contain N source rates (one per cell). /// \param[in] src Must contain N source rates (one per cell).
/// Positive values represent total inflow rates, /// Positive values represent total inflow rates,
/// negative values represent total outflow rates. /// negative values represent total outflow rates.
/// \param[in] wdp Should contain the differences between
/// well BHP and perforation pressures.
/// May be empty if there are no wells.
/// \param[in] bcs If non-null, specifies boundary conditions. /// \param[in] bcs If non-null, specifies boundary conditions.
/// If null, noflow conditions are assumed. /// If null, noflow conditions are assumed.
/// \param[out] pressure Will contain N cell-pressure values. /// \param[out] pressure Will contain N cell-pressure values.
@ -98,6 +102,9 @@ namespace Opm
/// \param[in] src Must contain N source rates (one per cell). /// \param[in] src Must contain N source rates (one per cell).
/// Positive values represent total inflow rates, /// Positive values represent total inflow rates,
/// negative values represent total outflow rates. /// negative values represent total outflow rates.
/// \param[in] wdp Should contain the differences between
/// well BHP and perforation pressures.
/// May be empty if there are no wells.
/// \param[in] bcs If non-null, specifies boundary conditions. /// \param[in] bcs If non-null, specifies boundary conditions.
/// If null, noflow conditions are assumed. /// If null, noflow conditions are assumed.
/// \param[in] porevol Must contain N pore volumes. /// \param[in] porevol Must contain N pore volumes.