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

Document intended return code for append_well_controls().

Browse Source
This commit is contained in:
Bård Skaflestad 2012-04-22 16:58:37 +02:00
parent e444a3b77e
commit 65a7ec3ad9
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
opm/core/newwells.h
View File

@ -168,15 +168,17 @@ add_well(enum WellType type ,
struct Wells *W );
/** Append a control to a well.
* If successful, ctrl->num is incremented by 1.
* Note that this function does not change ctrl->current.
* To append a control to a well with index w, pass its
* controls to this function via wellsptr->ctrls[w].
/**
* Append operational constraint to an existing well.
*
* Increments ctrl->num by one if successful. Introducing a new
* operational constraint does not affect the well's notion of the
* currently active constraint represented by ctrl->current.
*
* \param[in] type Control type.
* \param[in] target Target value for the control.
* \param[inout] ctrl The WellControls object to be modified.
* \return 1 if successful, 0 if failed.
* \param[inout] ctrl Existing set of well controls.
* \return Non-zero (true) if successful and zero (false) otherwise.
*/
int
append_well_controls(enum WellControlType type ,