GridReal.hpp

#ifndef GRID_REAL_HH
#define GRID_REAL_HH
 
#include "MCRCProgramming.hpp"
#include "flumy_export.hpp"
 
#include "GridParams.hpp"
 
class iTracer;
 
enum GridFileFormat {
  GFF_ERROR     = -1,
  GFF_F2G       =  0,
  GFF_GSLIB     =  1,
  GFF_CPS3      =  2,
  GFF_UNDEFINED =  3
};
 
class FLUMY_EXPORT GridReal : public GridParams {
 
public :
 
  GridReal();
  GridReal(const MP_real & dx,
           const MP_real & dy,
           const MP_int  & nx,
           const MP_int  & ny,
           const MP_real & ox  = 0.,
           const MP_real & oy  = 0.,
           const MP_real & val = MP_UNKNOWN_REAL_VALUE);
  GridReal(const MP_real & dx,
           const MP_real & dy,
           const MP_real & dz,
           const MP_int  & nx,
           const MP_int  & ny,
           const MP_int  & nz,
           const MP_real & ox  = 0.,
           const MP_real & oy  = 0.,
           const MP_real & oz  = 0.,
           const MP_real & val = MP_UNKNOWN_REAL_VALUE);
  GridReal(const std::vector<std::vector<MP_real> >& values);
  GridReal(const GridParams& grid);
  GridReal(const GridParams& grid, const MP_real & val);
  GridReal(const GridReal& grid);
  virtual ~GridReal() {}
  GridReal& operator= (const GridReal& gridc);
  virtual void reset(const GridParams & grid) override;
  virtual void reset(const MP_real & dx,
                     const MP_real & dy,
                     const MP_int  & nx,
                     const MP_int  & ny,
                     const MP_real & ox  = 0.,
                     const MP_real & oy  = 0.,
                     const MP_real & val = MP_UNKNOWN_REAL_VALUE);
  virtual void reset(const MP_real & dx,
                     const MP_real & dy,
                     const MP_real & dz,
                     const MP_int  & nx,
                     const MP_int  & ny,
                     const MP_int  & nz,
                     const MP_real & ox  = 0.,
                     const MP_real & oy  = 0.,
                     const MP_real & oz  = 0.,
                     const MP_real & val = MP_UNKNOWN_REAL_VALUE);
  virtual bool check(MP_real & val, bool correct = true) const;
  virtual void fill(const MP_real & val);
  virtual void fill_2D(const std::vector<std::vector<MP_real> >& values);
  virtual void fill_yxz(const MP_int size, const MP_real values[]);
  virtual void fill_zyx(const MP_int size, const MP_real values[]);
  virtual bool get_at(MP_int& size, MP_real values[]) const;
  virtual bool set_at(const MP_int & ix, const MP_int & iy, const MP_real & val);
  virtual bool set_at(const MP_int & ix, const MP_int & iy, const MP_int & iz, const MP_real & val);
  virtual bool get_at(const MP_int & ix, const MP_int & iy, MP_real & val) const;
  virtual bool get_at(const MP_int & ix, const MP_int & iy, RealList & val) const;
  virtual bool get_at(const MP_int & ix, const MP_int & iy, const MP_int & iz, MP_real & val) const;
  virtual bool write(const MP_string& filename,
                     const iTracer* tracer,
                     const GridFileFormat& format = GFF_F2G,
                     const MP_string& order = MP_DEFAULT_CELLS_ORDER) const;
  virtual bool read(const MP_string& filename);
  const RealList& get_values() const { return _values; }
  RealList get_values_zyx() const;
  MP_real get_mean() const;
  MP_real get_min() const { return _min; }
  MP_real get_max() const { return _max; }
  MP_real get_min(MP_int& ix, MP_int& iy) const;
  MP_real get_max(MP_int& ix, MP_int& iy) const;
  MP_int  get_nb_positive() const;
  MP_int  get_nb_negative() const;
  bool add_variable(GridReal* aux);
  void set_name(const MP_string& name) { _name = name; }
  const MP_string& get_name() const { return _name; }
  void set_undef_string(const MP_string& undef) { _undef_string = undef; }
  const MP_string& get_undef_string() const { return _undef_string; }
  void set_undef_value(const MP_real undef) { _undef_value = undef; }
  const MP_real& get_undef_value() const { return _undef_value; }
  static bool is_order_valid(const MP_string& order);
  static bool is_order_valid(const MP_string& order,
                             MP_string& order1,
                             MP_string& order2,
                             MP_string& order3);
  static bool is_order_valid(const MP_string& order1,
                             const MP_string& order2,
                             const MP_string& order3);
  static GridFileFormat get_format(const MP_string& filename);
  static MP_string get_format_label(const GridFileFormat& format);
  const MP_string& last_error() const { return _last_error; }
 
protected :
  RealList _values;
  MP_real _min;
  MP_real _max;
  MP_int _ixmin;
  MP_int _iymin;
  MP_int _ixmax;
  MP_int _iymax;
  std::vector<GridReal*> _aux;
  MP_string _name;
  MP_string _undef_string;
  MP_real _undef_value;
  mutable MP_string _last_error;
 
  bool write_gslib(const MP_string& filename,
                   const iTracer* tracer) const;
  bool write_ascii(const MP_string& filename,
                   const iTracer* tracer) const;
  bool write_f2g(const MP_string& filename,
                 const iTracer* tracer,
                 const MP_string& order = MP_DEFAULT_CELLS_ORDER) const;
  bool write_values(std::ofstream & os,
                    const iTracer* tracer,
                    const MP_string& order = MP_DEFAULT_CELLS_ORDER) const;
  bool read_cps3(const MP_string& filename);
  bool read_gslib(const MP_string& filename);
  bool read_ascii(const MP_string& filename);
  bool read_f2g(const MP_string& filename);
};
 
#endif /* GRID_REAL_HH */