Clean up well docs.
Needed to rename structs in legacy_well.h to avoid clash in docs.
This commit is contained in:
parent
8c1dc782dd
commit
f84eb97f4f
@ -49,7 +49,7 @@ enum surface_component { WATER = 0, OIL = 1, GAS = 2 };
|
|||||||
/**
|
/**
|
||||||
* Basic representation of well topology.
|
* Basic representation of well topology.
|
||||||
*/
|
*/
|
||||||
struct WellCompletions {
|
struct LegacyWellCompletions {
|
||||||
int number_of_wells; /**< Number of wells. */
|
int number_of_wells; /**< Number of wells. */
|
||||||
int *well_connpos; /**< Well topology start pointers. */
|
int *well_connpos; /**< Well topology start pointers. */
|
||||||
int *well_cells; /**< Well connections */
|
int *well_cells; /**< Well connections */
|
||||||
@ -58,7 +58,7 @@ struct WellCompletions {
|
|||||||
/**
|
/**
|
||||||
* Basic representation of well controls.
|
* Basic representation of well controls.
|
||||||
*/
|
*/
|
||||||
struct WellControls {
|
struct LegacyWellControls {
|
||||||
enum well_type *type; /**< Individual well taxonomy */
|
enum well_type *type; /**< Individual well taxonomy */
|
||||||
enum well_control *ctrl; /**< Individual well controls */
|
enum well_control *ctrl; /**< Individual well controls */
|
||||||
double *target; /**< Control target */
|
double *target; /**< Control target */
|
||||||
@ -79,13 +79,13 @@ struct completion_data {
|
|||||||
* Convenience type alias to preserve backwards compatibility in
|
* Convenience type alias to preserve backwards compatibility in
|
||||||
* well topology definitions used by hybridised pressure solver.
|
* well topology definitions used by hybridised pressure solver.
|
||||||
*/
|
*/
|
||||||
typedef struct WellCompletions well_t;
|
typedef struct LegacyWellCompletions well_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convenience type alias to preserve backwards compatiblity in
|
* Convenience type alias to preserve backwards compatiblity in
|
||||||
* well control definitions used by hybridised pressure solver.
|
* well control definitions used by hybridised pressure solver.
|
||||||
*/
|
*/
|
||||||
typedef struct WellControls well_control_t;
|
typedef struct LegacyWellControls well_control_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Allocate cell-to-well mapping (as a sparse array).
|
* Allocate cell-to-well mapping (as a sparse array).
|
||||||
|
@ -88,7 +88,7 @@ struct WellControls
|
|||||||
enum WellControlType *type;
|
enum WellControlType *type;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Array of control targets
|
* Array of control targets.
|
||||||
*/
|
*/
|
||||||
double *target;
|
double *target;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user