ecl_file.hpp File Reference

#include <stdbool.h>
#include <time.h>
#include <ert/ecl/ecl_kw.hpp>
#include <ert/ecl/ecl_file_kw.hpp>
#include <ert/ecl/ecl_file_view.hpp>
#include <ert/ecl/fortio.h>
#include <ert/ecl/ecl_util.hpp>
#include <ert/ecl/ecl_type.hpp>

Include dependency graph for ecl_file.hpp:

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

Go to the source code of this file.

Macros
#define	ECL_FILE_FLAGS_ENUM_DEFS
#define	ECL_FILE_FLAGS_ENUM_SIZE   2

Typedefs
typedef struct ecl_file_struct	ecl_file_type

Functions
bool	ecl_file_load_all (ecl_file_type *ecl_file)
ecl_file_type *	ecl_file_open (const char *filename, int flags)
ecl_file_type *	ecl_file_fast_open (const char *filename, const char *index_filename, int flags)
bool	ecl_file_write_index (const ecl_file_type *ecl_file, const char *index_filename)
bool	ecl_file_index_valid (const char *file_name, const char *index_file_name)
void	ecl_file_close (ecl_file_type *ecl_file)
void	ecl_file_fortio_detach (ecl_file_type *ecl_file)
void	ecl_file_free__ (void *arg)
ecl_kw_type *	ecl_file_icopy_named_kw (const ecl_file_type *ecl_file, const char *kw, int ith)
ecl_kw_type *	ecl_file_icopy_kw (const ecl_file_type *ecl_file, int index)
bool	ecl_file_has_kw (const ecl_file_type *ecl_file, const char *kw)
int	ecl_file_get_num_named_kw (const ecl_file_type *ecl_file, const char *kw)
int	ecl_file_get_size (const ecl_file_type *ecl_file)
int	ecl_file_get_num_distinct_kw (const ecl_file_type *ecl_file)
const char *	ecl_file_iget_distinct_kw (const ecl_file_type *ecl_file, int index)
const char *	ecl_file_get_src_file (const ecl_file_type *ecl_file)
int	ecl_file_iget_occurence (const ecl_file_type *ecl_file, int index)
ecl_version_enum	ecl_file_get_ecl_version (const ecl_file_type *file)
void	ecl_file_fwrite_fortio (const ecl_file_type *ec_file, fortio_type *fortio, int offset)
void	ecl_file_fwrite (const ecl_file_type *ecl_file, const char *, bool fmt_file)
void	ecl_file_replace_kw (ecl_file_type *ecl_file, ecl_kw_type *old_kw, ecl_kw_type *new_kw, bool insert_copy)
int	ecl_file_get_phases (const ecl_file_type *init_file)
void	ecl_file_fprintf_kw_list (const ecl_file_type *ecl_file, FILE *stream)
bool	ecl_file_writable (const ecl_file_type *ecl_file)
int	ecl_file_get_flags (const ecl_file_type *ecl_file)
void	ecl_file_set_flags (ecl_file_type *ecl_file, int new_flags)
bool	ecl_file_flags_set (const ecl_file_type *ecl_file, int flags)
ecl_file_kw_type *	ecl_file_iget_file_kw (const ecl_file_type *file, int global_index)
ecl_file_kw_type *	ecl_file_iget_named_file_kw (const ecl_file_type *file, const char *kw, int ith)
ecl_kw_type *	ecl_file_iget_kw (const ecl_file_type *file, int global_index)
ecl_data_type	ecl_file_iget_data_type (const ecl_file_type *file, int global_index)
int	ecl_file_iget_size (const ecl_file_type *file, int global_index)
const char *	ecl_file_iget_header (const ecl_file_type *file, int global_index)
ecl_kw_type *	ecl_file_iget_named_kw (const ecl_file_type *file, const char *kw, int ith)
ecl_data_type	ecl_file_iget_named_data_type (const ecl_file_type *file, const char *kw, int ith)
int	ecl_file_iget_named_size (const ecl_file_type *file, const char *kw, int ith)
void	ecl_file_indexed_read (const ecl_file_type *file, const char *kw, int index, const int_vector_type *index_map, char *buffer)
ecl_file_view_type *	ecl_file_get_global_blockview (ecl_file_type *ecl_file, const char *kw, int occurence)
ecl_file_view_type *	ecl_file_alloc_global_blockview (ecl_file_type *ecl_file, const char *kw, int occurence)
ecl_file_view_type *	ecl_file_get_global_view (ecl_file_type *ecl_file)
ecl_file_view_type *	ecl_file_get_active_view (ecl_file_type *ecl_file)
bool	ecl_file_save_kw (const ecl_file_type *ecl_file, const ecl_kw_type *ecl_kw)
bool	ecl_file_has_kw_ptr (const ecl_file_type *ecl_file, const ecl_kw_type *ecl_kw)
double	ecl_file_iget_restart_sim_days (const ecl_file_type *restart_file, int index)
time_t	ecl_file_iget_restart_sim_date (const ecl_file_type *restart_file, int occurence)
int	ecl_file_get_restart_index (const ecl_file_type *restart_file, time_t sim_time)
bool	ecl_file_has_report_step (const ecl_file_type *ecl_file, int report_step)
bool	ecl_file_has_sim_time (const ecl_file_type *ecl_file, time_t sim_time)
void	ecl_file_close_fortio_stream (ecl_file_type *ecl_file)
ecl_file_view_type *	ecl_file_get_restart_view (ecl_file_type *ecl_file, int input_index, int report_step, time_t sim_time, double sim_days)
ecl_file_view_type *	ecl_file_get_summary_view (ecl_file_type *ecl_file, int report_step)
	UTIL_IS_INSTANCE_HEADER (ecl_file)
