ecl_util.hpp File Reference
#include <stdbool.h>
#include <time.h>
#include <ert/util/stringlist.hpp>
#include <ert/util/time_t_vector.hpp>
#include <ert/util/parser.hpp>
#include <ert/ecl/ecl_type.hpp>
Include dependency graph for ecl_util.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ECL_PHASE_ENUM_DEFS   {.value = 1 , .name = "ECL_OIL_PHASE"}, {.value = 2 , .name = "ECL_GAS_PHASE"} , {.value = 4 , .name = "ECL_WATER_PHASE"}
 
#define ECL_PHASE_ENUM_SIZE   3
 
#define ECL_BOOL_TRUE_INT   -1
 
#define ECL_BOOL_FALSE_INT   0
 
#define ECL_COMMENT_STRING   "--"
 
#define ECL_COMMENT_CHAR   '-'
 
#define ECL_DATA_TERMINATION   "/"
 

Enumerations

enum  ecl_file_enum {
  ECL_OTHER_FILE = 0 , ECL_RESTART_FILE = 1 , ECL_UNIFIED_RESTART_FILE = 2 , ECL_SUMMARY_FILE = 4 ,
  ECL_UNIFIED_SUMMARY_FILE = 8 , ECL_SUMMARY_HEADER_FILE = 16 , ECL_GRID_FILE = 32 , ECL_EGRID_FILE = 64 ,
  ECL_INIT_FILE = 128 , ECL_RFT_FILE = 256 , ECL_DATA_FILE = 512
}
 
enum  ecl_storage_enum {
  ECL_INVALID_STORAGE = 0 , ECL_BINARY_UNIFIED = 1 , ECL_FORMATTED_UNIFIED = 2 , ECL_BINARY_NON_UNIFIED = 4 ,
  ECL_FORMATTED_NON_UNIFIED = 8
}
 
enum  ecl_version_enum {
  ECLIPSE_UNDEFINED = 0 , ECLIPSE100 = 1 , ECLIPSE300 = 2 , ECLIPSE300_THERMAL = 3 ,
  INTERSECT = 4 , FRONTSIM = 5
}
 
enum  ecl_phase_enum { ECL_OIL_PHASE = 1 , ECL_GAS_PHASE = 2 , ECL_WATER_PHASE = 4 }
 
enum  ert_ecl_unit_enum { ECL_METRIC_UNITS = 1 , ECL_FIELD_UNITS = 2 , ECL_LAB_UNITS = 3 , ECL_PVT_M_UNITS = 4 }
 

Functions

bool ecl_util_unified_file (const char *filename)
 
const char * ecl_util_file_type_name (ecl_file_enum file_type)
 
char * ecl_util_alloc_base_guess (const char *)
 
int ecl_util_filename_report_nr (const char *)
 
ecl_file_enum ecl_util_inspect_extension (const char *ext, bool *_fmt_file, int *_report_nr)
 
ecl_file_enum ecl_util_get_file_type (const char *filename, bool *fmt_file, int *report_nr)
 
char * ecl_util_alloc_filename (const char *, const char *, ecl_file_enum, bool, int)
 
char * ecl_util_alloc_exfilename (const char *, const char *, ecl_file_enum, bool, int)
 
void ecl_util_memcpy_typed_data (void *, const void *, ecl_data_type, ecl_data_type, int)
 
void ecl_util_escape_kw (char *kw)
 
bool ecl_util_alloc_summary_files (const char *, const char *, const char *, char **, stringlist_type *)
 
void ecl_util_alloc_summary_data_files (const char *path, const char *base, bool fmt_file, stringlist_type *filelist)
 
void ecl_util_alloc_restart_files (const char *, const char *, char ***, int *, bool *, bool *)
 
time_t ecl_util_get_start_date (const char *)
 
int ecl_util_get_num_cpu (const char *data_file)
 
bool ecl_util_fmt_file (const char *filename, bool *__fmt_file)
 
