ecl_smspec.hpp File Reference

#include <time.h>
#include <stdbool.h>
#include <ert/util/float_vector.hpp>
#include <ert/util/stringlist.hpp>
#include <ert/ecl/ecl_util.hpp>
#include <ert/ecl/smspec_node.hpp>

Include dependency graph for ecl_smspec.hpp:

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

Go to the source code of this file.

Typedefs
typedef struct ecl_smspec_struct	ecl_smspec_type

Functions
int *	ecl_smspec_alloc_mapping (const ecl_smspec_type *self, const ecl_smspec_type *other)
const int *	ecl_smspec_get_index_map (const ecl_smspec_type *smspec)
ecl_smspec_var_type	ecl_smspec_iget_var_type (const ecl_smspec_type *smspec, int index)
bool	ecl_smspec_needs_num (ecl_smspec_var_type var_type)
bool	ecl_smspec_needs_wgname (ecl_smspec_var_type var_type)
const char *	ecl_smspec_get_var_type_name (ecl_smspec_var_type var_type)
ecl_smspec_var_type	ecl_smspec_identify_var_type (const char *var)
ecl_smspec_type *	ecl_smspec_alloc_empty (bool write_mode, const char *key_join_string)
ecl_smspec_type *	ecl_smspec_alloc_restart_writer (const char *key_join_string, const char *restart_case, int restart_step, time_t sim_start, bool time_in_days, int nx, int ny, int nz)
ecl_smspec_type *	ecl_smspec_alloc_writer (const char *key_join_string, time_t sim_start, bool time_in_days, int nx, int ny, int nz)
void	ecl_smspec_fwrite (const ecl_smspec_type *smspec, const char *ecl_case, bool fmt_file)
ecl_smspec_type *	ecl_smspec_fread_alloc (const char *header_file, const char *key_join_string, bool include_restart)
void	ecl_smspec_free (ecl_smspec_type *)
int	ecl_smspec_get_date_day_index (const ecl_smspec_type *smspec)
int	ecl_smspec_get_date_month_index (const ecl_smspec_type *smspec)
int	ecl_smspec_get_date_year_index (const ecl_smspec_type *smspec)
int	ecl_smspec_get_well_var_params_index (const ecl_smspec_type *ecl_smspec, const char *well, const char *var)
bool	ecl_smspec_has_well_var (const ecl_smspec_type *ecl_smspec, const char *well, const char *var)
int	ecl_smspec_get_group_var_params_index (const ecl_smspec_type *ecl_smspec, const char *group, const char *var)
bool	ecl_smspec_has_group_var (const ecl_smspec_type *ecl_smspec, const char *group, const char *var)
int	ecl_smspec_get_field_var_params_index (const ecl_smspec_type *ecl_smspec, const char *var)
bool	ecl_smspec_has_field_var (const ecl_smspec_type *ecl_smspec, const char *var)
int	ecl_smspec_get_region_var_params_index (const ecl_smspec_type *ecl_smspec, const char *region_var, int region_nr)
bool	ecl_smspec_has_region_var (const ecl_smspec_type *ecl_smspec, const char *region_var, int region_nr)
int	ecl_smspec_get_misc_var_params_index (const ecl_smspec_type *ecl_smspec, const char *var)
bool	ecl_smspec_has_misc_var (const ecl_smspec_type *ecl_smspec, const char *var)
int	ecl_smspec_get_block_var_params_index (const ecl_smspec_type *ecl_smspec, const char *block_var, int block_nr)
bool	ecl_smspec_has_block_var (const ecl_smspec_type *ecl_smspec, const char *block_var, int block_nr)
int	ecl_smspec_get_block_var_params_index_ijk (const ecl_smspec_type *ecl_smspec, const char *block_var, int i, int j, int k)
bool	ecl_smspec_has_block_var_ijk (const ecl_smspec_type *ecl_smspec, const char *block_var, int i, int j, int k)
int	ecl_smspec_get_well_completion_var_params_index (const ecl_smspec_type *ecl_smspec, const char *well, const char *var, int cell_nr)
bool	ecl_smspec_has_well_completion_var (const ecl_smspec_type *ecl_smspec, const char *well, const char *var, int cell_nr)
int	ecl_smspec_get_general_var_params_index (const ecl_smspec_type *ecl_smspec, const char *lookup_kw)
bool	ecl_smspec_has_general_var (const ecl_smspec_type *ecl_smspec, const char *lookup_kw)
const char *	ecl_smspec_get_general_var_unit (const ecl_smspec_type *ecl_smspec, const char *lookup_kw)
void	ecl_smspec_select_matching_general_var_list (const ecl_smspec_type *smspec, const char *pattern, stringlist_type *keys)
stringlist_type *	ecl_smspec_alloc_matching_general_var_list (const ecl_smspec_type *smspec, const char *pattern)
int	ecl_smspec_get_time_seconds (const ecl_smspec_type *ecl_smspec)
int	ecl_smspec_get_time_index (const ecl_smspec_type *ecl_smspec)
time_t	ecl_smspec_get_start_time (const ecl_smspec_type *)
bool	ecl_smspec_get_formatted (const ecl_smspec_type *ecl_smspec)
const char *	ecl_smspec_get_header_file (const ecl_smspec_type *ecl_smspec)
stringlist_type *	ecl_smspec_alloc_well_list (const ecl_smspec_type *smspec, const char *pattern)
stringlist_type *	ecl_smspec_alloc_group_list (const ecl_smspec_type *smspec, const char *pattern)
stringlist_type *	ecl_smspec_alloc_well_var_list (const ecl_smspec_type *smspec)
const char *	ecl_smspec_get_simulation_path (const ecl_smspec_type *ecl_smspec)
int	ecl_smspec_get_first_step (const ecl_smspec_type *ecl_smspec)
int	ecl_smspec_get_restart_step (const ecl_smspec_type *ecl_smspec)
const char *	ecl_smspec_get_restart_case (const ecl_smspec_type *ecl_smspec)
const char *	ecl_smspec_get_join_string (const ecl_smspec_type *smspec)
const int *	ecl_smspec_get_grid_dims (const ecl_smspec_type *smspec)
int	ecl_smspec_get_params_size (const ecl_smspec_type *smspec)
int	ecl_smspec_num_nodes (const ecl_smspec_type *smspec)
char *	ecl_smspec_alloc_well_key (const ecl_smspec_type *smspec, const char *keyword, const char *wgname)
bool	ecl_smspec_equal (const ecl_smspec_type *self, const ecl_smspec_type *other)
ert_ecl_unit_enum	ecl_smspec_get_unit_system (const ecl_smspec_type *smspec)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, const ecl::smspec_node &node)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, const char *keyword, int num, const char *unit, float default_value)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, const char *keyword, const char *unit, float default_value)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, const char *keyword, const char *wgname, const char *unit, float default_value)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, const char *keyword, const char *wgname, int num, const char *unit, float default_value)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, int params_index, const char *keyword, const char *wgname, int num, const char *unit, float default_value)
const ecl::smspec_node *	ecl_smspec_add_node (ecl_smspec_type *ecl_smspec, int params_index, const char *keyword, const char *wgname, int num, const char *unit, const char *lgr, int lgr_i, int lgr_j, int lgr_k, float default_value)

