mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Expand description of function create_wells().
Restore original parameter names in the process.
This commit is contained in:
@@ -115,15 +115,30 @@ struct CompletionData
|
|||||||
double *phasemob; /** Phase mobilities. */
|
double *phasemob; /** Phase mobilities. */
|
||||||
};
|
};
|
||||||
|
|
||||||
/** Contruction function initializing a Wells object.
|
/**
|
||||||
* The arguments may be used to indicate expected capacity needed,
|
* Construct a Wells object initially capable of managing a given
|
||||||
* they will be used internally for pre-allocation.
|
* number of wells and total number of well connections
|
||||||
* \return NULL upon failure, otherwise a valid Wells object with 0 wells.
|
* (perforations).
|
||||||
* Call add_well() to populate the Wells object.
|
*
|
||||||
* Call destroy_wells() to deallocate and clean up the Wells object.
|
* Function add_well() is used to populate the Wells object. No
|
||||||
|
* reallocation occurrs in function add_well() as long as the
|
||||||
|
* initially indicated capacites are sufficient. Call function
|
||||||
|
* destroy_wells() to dispose of the Wells object and its allocated
|
||||||
|
* memory resources.
|
||||||
|
*
|
||||||
|
* \param[in] nwells Expected number of wells in simulation scenario.
|
||||||
|
* Pass zero if the total number of wells is unknown.
|
||||||
|
*
|
||||||
|
* \param[in] nperf Expected total number of well connections
|
||||||
|
* (perforations) for all wells in simulation
|
||||||
|
* scenario. Pass zero if the total number of well
|
||||||
|
* connections is unknown.
|
||||||
|
*
|
||||||
|
* \return A valid Wells object with no wells if successful, and NULL
|
||||||
|
* otherwise.
|
||||||
*/
|
*/
|
||||||
struct Wells *
|
struct Wells *
|
||||||
create_wells(int nwells_reserve_cap, int nperf_reserve_cap);
|
create_wells(int nwells, int nperf);
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -322,7 +322,7 @@ wells_reserve(int nwells, int nperf, struct Wells *W)
|
|||||||
|
|
||||||
/* ---------------------------------------------------------------------- */
|
/* ---------------------------------------------------------------------- */
|
||||||
struct Wells *
|
struct Wells *
|
||||||
create_wells(int nwells_reserve_cap, int nperf_reserve_cap)
|
create_wells(int nwells, int nperf)
|
||||||
/* ---------------------------------------------------------------------- */
|
/* ---------------------------------------------------------------------- */
|
||||||
{
|
{
|
||||||
int ok;
|
int ok;
|
||||||
@@ -349,8 +349,8 @@ create_wells(int nwells_reserve_cap, int nperf_reserve_cap)
|
|||||||
if (ok) {
|
if (ok) {
|
||||||
W->well_connpos[0] = 0;
|
W->well_connpos[0] = 0;
|
||||||
|
|
||||||
if ((nwells_reserve_cap > 0) || (nperf_reserve_cap > 0)) {
|
if ((nwells > 0) || (nperf > 0)) {
|
||||||
ok = wells_reserve(nwells_reserve_cap, nperf_reserve_cap, W);
|
ok = wells_reserve(nwells, nperf, W);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user