char * ecl_util_alloc_exfilename_anyfmt (const char *path, const char *base, ecl_file_enum file_type, bool start_fmt, int report_nr)
 
int ecl_util_get_month_nr (const char *month_name)
 
int ecl_util_fname_report_cmp (const void *f1, const void *f2)
 
time_t ecl_util_make_date (int mday, int month, int year)
 
time_t ecl_util_make_date__ (int mday, int month, int year, int *year_offset)
 
ert_ecl_unit_enum ecl_util_get_unit_set (const char *data_file)
 
bool ecl_util_valid_basename_fmt (const char *basename_fmt)
 
bool ecl_util_valid_basename (const char *basename)
 
const char * ecl_util_get_phase_name (ecl_phase_enum phase)
 
int ecl_util_select_filelist (const char *path, const char *base, ecl_file_enum file_type, bool fmt_file, stringlist_type *filelist)
 
void ecl_util_append_month_range (time_t_vector_type *date_list, time_t start_date, time_t end_date, bool force_append_end)
 
void ecl_util_init_month_range (time_t_vector_type *date_list, time_t start_date, time_t end_date)
 
void ecl_util_set_date_values (time_t t, int *mday, int *month, int *year)
 
bool ecl_util_path_access (const char *ecl_case)
 

Macro Definition Documentation

◆ ECL_BOOL_FALSE_INT

#define ECL_BOOL_FALSE_INT   0

◆ ECL_BOOL_TRUE_INT

#define ECL_BOOL_TRUE_INT   -1

◆ ECL_COMMENT_CHAR

#define ECL_COMMENT_CHAR   '-'

◆ ECL_COMMENT_STRING

#define ECL_COMMENT_STRING   "--"

◆ ECL_DATA_TERMINATION

#define ECL_DATA_TERMINATION   "/"

◆ ECL_PHASE_ENUM_DEFS

#define ECL_PHASE_ENUM_DEFS   {.value = 1 , .name = "ECL_OIL_PHASE"}, {.value = 2 , .name = "ECL_GAS_PHASE"} , {.value = 4 , .name = "ECL_WATER_PHASE"}

◆ ECL_PHASE_ENUM_SIZE

#define ECL_PHASE_ENUM_SIZE   3

Enumeration Type Documentation

◆ ecl_file_enum

Enumerator
ECL_OTHER_FILE 
ECL_RESTART_FILE 
ECL_UNIFIED_RESTART_FILE 
ECL_SUMMARY_FILE 
ECL_UNIFIED_SUMMARY_FILE 
ECL_SUMMARY_HEADER_FILE 
ECL_GRID_FILE 
ECL_EGRID_FILE 
ECL_INIT_FILE 
ECL_RFT_FILE 
ECL_DATA_FILE 

◆ ecl_phase_enum

Enumerator
ECL_OIL_PHASE 
ECL_GAS_PHASE 
ECL_WATER_PHASE 

◆ ecl_storage_enum

Enumerator
ECL_INVALID_STORAGE 
ECL_BINARY_UNIFIED 
ECL_FORMATTED_UNIFIED 
ECL_BINARY_NON_UNIFIED 
ECL_FORMATTED_NON_UNIFIED 

◆ ecl_version_enum

Enumerator
ECLIPSE_UNDEFINED 
ECLIPSE100 
ECLIPSE300 
ECLIPSE300_THERMAL 
INTERSECT 
FRONTSIM 

◆ ert_ecl_unit_enum

Enumerator
ECL_METRIC_UNITS 
ECL_FIELD_UNITS 
ECL_LAB_UNITS 
ECL_PVT_M_UNITS 

Function Documentation

◆ ecl_util_alloc_base_guess()

char * ecl_util_alloc_base_guess ( const char *  )

◆ ecl_util_alloc_exfilename()

char * ecl_util_alloc_exfilename ( const char *  ,
const char *  ,
ecl_file_enum  ,
bool  ,
int   
)

◆ ecl_util_alloc_exfilename_anyfmt()