Typedef Documentation

ecl_smspec_type

typedef struct ecl_smspec_struct ecl_smspec_type

Function Documentation

ecl_smspec_add_node() [1/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		const char *	keyword,
		const char *	unit,
		float	default_value
	)

ecl_smspec_add_node() [2/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		const char *	keyword,
		const char *	wgname,
		const char *	unit,
		float	default_value
	)

ecl_smspec_add_node() [3/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		const char *	keyword,
		const char *	wgname,
		int	num,
		const char *	unit,
		float	default_value
	)

ecl_smspec_add_node() [4/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		const char *	keyword,
		int	num,
		const char *	unit,
		float	default_value
	)

ecl_smspec_add_node() [5/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		const ecl::smspec_node &	node
	)

ecl_smspec_add_node() [6/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		int	params_index,
		const char *	keyword,
		const char *	wgname,
		int	num,
		const char *	unit,
		const char *	lgr,
		int	lgr_i,
		int	lgr_j,
		int	lgr_k,
		float	default_value
	)

ecl_smspec_add_node() [7/7]

const ecl::smspec_node * ecl_smspec_add_node	(	ecl_smspec_type *	ecl_smspec,
		int	params_index,
		const char *	keyword,
		const char *	wgname,
		int	num,
		const char *	unit,
		float	default_value
	)

