From 7671387f6f38c4f27e564fa07295d66cdaa00da5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= Date: Sun, 22 Apr 2012 21:24:43 +0200 Subject: [PATCH] Further refinement of add_well() documentation. --- opm/core/newwells.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/opm/core/newwells.h b/opm/core/newwells.h index 26b213bc5..3cce03384 100644 --- a/opm/core/newwells.h +++ b/opm/core/newwells.h @@ -150,12 +150,15 @@ create_wells(int nwells, int nperf); * control index is set to -1 (invalid). * * \param[in] type Type of well. - * \param[in] depth_ref Reference depth for bhp. + * \param[in] depth_ref Reference depth for well's BHP. * \param[in] nperf Number of perforations. * \param[in] zfrac Injection fraction (three components) or NULL. - * \param[in] cells Perforation cell indices. + * \param[in] cells Grid cells in which well is perforated. Should + * ideally be track ordered. * \param[in] WI Well production index per perforation, or NULL. - * \param[inout] W The Wells object to be modified. + * \param[in,out] W Existing set of wells to which new well will + * be added. + * * \return Non-zero (true) if successful and zero otherwise. */ int