iDomain.hpp

#ifndef I_DOMAIN_HH
#define I_DOMAIN_HH
 
#include "MCRCProgramming.hpp"
#include "flumy_export.hpp"
 
#include "GridParams.hpp"
#include "Point2D.hpp"
#include "DepositUnit.hpp"
#include "WellStat.hpp"
 
#ifndef SWIG
#include "CenterlineDisc.hpp"
#endif
 
class iChannel;
class Topo;
 
class FLUMY_EXPORT iDomain {
 
public:
  iDomain() {}
  virtual ~iDomain() {}
  virtual MP_real    getSlope()       const = 0;
  virtual MP_real    getSlopeAlongX() const = 0;
  virtual MP_real    getSlopeAlongY() const = 0;
  virtual MP_real    getZrefGeo()     const = 0;
  virtual MP_real    getRotGridGeo()  const = 0;
  virtual MP_real    getRotFlowGeo()  const = 0;
  virtual Point2D    getOriginGeo()   const = 0;
  virtual MP_real    getErodMax()     const = 0;
  virtual MP_age     getOldestAge()   const = 0;
  virtual MP_real    getZMaxGeo()     const = 0;
  virtual MP_real    getZMinGeo()    const = 0;
  virtual MP_real    getZMaxRel()     const = 0;
  virtual MP_real    getZMinRel()     const = 0;
  virtual MP_real    getMeshX()       const = 0;
  virtual MP_real    getMeshY()       const = 0;
  virtual MP_int     getNbNodeX()     const = 0;
  virtual MP_int     getNbNodeY()     const = 0;
  virtual GridParams getGrid()        const = 0;
 
  virtual MP_real getMinTopo(bool with_water_depth=true)  const = 0;
  virtual MP_real getMaxTopo(bool with_water_depth=true)  const = 0;
  virtual MP_real getMeanTopo(bool with_water_depth=true) const = 0;
 
  virtual MP_real getProportionFull(MP_stut fac,
                                    MP_real zmin=MP_UNKNOWN_REAL_VALUE,
                                    MP_real zmax=MP_UNKNOWN_REAL_VALUE) const = 0;
  virtual MP_real getProportion(MP_stut fac,
                                MP_int ix_min, MP_int ix_max,
                                MP_int iy_min, MP_int iy_max,
                                MP_real zmin=MP_UNKNOWN_REAL_VALUE,
                                MP_real zmax=MP_UNKNOWN_REAL_VALUE) const = 0;
 
  virtual Point2D getGeoPointFromGrid(const MP_int& ix, const MP_int& iy) const = 0;
  virtual Point2D getGeoPointFromRel(const Point2D& relPoint)            const = 0;
  virtual Point2D getRelPointFromGeo(const Point2D& geoPoint)            const = 0;
 
  virtual Point2D getRelPointFromGrid(const MP_int& ix, const MP_int& iy) const = 0;
  virtual Point2D getGridPointFromRel(const Point2D& relPoint)    const = 0;
  virtual Point2D getGridPointFromGeo(const Point2D& geoPoint)    const = 0;
 
  virtual bool isValid(const MP_int& ix, const MP_int& iy) const = 0;
 
  virtual RealList       getAllThickness()      const = 0;
  virtual FaciesList     getAllFacies()         const = 0;
  virtual RealList       getAllGrainsize()      const = 0;
  virtual IntList        getAllGrainsizeClass() const = 0;
  virtual AgeList        getAllAge()            const = 0;
 
  virtual DepositsList getDeposits(MP_int ix, MP_int iy) const = 0;
 
  virtual bool getIrregular(MP_int ix, MP_int iy, DepositsList* list) const = 0;
 
  virtual bool getRegularPile (MP_int ix, MP_int iy,
                               MP_real zStep,
                               FaciesList* facies,
                               AgeList* ages = NULL,
                               RealList* granulo = NULL,
                               MP_real* zBot = NULL,
                               MP_int* nbSample = NULL) const = 0;
 
  virtual bool getRegular (MP_int ix_min, MP_int ix_max,
                           MP_int iy_min, MP_int iy_max,
                           MP_real zStep,
                           FaciesList* facies,
                           AgeList* ages = NULL,
                           RealList* granulo = NULL,
                           MP_real* zBot = NULL,
                           MP_int* nbSample = NULL) const = 0;
 
  virtual FaciesList getRegularFacies (MP_real zStep,
                                       MP_real zBot,
                                       MP_int nbSample) const = 0;
 
  virtual RealList getRegularGrain (MP_real zStep,
                                    MP_real zBot,
                                    MP_int nbSample) const = 0;
 
  virtual AgeList getRegularAge (MP_real zStep,
                                 MP_real zBot,
                                 MP_int nbSample) const = 0;
 
  virtual bool getTopo(Topo& topo,
                       bool with_water = true,
                       MP_age age_limit = MP_UNKNOWN_INT_VALUE) const = 0;
 
  virtual bool saveF2G(const MP_string & filename, MP_real dz,
                       bool save_facies, bool save_grain, bool save_age,
                       MP_real min_z = MP_UNKNOWN_REAL_VALUE,
                       MP_real max_z = MP_UNKNOWN_REAL_VALUE,
                       const MP_string& order = MP_DEFAULT_CELLS_ORDER) const = 0;
 
  virtual std::vector<WellStat> getCondStats() const = 0;
 
  virtual bool getCenterlineDisc(CenterlineDisc& cldisc, const iChannel* ch) const = 0;
};
 
#endif /* I_DOMAIN_HH */