void	ecl_file_push_block (ecl_file_type *ecl_file)
void	ecl_file_pop_block (ecl_file_type *ecl_file)
bool	ecl_file_subselect_block (ecl_file_type *ecl_file, const char *kw, int occurence)
bool	ecl_file_select_block (ecl_file_type *ecl_file, const char *kw, int occurence)
bool	ecl_file_select_rstblock_sim_time (ecl_file_type *ecl_file, time_t sim_time)
bool	ecl_file_select_rstblock_report_step (ecl_file_type *ecl_file, int report_step)
bool	ecl_file_iselect_rstblock (ecl_file_type *ecl_file, int seqnum_index)
ecl_file_type *	ecl_file_open_rstblock_report_step (const char *filename, int report_step, int flags)
ecl_file_type *	ecl_file_open_rstblock_sim_time (const char *filename, time_t sim_time, int flags)
ecl_file_type *	ecl_file_iopen_rstblock (const char *filename, int seqnum_index, int flags)

Macro Definition Documentation

ECL_FILE_FLAGS_ENUM_DEFS

#define ECL_FILE_FLAGS_ENUM_DEFS

Value:

  {.value =   1 , .name="ECL_FILE_CLOSE_STREAM"}, \
  {.value =   2 , .name="ECL_FILE_WRITABLE"}

ECL_FILE_FLAGS_ENUM_SIZE

#define ECL_FILE_FLAGS_ENUM_SIZE   2

Typedef Documentation

ecl_file_type

typedef struct ecl_file_struct ecl_file_type

Function Documentation

ecl_file_alloc_global_blockview()

ecl_file_view_type * ecl_file_alloc_global_blockview	(	ecl_file_type *	ecl_file,
		const char *	kw,
		int	occurence
	)

ecl_file_close()

void ecl_file_close

(

ecl_file_type *

ecl_file

)

ecl_file_close_fortio_stream()

void ecl_file_close_fortio_stream

(

ecl_file_type *

ecl_file

)

ecl_file_fast_open()

ecl_file_type * ecl_file_fast_open	(	const char *	filename,
		const char *	index_filename,
		int	flags
	)

ecl_file_flags_set()

bool ecl_file_flags_set	(	const ecl_file_type *	ecl_file,
		int	flags
	)

ecl_file_fortio_detach()

void ecl_file_fortio_detach

(

ecl_file_type *

ecl_file

)

ecl_file_fprintf_kw_list()

void ecl_file_fprintf_kw_list	(	const ecl_file_type *	ecl_file,
		FILE *	stream
	)