char * ecl_util_alloc_exfilename_anyfmt ( const char *  path,
const char *  base,
ecl_file_enum  file_type,
bool  start_fmt,
int  report_nr 
)

◆ ecl_util_alloc_filename()

char * ecl_util_alloc_filename ( const char *  ,
const char *  ,
ecl_file_enum  ,
bool  ,
int   
)

◆ ecl_util_alloc_restart_files()

void ecl_util_alloc_restart_files ( const char *  ,
const char *  ,
char ***  ,
int *  ,
bool ,
bool  
)

◆ ecl_util_alloc_summary_data_files()

void ecl_util_alloc_summary_data_files ( const char *  path,
const char *  base,
bool  fmt_file,
stringlist_type filelist 
)

◆ ecl_util_alloc_summary_files()

bool ecl_util_alloc_summary_files ( const char *  ,
const char *  ,
const char *  ,
char **  ,
stringlist_type  
)

◆ ecl_util_append_month_range()

void ecl_util_append_month_range ( time_t_vector_type *  date_list,
time_t  start_date,
time_t  end_date,
bool  force_append_end 
)

◆ ecl_util_escape_kw()

void ecl_util_escape_kw ( char *  kw)

◆ ecl_util_file_type_name()

const char * ecl_util_file_type_name ( ecl_file_enum  file_type)

◆ ecl_util_filename_report_nr()

int ecl_util_filename_report_nr ( const char *  )

◆ ecl_util_fmt_file()

bool ecl_util_fmt_file ( const char *  filename,
bool __fmt_file 
)

◆ ecl_util_fname_report_cmp()

int ecl_util_fname_report_cmp ( const void *  f1,
const void *  f2 
)

◆ ecl_util_get_file_type()

ecl_file_enum ecl_util_get_file_type ( const char *  filename,
bool fmt_file,
int *  report_nr 
)

◆ ecl_util_get_month_nr()

int ecl_util_get_month_nr ( const char *  month_name)

◆ ecl_util_get_num_cpu()

int ecl_util_get_num_cpu ( const char *  data_file)

◆ ecl_util_get_phase_name()

const char * ecl_util_get_phase_name ( ecl_phase_enum  phase)

◆ ecl_util_get_start_date()

time_t ecl_util_get_start_date ( const char *  )

◆ ecl_util_get_unit_set()

ert_ecl_unit_enum ecl_util_get_unit_set ( const char *  data_file)

◆ ecl_util_init_month_range()

void ecl_util_init_month_range ( time_t_vector_type *  date_list,
time_t  start_date,
time_t  end_date 
)

◆ ecl_util_inspect_extension()

ecl_file_enum ecl_util_inspect_extension ( const char *  ext,
bool _fmt_file,
int *  _report_nr 
)

◆ ecl_util_make_date()

time_t ecl_util_make_date ( int  mday,
int  month,
int  year 
)

◆ ecl_util_make_date__()

time_t ecl_util_make_date__ ( int  mday,
int  month,
int  year,
int *  year_offset 
)

◆ ecl_util_memcpy_typed_data()

void ecl_util_memcpy_typed_data ( void *  ,
const void *  ,
ecl_data_type  ,
ecl_data_type  ,
int   
)

◆ ecl_util_path_access()

bool ecl_util_path_access ( const char *  ecl_case)

◆ ecl_util_select_filelist()

int ecl_util_select_filelist ( const char *  path,
const char *  base,
ecl_file_enum  file_type,
bool  fmt_file,
stringlist_type filelist 
)

◆ ecl_util_set_date_values()

void ecl_util_set_date_values ( time_t  t,
int *  mday,
int *  month,
int *  year 
)

◆ ecl_util_unified_file()

bool ecl_util_unified_file ( const char *  filename)

◆ ecl_util_valid_basename()

bool ecl_util_valid_basename ( const char *  basename)

◆ ecl_util_valid_basename_fmt()

bool ecl_util_valid_basename_fmt ( const char *  basename_fmt)