Improve function comment (similar to in SimulatorPolymer).

This commit is contained in:
Atgeirr Flø Rasmussen 2012-10-03 16:01:54 +02:00
parent 753a0c6949
commit dc3b0dd6f4

View File

@ -83,7 +83,8 @@ namespace Opm
/// This will run succesive timesteps until timer.done() is true. It will
/// modify the reservoir and well states.
/// \param[in,out] timer governs the requested reporting timesteps
/// \param[in,out] state state of reservoir: pressure, fluxes, polymer concentration
/// \param[in,out] state state of reservoir: pressure, fluxes, polymer concentration,
/// saturations, surface volumes.
/// \param[in,out] well_state state of wells: bhp, perforation rates
/// \return simulation report, with timing data
SimulatorReport run(SimulatorTimer& timer,