ecl_file_free__()

void ecl_file_free__

(

void *

arg

)

ecl_file_fwrite()

void ecl_file_fwrite	(	const ecl_file_type *	ecl_file,
		const char *	,
		bool	fmt_file
	)

ecl_file_fwrite_fortio()

void ecl_file_fwrite_fortio	(	const ecl_file_type *	ec_file,
		fortio_type *	fortio,
		int	offset
	)

ecl_file_get_active_view()

ecl_file_view_type * ecl_file_get_active_view

(

ecl_file_type *

ecl_file

)

ecl_file_get_ecl_version()

ecl_version_enum ecl_file_get_ecl_version

(

const ecl_file_type *

file

)

ecl_file_get_flags()

int ecl_file_get_flags

(

const ecl_file_type *

ecl_file

)

ecl_file_get_global_blockview()

ecl_file_view_type * ecl_file_get_global_blockview	(	ecl_file_type *	ecl_file,
		const char *	kw,
		int	occurence
	)

ecl_file_get_global_view()

ecl_file_view_type * ecl_file_get_global_view

(

ecl_file_type *

ecl_file

)

ecl_file_get_num_distinct_kw()

int ecl_file_get_num_distinct_kw

(

const ecl_file_type *

ecl_file

)

ecl_file_get_num_named_kw()

int ecl_file_get_num_named_kw	(	const ecl_file_type *	ecl_file,
		const char *	kw
	)

ecl_file_get_phases()

int ecl_file_get_phases

(

const ecl_file_type *

init_file

)

ecl_file_get_restart_index()

int ecl_file_get_restart_index	(	const ecl_file_type *	restart_file,
		time_t	sim_time
	)

ecl_file_get_restart_view()

ecl_file_view_type * ecl_file_get_restart_view	(	ecl_file_type *	ecl_file,
		int	input_index,
		int	report_step,
		time_t	sim_time,
		double	sim_days
	)

ecl_file_get_size()

int ecl_file_get_size

(

const ecl_file_type *

ecl_file

)

ecl_file_get_src_file()

const char * ecl_file_get_src_file

(

const ecl_file_type *

ecl_file

)

ecl_file_get_summary_view()

ecl_file_view_type * ecl_file_get_summary_view	(	ecl_file_type *	ecl_file,
		int	report_step
	)

ecl_file_has_kw()

bool ecl_file_has_kw	(	const ecl_file_type *	ecl_file,
		const char *	kw
	)

ecl_file_has_kw_ptr()

bool ecl_file_has_kw_ptr	(	const ecl_file_type *	ecl_file,
		const ecl_kw_type *	ecl_kw
	)

ecl_file_has_report_step()

bool ecl_file_has_report_step	(	const ecl_file_type *	ecl_file,
		int	report_step
	)

ecl_file_has_sim_time()

bool ecl_file_has_sim_time	(	const ecl_file_type *	ecl_file,
		time_t	sim_time
	)

ecl_file_icopy_kw()

ecl_kw_type * ecl_file_icopy_kw	(	const ecl_file_type *	ecl_file,
		int	index
	)

ecl_file_icopy_named_kw()

ecl_kw_type * ecl_file_icopy_named_kw	(	const ecl_file_type *	ecl_file,
		const char *	kw,
		int	ith
	)

ecl_file_iget_data_type()

ecl_data_type ecl_file_iget_data_type	(	const ecl_file_type *	file,
		int	global_index
	)

ecl_file_iget_distinct_kw()

const char * ecl_file_iget_distinct_kw	(	const ecl_file_type *	ecl_file,
		int	index
	)

ecl_file_iget_file_kw()

ecl_file_kw_type * ecl_file_iget_file_kw	(	const ecl_file_type *	file,
		int	global_index
	)

ecl_file_iget_header()

const char * ecl_file_iget_header	(	const ecl_file_type *	file,
		int	global_index
	)

ecl_file_iget_kw()

ecl_kw_type * ecl_file_iget_kw	(	const ecl_file_type *	file,
		int	global_index
	)

ecl_file_iget_named_data_type()

ecl_data_type ecl_file_iget_named_data_type	(	const ecl_file_type *	file,
		const char *	kw,
		int	ith
	)