ecl_smspec_alloc_empty()

ecl_smspec_type * ecl_smspec_alloc_empty	(	bool	write_mode,
		const char *	key_join_string
	)

ecl_smspec_alloc_group_list()

stringlist_type * ecl_smspec_alloc_group_list	(	const ecl_smspec_type *	smspec,
		const char *	pattern
	)

ecl_smspec_alloc_mapping()

int * ecl_smspec_alloc_mapping	(	const ecl_smspec_type *	self,
		const ecl_smspec_type *	other
	)

These are the different variable types, see table 3.4 in the ECLIPFE file format docuemntation for naming conventions.

Only the variable types marked with "X" below are supported in the remaining implementation. To add support for a new variable type the functions smspec_node_alloc(), ecl_smsepec_fread_header() and ecl_smspec_install_gen_key() must be updated.

ecl_smspec_alloc_matching_general_var_list()

stringlist_type * ecl_smspec_alloc_matching_general_var_list	(	const ecl_smspec_type *	smspec,
		const char *	pattern
	)

ecl_smspec_alloc_restart_writer()

ecl_smspec_type * ecl_smspec_alloc_restart_writer	(	const char *	key_join_string,
		const char *	restart_case,
		int	restart_step,
		time_t	sim_start,
		bool	time_in_days,
		int	nx,
		int	ny,
		int	nz
	)

ecl_smspec_alloc_well_key()

char * ecl_smspec_alloc_well_key	(	const ecl_smspec_type *	smspec,
		const char *	keyword,
		const char *	wgname
	)

ecl_smspec_alloc_well_list()

stringlist_type * ecl_smspec_alloc_well_list	(	const ecl_smspec_type *	smspec,
		const char *	pattern
	)

ecl_smspec_alloc_well_var_list()

stringlist_type * ecl_smspec_alloc_well_var_list

(

const ecl_smspec_type *

smspec

)

ecl_smspec_alloc_writer()

ecl_smspec_type * ecl_smspec_alloc_writer	(	const char *	key_join_string,
		time_t	sim_start,
		bool	time_in_days,
		int	nx,
		int	ny,
		int	nz
	)

ecl_smspec_equal()

bool ecl_smspec_equal	(	const ecl_smspec_type *	self,
		const ecl_smspec_type *	other
	)

ecl_smspec_fread_alloc()

ecl_smspec_type * ecl_smspec_fread_alloc	(	const char *	header_file,
		const char *	key_join_string,
		bool	include_restart
	)

ecl_smspec_free()

void ecl_smspec_free

(

ecl_smspec_type *

)

ecl_smspec_fwrite()

void ecl_smspec_fwrite	(	const ecl_smspec_type *	smspec,
		const char *	ecl_case,
		bool	fmt_file
	)

ecl_smspec_get_block_var_params_index()

int ecl_smspec_get_block_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	block_var,
		int	block_nr
	)

ecl_smspec_get_block_var_params_index_ijk()

int ecl_smspec_get_block_var_params_index_ijk	(	const ecl_smspec_type *	ecl_smspec,
		const char *	block_var,
		int	i,
		int	j,
		int	k
	)

ecl_smspec_get_date_day_index()

int ecl_smspec_get_date_day_index

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_date_month_index()

int ecl_smspec_get_date_month_index

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_date_year_index()

int ecl_smspec_get_date_year_index

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_field_var_params_index()

int ecl_smspec_get_field_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	var
	)

ecl_smspec_get_first_step()

int ecl_smspec_get_first_step

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_formatted()

bool ecl_smspec_get_formatted

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_general_var_params_index()

int ecl_smspec_get_general_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	lookup_kw
	)

