From 6e8df003f1422267e82d881452a199218b1f354d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= <Bard.Skaflestad@sintef.no>
Date: Mon, 25 Jun 2012 00:55:50 +0200
Subject: [PATCH] Document the obsolescent well representation.

It is still in use by the hybridised pressure solvers.
---
 opm/core/well.h | 89 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 78 insertions(+), 11 deletions(-)

diff --git a/opm/core/well.h b/opm/core/well.h
index bdee861a..008817c1 100644
--- a/opm/core/well.h
+++ b/opm/core/well.h
@@ -20,44 +20,111 @@
 #ifndef OPM_WELL_HEADER_INCLUDED
 #define OPM_WELL_HEADER_INCLUDED
 
+/**
+ * \file
+ * Deprecated (and obsolescent) well definition.  Still in use by
+ * the hybridized pressure solvers.
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 
+/**
+ * Well taxonomy.
+ */
 enum well_type    { INJECTOR, PRODUCER };
+
+/**
+ * Control types recognised in system.
+ */
 enum well_control { BHP     , RATE     };
+
+/**
+ * Compositions recognised in injection wells.
+ */
 enum surface_component { WATER = 0, OIL = 1, GAS = 2 };
 
+/**
+ * Basic representation of well topology.
+ */
 struct WellCompletions {
-    int  number_of_wells;
-    int *well_connpos;
-    int *well_cells;
+    int  number_of_wells; /**< Number of wells. */
+    int *well_connpos;    /**< Well topology start pointers. */
+    int *well_cells;      /**< Well connections */
 };
 
+/**
+ * Basic representation of well controls.
+ */
 struct WellControls {
-    enum well_type    *type;
-    enum well_control *ctrl;
-    double            *target;
-    double            *zfrac;   /* Surface volume fraction (3*nwells) */
+    enum well_type    *type;    /**< Individual well taxonomy */
+    enum well_control *ctrl;    /**< Individual well controls */
+    double            *target;  /**< Control target */
+    double            *zfrac;   /**< Surface injection composition */
 };
 
+/**
+ * Dynamic discretisation data relating well to flow in reservoir.
+ */
 struct completion_data {
-    double *WI;                 /* Productivity index */
-    double *gpot;               /* Gravity potential */
-    double *A;                  /* RB^{-1} */
-    double *phasemob;           /* Phase mobility */
+    double *WI;       /**< Well indices */
+    double *gpot;     /**< Gravity potential */
+    double *A;        /**< \f$RB^{-1}\f$ for compressible flows. */
+    double *phasemob; /**< Phase mobility, per connection. */
 };
 
+/**
+ * Convenience type alias to preserve backwards compatibility in
+ * well topology definitions used by hybridised pressure solver.
+ */
 typedef struct WellCompletions well_t;
+
+/**
+ * Convenience type alias to preserve backwards compatiblity in
+ * well control definitions used by hybridised pressure solver.
+ */
 typedef struct WellControls    well_control_t;
 
+/**
+ * Allocate cell-to-well mapping (as a sparse array).
+ *
+ * @param[in]  nc      Total number of cells.
+ * @param[in]  W       Well topology (well-to-cell mapping).
+ * @param[out] cwpos   Indirection array.  Points to array of size
+ *                     <CODE>nc + 1</CODE> if successful.
+ * @param[out] cwells  Cell-to-well mapping.  Points to array
+ *                     of size <CODE>W->well_connpos[
+ *                     W->number_of_wells]</CODE> if successful.
+ * @return Positive number (size of <CODE>*cwells</CODE>)
+ * if successful. Zero in case of allocation failure.
+ */
 int
 allocate_cell_wells(int nc, well_t *W, int **cwpos, int **cwells);
 
+/**
+ * Dispose of memory resources allocated using function
+ * allocate_cell_wells().
+ *
+ * Following a call to deallocate_cell_wells(), the input pointers
+ * are no longer valid.
+ *
+ * @param[in,out] cvpos  Cell-to-well start pointers.
+ * @param[in,out] cwells Cell-to-well mapping.
+ */
 void
 deallocate_cell_wells(int *cvpos, int *cwells);
 
+/**
+ * Construct cell-to-well mapping (i.e., transpose the
+ * well-to-cell mapping represented by <CODE>W->well_cells</CODE>).
+ *
+ * @param[in]  nc      Total number of cells.
+ * @param[in]  W       Well topology (well-to-cell mapping).
+ * @param[out] cwpos   Cell-to-well start pointers.
+ * @param[out] cwells  Cell-to-well mapping.
+ */
 void
 derive_cell_wells(int nc, well_t *W, int *cwpos, int *cwells);