From 7125e3174834645219a04f9975a233a222208d5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= Date: Sat, 21 Apr 2012 21:07:19 +0200 Subject: [PATCH] Prefer to speak of "data structures" rather than "struct"s in documentation. --- opm/core/newwells.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/opm/core/newwells.h b/opm/core/newwells.h index e806782c3..29ad6b732 100644 --- a/opm/core/newwells.h +++ b/opm/core/newwells.h @@ -68,7 +68,7 @@ struct WellControls -/** Struct encapsulating static information about all wells in a scenario. */ +/** Data structure aggregating static information about all wells in a scenario. */ struct Wells { int number_of_wells; /** Number of wells. */ @@ -88,15 +88,15 @@ struct Wells * Size is number of perforations (== well_connpos[number_of_wells]). */ double *WI; /** Well productivity index, same size and structure as well_cells. */ - struct WellControls **ctrls; /** Well controls, one struct for each well. */ + struct WellControls **ctrls; /** Well controls, one set of controls for each well. */ void *data; /** Internal management structure. */ }; -/** Struct encapsulating dynamic information about all wells in a scenario. - * All arrays in this struct contain data for each perforation, +/** Data structure aggregating dynamic information about all wells in a scenario. + * All arrays in this structure contain data for each perforation, * ordered the same as Wells::well_cells and Wells:WI. The array * sizes are, respectively, * @@ -126,7 +126,7 @@ struct Wells * create_wells(int nwells_reserve_cap, int nperf_reserve_cap); -/** Append a well to a Wells struct. +/** Append a new well to an existing Wells object. * If successful, W->number_of_wells is incremented by 1. * The newly added well will have no controls associated with it, add * controls using append_well_controls(). The current control index is set