wells.h

Go to the documentation of this file.

/*
  Copyright 2012 SINTEF ICT, Applied Mathematics.

  This file is part of the Open Porous Media project (OPM).

  OPM 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.

  OPM 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 for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef OPM_WELLS_H_INCLUDED
#define OPM_WELLS_H_INCLUDED

#include <stdbool.h>
#include <opm/core/well_controls.h>

#ifdef __cplusplus
extern "C" {
#endif

enum WellType {
    INJECTOR,  
    PRODUCER   
};


struct Wells
{
    int number_of_wells;  
    int number_of_phases; 
    enum WellType *type;

    double *depth_ref;

    double *comp_frac;

    int *well_connpos;

    int *well_cells;

    double *WI;


    struct WellControls **ctrls;

    char **name;

    int *allow_cf;

    void *data;

};


struct CompletionData
{
    double *wdp;

    double *A;

    double *phasemob;
};

struct Wells *
create_wells(int nphases, int nwells, int nperf);


int
add_well(enum WellType  type     ,
         double         depth_ref,
         int            nperf    ,
         const double  *comp_frac,
         const int     *cells    ,
         const double  *WI       ,
         const char    *name     ,
         int            allow_cf ,
         struct Wells  *W        );


int
append_well_controls(enum WellControlType type  ,
                     double               target,
                     double               alq,
                     int                  vfp,
                     const double        *distr,
                     int                  well_index,
                     struct Wells        *W);


void
set_current_control(int well_index, int current_control, struct Wells *W);


void
clear_well_controls(int well_index, struct Wells *W);


void
destroy_wells(struct Wells *W);


struct Wells *
clone_wells(const struct Wells *W);


bool
wells_equal(const struct Wells *W1, const struct Wells *W2 , bool verbose);


#ifdef __cplusplus
}
#endif

#endif /* OPM_WELLS_H_INCLUDED */