ecl_smspec_get_general_var_unit()

const char * ecl_smspec_get_general_var_unit	(	const ecl_smspec_type *	ecl_smspec,
		const char *	lookup_kw
	)

ecl_smspec_get_grid_dims()

const int * ecl_smspec_get_grid_dims

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_group_var_params_index()

int ecl_smspec_get_group_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	group,
		const char *	var
	)

ecl_smspec_get_header_file()

const char * ecl_smspec_get_header_file

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_index_map()

const int * ecl_smspec_get_index_map

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_join_string()

const char * ecl_smspec_get_join_string

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_misc_var_params_index()

int ecl_smspec_get_misc_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	var
	)

ecl_smspec_get_params_size()

int ecl_smspec_get_params_size

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_region_var_params_index()

int ecl_smspec_get_region_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	region_var,
		int	region_nr
	)

ecl_smspec_get_restart_case()

const char * ecl_smspec_get_restart_case

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_restart_step()

int ecl_smspec_get_restart_step

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_simulation_path()

const char * ecl_smspec_get_simulation_path

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_start_time()

time_t ecl_smspec_get_start_time

(

const ecl_smspec_type *

)

ecl_smspec_get_time_index()

int ecl_smspec_get_time_index

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_time_seconds()

int ecl_smspec_get_time_seconds

(

const ecl_smspec_type *

ecl_smspec

)

ecl_smspec_get_unit_system()

ert_ecl_unit_enum ecl_smspec_get_unit_system

(

const ecl_smspec_type *

smspec

)

ecl_smspec_get_var_type_name()

const char * ecl_smspec_get_var_type_name

(

ecl_smspec_var_type

var_type

)

ecl_smspec_get_well_completion_var_params_index()

int ecl_smspec_get_well_completion_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	well,
		const char *	var,
		int	cell_nr
	)

ecl_smspec_get_well_var_params_index()

int ecl_smspec_get_well_var_params_index	(	const ecl_smspec_type *	ecl_smspec,
		const char *	well,
		const char *	var
	)

ecl_smspec_has_block_var()

bool ecl_smspec_has_block_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	block_var,
		int	block_nr
	)

ecl_smspec_has_block_var_ijk()

bool ecl_smspec_has_block_var_ijk	(	const ecl_smspec_type *	ecl_smspec,
		const char *	block_var,
		int	i,
		int	j,
		int	k
	)

ecl_smspec_has_field_var()

bool ecl_smspec_has_field_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	var
	)

ecl_smspec_has_general_var()

bool ecl_smspec_has_general_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	lookup_kw
	)

ecl_smspec_has_group_var()

bool ecl_smspec_has_group_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	group,
		const char *	var
	)

ecl_smspec_has_misc_var()

bool ecl_smspec_has_misc_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	var
	)

ecl_smspec_has_region_var()

bool ecl_smspec_has_region_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	region_var,
		int	region_nr
	)

ecl_smspec_has_well_completion_var()

bool ecl_smspec_has_well_completion_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	well,
		const char *	var,
		int	cell_nr
	)

ecl_smspec_has_well_var()

bool ecl_smspec_has_well_var	(	const ecl_smspec_type *	ecl_smspec,
		const char *	well,
		const char *	var
	)

ecl_smspec_identify_var_type()

ecl_smspec_var_type ecl_smspec_identify_var_type

(

const char *

var

)

ecl_smspec_iget_var_type()

ecl_smspec_var_type ecl_smspec_iget_var_type	(	const ecl_smspec_type *	smspec,
		int	index
	)

ecl_smspec_needs_num()

bool ecl_smspec_needs_num

(

ecl_smspec_var_type

var_type

)

ecl_smspec_needs_wgname()

bool ecl_smspec_needs_wgname

(

ecl_smspec_var_type

var_type

)

ecl_smspec_num_nodes()

int ecl_smspec_num_nodes

(

const ecl_smspec_type *

smspec

)

ecl_smspec_select_matching_general_var_list()

void ecl_smspec_select_matching_general_var_list	(	const ecl_smspec_type *	smspec,
		const char *	pattern,
		stringlist_type *	keys
	)