ecl_file_iget_named_file_kw()

ecl_file_kw_type * ecl_file_iget_named_file_kw	(	const ecl_file_type *	file,
		const char *	kw,
		int	ith
	)

ecl_file_iget_named_kw()

ecl_kw_type * ecl_file_iget_named_kw	(	const ecl_file_type *	file,
		const char *	kw,
		int	ith
	)

ecl_file_iget_named_size()

int ecl_file_iget_named_size	(	const ecl_file_type *	file,
		const char *	kw,
		int	ith
	)

ecl_file_iget_occurence()

int ecl_file_iget_occurence	(	const ecl_file_type *	ecl_file,
		int	index
	)

ecl_file_iget_restart_sim_date()

time_t ecl_file_iget_restart_sim_date	(	const ecl_file_type *	restart_file,
		int	occurence
	)

ecl_file_iget_restart_sim_days()

double ecl_file_iget_restart_sim_days	(	const ecl_file_type *	restart_file,
		int	index
	)

ecl_file_iget_size()

int ecl_file_iget_size	(	const ecl_file_type *	file,
		int	global_index
	)

ecl_file_index_valid()

bool ecl_file_index_valid	(	const char *	file_name,
		const char *	index_file_name
	)

ecl_file_indexed_read()

void ecl_file_indexed_read	(	const ecl_file_type *	file,
		const char *	kw,
		int	index,
		const int_vector_type *	index_map,
		char *	buffer
	)

ecl_file_iopen_rstblock()

ecl_file_type * ecl_file_iopen_rstblock	(	const char *	filename,
		int	seqnum_index,
		int	flags
	)

ecl_file_iselect_rstblock()

bool ecl_file_iselect_rstblock	(	ecl_file_type *	ecl_file,
		int	seqnum_index
	)

ecl_file_load_all()

bool ecl_file_load_all

(

ecl_file_type *

ecl_file

)

ecl_file_open()

ecl_file_type * ecl_file_open	(	const char *	filename,
		int	flags
	)

ecl_file_open_rstblock_report_step()

ecl_file_type * ecl_file_open_rstblock_report_step	(	const char *	filename,
		int	report_step,
		int	flags
	)

ecl_file_open_rstblock_sim_time()

ecl_file_type * ecl_file_open_rstblock_sim_time	(	const char *	filename,
		time_t	sim_time,
		int	flags
	)

ecl_file_pop_block()

void ecl_file_pop_block

(

ecl_file_type *

ecl_file

)

ecl_file_push_block()

void ecl_file_push_block

(

ecl_file_type *

ecl_file

)

ecl_file_replace_kw()

void ecl_file_replace_kw	(	ecl_file_type *	ecl_file,
		ecl_kw_type *	old_kw,
		ecl_kw_type *	new_kw,
		bool	insert_copy
	)

ecl_file_save_kw()

bool ecl_file_save_kw	(	const ecl_file_type *	ecl_file,
		const ecl_kw_type *	ecl_kw
	)

ecl_file_select_block()

bool ecl_file_select_block	(	ecl_file_type *	ecl_file,
		const char *	kw,
		int	occurence
	)

ecl_file_select_rstblock_report_step()

bool ecl_file_select_rstblock_report_step	(	ecl_file_type *	ecl_file,
		int	report_step
	)

ecl_file_select_rstblock_sim_time()

bool ecl_file_select_rstblock_sim_time	(	ecl_file_type *	ecl_file,
		time_t	sim_time
	)

ecl_file_set_flags()

void ecl_file_set_flags	(	ecl_file_type *	ecl_file,
		int	new_flags
	)

ecl_file_subselect_block()

bool ecl_file_subselect_block	(	ecl_file_type *	ecl_file,
		const char *	kw,
		int	occurence
	)

ecl_file_writable()

bool ecl_file_writable

(

const ecl_file_type *

ecl_file

)

ecl_file_write_index()

bool ecl_file_write_index	(	const ecl_file_type *	ecl_file,
		const char *	index_filename
	)

UTIL_IS_INSTANCE_HEADER()

UTIL_IS_INSTANCE_HEADER

(

ecl_file

)