mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-01-16 07:51:56 -06:00
Improve function comment.
This commit is contained in:
parent
349c81fb1e
commit
2990b0a3e8
@ -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
|
||||
/// \param[in,out] state state of reservoir: pressure, fluxes, polymer concentration,
|
||||
/// saturations.
|
||||
/// \param[in,out] well_state state of wells: bhp, perforation rates
|
||||
/// \return simulation report, with timing data
|
||||
SimulatorReport run(SimulatorTimer& timer,
|
||||
|
Loading…
Reference in New Issue
Block a user