Correct doc error (zcorn is also output argument).

This commit is contained in:
Atgeirr Flø Rasmussen 2014-08-27 11:15:00 +02:00
parent 7ca1922c77
commit 0f02dba2d4

View File

@ -38,9 +38,9 @@ namespace Opm
/// \param[in] nz logical cartesian number of cells in K-direction /// \param[in] nz logical cartesian number of cells in K-direction
MinpvProcessor(const int nx, const int ny, const int nz); MinpvProcessor(const int nx, const int ny, const int nz);
/// Change zcorn so that it respects the minpv property. /// Change zcorn so that it respects the minpv property.
/// \param[in] pv pore volumes of all logical cartesian cells /// \param[in] pv pore volumes of all logical cartesian cells
/// \param[in] minpv minimum pore volume to accept a cell /// \param[in] minpv minimum pore volume to accept a cell
/// \param[in] zcorn ZCORN array to be manipulated /// \param[in, out] zcorn ZCORN array to be manipulated
/// After processing, all cells that have lower pore volume than minpv /// After processing, all cells that have lower pore volume than minpv
/// will have the zcorn numbers changed so they are zero-thickness. Any /// will have the zcorn numbers changed so they are zero-thickness. Any
/// cell below will be changed to include the deleted volume. /// cell below will be changed to include the deleted volume.