ecl_smspec.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2011  Equinor ASA, Norway.
 
   The file 'ecl_smspec.h' is part of ERT - Ensemble based Reservoir Tool.
 
   ERT is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   ERT is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.
 
   See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
   for more details.
*/
 
#ifndef ERT_ECL_SMSPEC
#define ERT_ECL_SMSPEC
 
 
#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>
 
typedef struct ecl_smspec_struct ecl_smspec_type;
 
#ifdef __cplusplus
#include <vector>
const std::vector<float>& ecl_smspec_get_params_default( const ecl_smspec_type * ecl_smspec );
const ecl::smspec_node&  ecl_smspec_get_well_var_node( const ecl_smspec_type * smspec , const char * well , const char * var);
const ecl::smspec_node& ecl_smspec_get_group_var_node( const ecl_smspec_type * smspec , const char * group , const char * var);
const ecl::smspec_node& ecl_smspec_get_field_var_node( const ecl_smspec_type * smspec , const char * var);
const ecl::smspec_node& ecl_smspec_get_region_var_node(const ecl_smspec_type * ecl_smspec , const char *region_var , int region_nr);
const ecl::smspec_node& ecl_smspec_get_misc_var_node(const ecl_smspec_type * ecl_smspec , const char *var);
const ecl::smspec_node& ecl_smspec_get_block_var_node(const ecl_smspec_type * ecl_smspec , const char * block_var , int block_nr);
const ecl::smspec_node& ecl_smspec_get_block_var_node_ijk(const ecl_smspec_type * ecl_smspec , const char * block_var , int i , int j , int k);
const ecl::smspec_node& ecl_smspec_get_well_completion_var_node(const ecl_smspec_type * ecl_smspec , const char * well , const char *var, int cell_nr);
const ecl::smspec_node& ecl_smspec_get_general_var_node( const ecl_smspec_type * smspec , const char * lookup_kw );
const ecl::smspec_node& ecl_smspec_iget_node_w_node_index( const ecl_smspec_type * smspec , int node_index );
const ecl::smspec_node& ecl_smspec_iget_node_w_params_index( const ecl_smspec_type * smspec , int params_index );
const ecl::smspec_node& ecl_smspec_iget_node(const ecl_smspec_type * smspec, int index);
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
  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);
 
 
  //bool                ecl_smspec_general_is_total(const ecl_smspec_type * ecl_smspec , const char * gen_key);
  //bool                ecl_smspec_is_rate(const ecl_smspec_type * smspec , int kw_index);
  //ecl_smspec_var_type ecl_smspec_iget_var_type( const ecl_smspec_type * smspec , int index );
  //const char *        ecl_smspec_iget_unit( const ecl_smspec_type * smspec , int index );
  //int                 ecl_smspec_iget_num( const ecl_smspec_type * smspec , int index );
  //const char *        ecl_smspec_iget_wgname( const ecl_smspec_type * smspec , int index );
  //const char *        ecl_smspec_iget_keyword( const ecl_smspec_type * smspec , int index );
 
 
 
 
  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);
 
  // void                       ecl_smspec_sort( ecl_smspec_type * smspec );
  ert_ecl_unit_enum          ecl_smspec_get_unit_system(const ecl_smspec_type * smspec);
 
 
#ifdef __cplusplus
}
#endif
 
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, const char * keyword, 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);
 
 
 
 
#endif