ResInsight/ThirdParty/Ert/lib/ecl/well_segment_collection.cpp

/*
   Copyright (C) 2013  Equinor ASA, Norway.

   The file 'well_segment_collection.c' 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.
*/

#include <stdbool.h>

#include <vector>

#include <ert/util/util.h>
#include <ert/util/vector.hpp>

#include <ert/ecl/ecl_kw.hpp>
#include <ert/ecl/ecl_rsthead.hpp>

#include <ert/ecl_well/well_const.hpp>
#include <ert/ecl_well/well_segment.hpp>
#include <ert/ecl_well/well_conn.hpp>
#include <ert/ecl_well/well_segment_collection.hpp>
#include <ert/ecl_well/well_conn_collection.hpp>
#include <ert/ecl_well/well_branch_collection.hpp>


struct well_segment_collection_struct {
  std::vector<int> segment_index_map;
  std::vector<well_segment_type*> __segment_storage;
};



well_segment_collection_type * well_segment_collection_alloc(void) {
  well_segment_collection_type * segment_collection = new well_segment_collection_type();
  return segment_collection;
}



void well_segment_collection_free(well_segment_collection_type * segment_collection ) {
  for (int i = 0; i < static_cast<int>(segment_collection->__segment_storage.size()); i++)
    well_segment_free( segment_collection->__segment_storage[i] );
  delete segment_collection;
}



int well_segment_collection_get_size( const well_segment_collection_type * segment_collection ) {
  return segment_collection->__segment_storage.size();
}


void well_segment_collection_add( well_segment_collection_type * segment_collection , well_segment_type * segment) {
  int segment_id = well_segment_get_id( segment );
  int current_index = -1;
  if (segment_id < static_cast<int>(segment_collection->segment_index_map.size()))
    current_index = segment_collection->segment_index_map[segment_id];
  if (current_index >= 0) {
    well_segment_free( segment_collection->__segment_storage[current_index] );
    segment_collection->__segment_storage[current_index] = segment;
  }
  else {
    int new_index = segment_collection->__segment_storage.size();
    segment_collection->__segment_storage.push_back( segment );
    if ( segment_id >= static_cast<int>(segment_collection->segment_index_map.size()) )
      segment_collection->segment_index_map.resize(segment_id+1, -1);
    segment_collection->segment_index_map[segment_id] = new_index;
  }
}



well_segment_type * well_segment_collection_iget( const well_segment_collection_type * segment_collection , int index) {
  return segment_collection->__segment_storage[ index ];
}


well_segment_type * well_segment_collection_get( const well_segment_collection_type * segment_collection , int segment_id) {
  int internal_index = -1;
  if (segment_id < static_cast<int>(segment_collection->segment_index_map.size()))
    internal_index = segment_collection->segment_index_map[segment_id];
  if (internal_index >= 0)
    return well_segment_collection_iget( segment_collection , internal_index );
  else
    return NULL;
}


bool  well_segment_collection_has_segment( const well_segment_collection_type * segment_collection , int segment_id) {
  int internal_index = -1;
  if (segment_id < static_cast<int>(segment_collection->segment_index_map.size()))
    internal_index = segment_collection->segment_index_map[segment_id];
  if (internal_index >= 0)
    return true;
  else
    return false;
}



int well_segment_collection_load_from_kw( well_segment_collection_type * segment_collection , int well_nr ,
                                          const ecl_kw_type * iwel_kw ,
                                          const ecl_kw_type * iseg_kw ,
                                          const well_rseg_loader_type * rseg_loader ,
                                          const ecl_rsthead_type * rst_head ,
                                          bool load_segments , bool * is_MSW_well) {

  int iwel_offset = rst_head->niwelz * well_nr;
  int segment_well_nr = ecl_kw_iget_int( iwel_kw , iwel_offset + IWEL_SEGMENTED_WELL_NR_INDEX) - 1;
  int segments_added = 0;

  if (segment_well_nr != IWEL_SEGMENTED_WELL_NR_NORMAL_VALUE) {
    int segment_index;
    *is_MSW_well = true;

    if (load_segments) {
      for (segment_index = 0; segment_index < rst_head->nsegmx; segment_index++) {
        int segment_id = segment_index + WELL_SEGMENT_OFFSET;
        well_segment_type * segment = well_segment_alloc_from_kw( iseg_kw , rseg_loader , rst_head , segment_well_nr , segment_index , segment_id );

        if (well_segment_active( segment )) {
          well_segment_collection_add( segment_collection , segment );
          segments_added++;
        } else
          well_segment_free( segment );
      }
    }
  }
  return segments_added;
}


void well_segment_collection_link(const  well_segment_collection_type * segment_collection) {
  size_t index;
  for (index = 0; index < segment_collection->__segment_storage.size(); index++) {
    well_segment_type * segment = well_segment_collection_iget( segment_collection , index );
    int outlet_segment_id = well_segment_get_outlet_id( segment );
    if (!well_segment_nearest_wellhead(segment)) {
      well_segment_type * target_segment = well_segment_collection_get( segment_collection , outlet_segment_id );
      well_segment_link( segment , target_segment );
    }
  }
}



void well_segment_collection_add_connections(well_segment_collection_type * segment_collection ,
                                             const char * grid_name ,
                                             const well_conn_collection_type * connections) {
  int iconn;
  for (iconn = 0; iconn < well_conn_collection_get_size( connections ); iconn++) {
    well_conn_type * conn = well_conn_collection_iget( connections , iconn );
    if (well_conn_MSW( conn )) {
      int segment_id =  well_conn_get_segment_id( conn );
      well_segment_type * segment = well_segment_collection_get( segment_collection , segment_id );
      well_segment_add_connection( segment , grid_name , conn );
    }
  }
}



void well_segment_collection_add_branches( const well_segment_collection_type * segment_collection ,
                                           well_branch_collection_type * branches ) {
  int iseg;
  for (iseg =0; iseg < well_segment_collection_get_size( segment_collection ); iseg++) {
    well_segment_type * segment = well_segment_collection_iget( segment_collection , iseg );
    if (well_segment_get_link_count( segment ) == 0)
      well_branch_collection_add_start_segment( branches , segment );
  }
}