legacy_well.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	LegacyWellCompletions
struct	LegacyWellControls
struct	completion_data

Typedefs
typedef struct LegacyWellCompletions	well_t
typedef struct LegacyWellControls	well_control_t

Enumerations
enum	well_type { INJECTOR, PRODUCER }
enum	well_control { BHP, RATE }
enum	surface_component { WATER = 0, OIL = 1, GAS = 2 }

Functions
int	allocate_cell_wells (int nc, well_t *W, int **cwpos, int **cwells)
void	deallocate_cell_wells (int *cvpos, int *cwells)
void	derive_cell_wells (int nc, well_t *W, int *cwpos, int *cwells)

Detailed Description

Deprecated (and obsolescent) well definition. Still in use by the hybridized pressure solvers.

Typedef Documentation

typedef struct LegacyWellControls well_control_t

Convenience type alias to preserve backwards compatiblity in well control definitions used by hybridised pressure solver.

typedef struct LegacyWellCompletions well_t

Convenience type alias to preserve backwards compatibility in well topology definitions used by hybridised pressure solver.

Enumeration Type Documentation

enum surface_component

Compositions recognised in injection wells.

Enumerator
WATER
OIL
GAS

enum well_control

Control types recognised in system.

Enumerator
BHP
RATE

enum well_type

Well taxonomy.

Enumerator
INJECTOR
PRODUCER

Function Documentation

int allocate_cell_wells	(	int	nc,
		well_t *	W,
		int **	cwpos,
		int **	cwells
	)

Allocate cell-to-well mapping (as a sparse array).

Parameters

[in]	nc	Total number of cells.
[in]	W	Well topology (well-to-cell mapping).
[out]	cwpos	Indirection array. Points to array of size nc + 1 if successful.
[out]	cwells	Cell-to-well mapping. Points to array of size W->well_connpos[ W->number_of_wells] if successful.

Returns

Positive number (size of *cwells) if successful. Zero in case of allocation failure.

void deallocate_cell_wells	(	int *	cvpos,
		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.

Parameters

[in,out]	cvpos	Cell-to-well start pointers.
[in,out]	cwells	Cell-to-well mapping.

void derive_cell_wells	(	int	nc,
		well_t *	W,
		int *	cwpos,
		int *	cwells
	)

Construct cell-to-well mapping (i.e., transpose the well-to-cell mapping represented by W->well_cells).

Parameters

[in]	nc	Total number of cells.
[in]	W	Well topology (well-to-cell mapping).
[out]	cwpos	Cell-to-well start pointers.
[out]	cwells	Cell-to-well mapping.