MCRCProgramming.hpp

#ifndef MCRC_PROGRAMMING_HH
#define MCRC_PROGRAMMING_HH
 
#ifdef _WINDOWS
// Disable warning messages 4351
#pragma warning( disable : 4351 )
#endif
 
// Export Macro
#include "flumy_export.hpp"
 
#include <list>
#include <string>
#include <vector>
#include <map>
#include <new>
 
#include <iomanip>
#include <algorithm>
#include <exception>
 
#include <iostream>
#include <fstream>
#include <sstream>
#include <cstring>
#include <cmath>
 
#include "MCRCDefines.h"
 
// Type definitions
typedef double           MP_real;             
typedef int              MP_int;              
typedef unsigned int     MP_uint;             
typedef unsigned char    MP_uchar;            
typedef bool             MP_bool;             
typedef std::string      MP_string;           
typedef MP_int           MP_tseed;            
typedef MP_uint          MP_age;              
typedef MP_uchar         MP_color;            
typedef MP_uchar         MP_stut;             
typedef MP_uchar         MP_agut;             
 
typedef std::vector<MP_stut>   FaciesList; 
typedef std::vector<MP_age>    AgeList;    
typedef std::vector<MP_real>   RealList;   
typedef std::vector<MP_int>    IntList;    
typedef std::vector<MP_string> StringList; 
 
// For facies storage
#define MP_FAMILY_MASK         0xf     
#define MP_GRANULO_OFFSET        4     
#define MP_STUT_SIZE             8     
#define MP_AGUT_SIZE             8     
 
#define UNUSED(x) (void)(x)
 
// Initial value for some parameters
#define MP_INIT_AGE                   0             
#define MP_INIT_SEED                  DEF_SIM_SEED  
#define MP_INIT_FREQ                  FREQ_NEVER    
#define MP_INIT_PERIOD_VAL            100           
#define MP_INIT_POISSON_VAL           100           
#define MP_INIT_DIST                  DIST_CONSTANT 
#define MP_INIT_CONST                 0.            
#define MP_INIT_MIN                   0.            
#define MP_INIT_MAX                   1.            
#define MP_INIT_NORM_MEAN             0.            
#define MP_INIT_NORM_STDEV            1.            
#define MP_INIT_LOGNORM_MEAN          0.            
#define MP_INIT_LOGNORM_STDEV         1.            
 
// Scour and secondary current factors
#define MP_CHANNEL_A_AFF              4.                                    
#define MP_CHANNEL_A_SEC              3.                                    
#define MP_CHANNEL_A                  (MP_CHANNEL_A_AFF + MP_CHANNEL_A_SEC) 
 
// Flow heights
#define MP_FLU_EFF_TO_MAX_HFLOW     1.5          
#define MP_TUR_EFF_TO_MAX_HFLOW       3.         
#define MP_FLU_HMAX_TO_MAX_HFLOW      1.         
#define MP_TUR_HMAX_TO_MAX_HFLOW      3.         
 
// Universal constants
#define MP_PI                         3.14159265             
#define MP_2PI                        2*MP_PI                
#define MP_G                          9.81                   
#define MP_YEAR_SECONDS               31557600               
#define MP_PARAB_MEAN_TO_MAX_FACTOR   1.5                    
#define MP_PARAB_MAX_TO_MEAN_FACTOR   1/1.5                  
 
// Flow and sediment constants
#define MP_DENSITY_SED                2.65                                   
#define MP_R                          (MP_DENSITY_SED - 1)                   
#define MP_VISCO                      0.000001                               
#define MP_K                          0.4                                    
#define MP_FRICTION_COEFF_SKIN        0.005                                  
#define MP_FRICTION_COEFF_SKIN_SQRT   sqrt(MP_FRICTION_COEFF_SKIN)           
#define MP_Z0                         0.01                                   
#define MP_KSI                        (0.077 / MP_FRICTION_COEFF_SKIN_SQRT)  
#define MP_TURBI_SCALE_FACTOR         14.                                    
#define MP_LOC_SLOPE_ALPHA            3.                                     
 
// Turbidite velocity profile constants
// MP_VEL_TURB_POW currently not well calibrated. May be related to mud proportion : the muddier the higher (Stacey et al 88) 
#define MP_VEL_TURB_POW               0.8                                                                        
#define MP_POWER_FACTOR               pow(2, MP_VEL_TURB_POW)                                                    
#define MP_INTEGRAL                   (MP_POWER_FACTOR / sqrt(MP_PI) * tgamma(alpha + 0.5) / tgamma(alpha + 1))  
 
// Miscellaneous Fluvial constants
#define MP_FLU_D2W_FACTOR     15.      
#define MP_FLU_W2WL_FACTOR    12.5     
#define MP_FLU_W2LOB_FACTOR   30.      
#define MP_FLU_SINUO          2.71     
#define MP_FLU_SINUO_ALLEN    1.5      
#define MP_FLU_KOB            0.6      
#define MP_FLU_KMIG /*DON'T*/ 0.65     
#define MP_FLU_KMIG_OLD       0.75     
#define MP_FLU_KVP            0.87     
#define MP_FLU_TAU_CUT        2.53e-9  
 
// Miscellaneous Turbidites constants
#define MP_TUR_D2W_FACTOR     30.      
#define MP_TUR_W2WL_FACTOR    5.0      
#define MP_TUR_W2LOB_FACTOR   10.      
#define MP_TUR_SINUO          2.05     
#define MP_TUR_SINUO_ALLEN    1.5      
#define MP_TUR_KOB            1.25     
#define MP_TUR_KMIG /*DON'T*/ 0.4      
#define MP_TUR_KMIG_OLD       0.95     
#define MP_TUR_KVP            0.75     
#define MP_TUR_TAU_CUT        4.85e-9  
 
// Computing constants
#define MP_MIN_SLOPE_WARN             0.0005                 
#define MP_MAX_SLOPE_WARN             0.016                  
#define MP_PEAT_COMPRESS_FACTOR       0.1                    
#define MP_DEFAULT_MIG_WELL_FACTOR    15                     
#define MP_UNDEFINED_ZUL              MP_UNKNOWN_INT_VALUE   
#define MP_DEFAULT_ZUL_TOL            0                      
#define MP_THICKNESS_RATIO            0.01                   
#define MP_INACTIVE_EP                100000.                
#define MP_MAX_CS_CHANNEL             13                     
#define MP_MAX_MEANDER_DEFAULT_VALUES 4                      
#define MP_MAX_NB_NODES               25000000               
#define MP_MAX_NB_NODES_WARN          1000000                
#define MP_ERR_MAX_WELLS              100                    
#define MP_WARN_MAX_WELLS             55                     
#define MP_MAX_GRID_SIZE              5000                   
#define MP_ZOOM_TIFF                  1                      
#define MP_REFRESH_LOOP               100                    
#define MP_DEFAULT_CELLS_ORDER        "+Y +X +Z"             
#define MP_DEFAULT_GSLIB_CELLS_ORDER  "+X +Y +Z"             
#define MP_DEFAULT_NA_VALUE           "NA"                   
 
// Constant definitions for Random Number (RN) generation
#define MP_RN_DEFAULT_SEED     MP_INIT_SEED     
#define MP_RN_DEFAULT_MODULUS    2147483647     
#define MP_RN_DEFAULT_MULTIPLIER      16807     
#define MP_RN_DEFAULT_QUOTIENT       127773     
#define MP_RN_DEFAULT_REST             2836     
#define MP_RN_SHUFFLING_TABLE_SIZE       32     
 
// System parameters
#define MP_EPSILON                         0.000001    
#define MP_UNKNOWN_STRING_VALUE                "??"    
#define MP_UNKNOWN_REAL_VALUE                 1.e30    
#define MP_MAX_REAL_VALUE                     1.e30    
#define MP_MIN_REAL_VALUE                    -1.e30    
#define MP_UNKNOWN_INT_VALUE             2147483647    
#define MP_MAX_INT_VALUE                 2147483647    
#define MP_MIN_INT_VALUE                -2147483647    
 
 
class FLUMY_EXPORT InferenceStats {
public:
  MP_age  age;         
  MP_real pb_prop;     
  MP_real sand_prop;   
  MP_real agg_rate;    
  MP_real mig_rate;    
  MP_real mean_vp;     
  MP_real infer_kob;   
  MP_real infer_kmig;  
  MP_real infer_kvp;   
  MP_real sinuo;       
  MP_real tortuo;      
  MP_real sinuo_allen; 
  MP_real sbext;       
  MP_real wl;          
  InferenceStats() : age(0),
                     pb_prop(0.),
                     sand_prop(0.),
                     agg_rate(0.),
                     mig_rate(0.),
                     mean_vp(0.),
                     infer_kob(0.),
                     infer_kmig(0.),
                     infer_kvp(0.),
                     sinuo(0.),
                     tortuo(0.),
                     sinuo_allen(0.),
                     sbext(0.),
                     wl(0.) {}
} ;
 
class FLUMY_EXPORT TauCutStats {
public:
  MP_age  age;          
  MP_real tau_cut;      
  MP_real sinuo;        
  MP_real sinuo_allen;  
  MP_real tortuo;       
  MP_real wavelength;   
  MP_real mean_sbext;   
  TauCutStats() : age(0),
                  tau_cut(0.),
                  sinuo(0.),
                  sinuo_allen(0.),
                  tortuo(0.),
                  wavelength(0.),
                  mean_sbext(0.) {}
};
 
// Usual Functions
#undef MIN
#define MIN(x,y)   (( (x) > (y) ) ? (y) : (x))  
#undef MAX
#define MAX(x,y)   (( (x) < (y) ) ? (y) : (x))  
#undef ABS
#define ABS(a)     ((a) >= 0 ? (a) : -(a))      
 
// Portability
#ifdef _WINDOWS
#define round(x) ((MP_real)((x)>=0?(MP_int)((x)+0.5):(MP_int)((x)-0.5)))  
#ifdef  assert
#undef  assert
#define assert(x) TRACE_ASSERT(x)  
#endif
#endif
 
// Iterator declaration (Y must inherits or be a typedef from std::vector<Z>)
#define DECLARE_ITERATOR(X,Y,Z) \
  class FLUMY_EXPORT X { \
    public : \
      X() : _val() {} ; \
      X( const X & ci ) : _val( ci._val ) {} ; \
      X( const Y::const_iterator & ci ) : _val( ci ) {} ; \
      X& operator=( const X & ci ) {if (*this != ci) _val = ci._val; return(*this);} \
      bool operator<( const X & ci ) const {return(_val<ci._val);} \
      bool operator>( const X & ci ) const {return(_val>ci._val);} \
      bool operator<=( const X & ci ) const {return(_val<=ci._val);} \
      bool operator>=( const X & ci ) const {return(_val>=ci._val);} \
      bool operator==( const X & ci ) const {return(_val==ci._val);} \
      bool operator!=( const X & ci ) const {return(_val!=ci._val);} \
      X& operator++() {++_val;return(*this);} \
      X& operator--() {--_val;return(*this);} \
      const Z& operator*() const { return( *_val ); } \
      const Z* operator->() const { return( &(*_val) ); } \
    private : \
      Y::const_iterator _val ; \
  }; \
 
// Reverse Iterator declaration (Y must inherits or be a typedef from std::vector<Z>)
#define DECLARE_REVERSE_ITERATOR(X,Y,Z) \
  class FLUMY_EXPORT X { \
    public : \
      X() : _val() {} ; \
      X( const X & ci ) : _val( ci._val ) {} ; \
      X( const Y::const_reverse_iterator & ci ) : _val( ci ) {} ; \
      X& operator=( const X & ci ) {if (*this != ci) _val = ci._val; return(*this);} \
      bool operator<( const X & ci ) const {return(_val<ci._val);} \
      bool operator>( const X & ci ) const {return(_val>ci._val);} \
      bool operator<=( const X & ci ) const {return(_val<=ci._val);} \
      bool operator>=( const X & ci ) const {return(_val>=ci._val);} \
      bool operator==( const X & ci ) const {return(_val==ci._val);} \
      bool operator!=( const X & ci ) const {return(_val!=ci._val);} \
      X& operator++() {++_val;return(*this);} \
      X& operator--() {--_val;return(*this);} \
      const Z& operator*() const { return( *_val ); } \
      const Z* operator->() const { return( &(*_val) ); } \
    private : \
      Y::const_reverse_iterator _val ; \
  }; \
 
#define SPACES " \t\r\n"
 
inline MP_string trim_right (const MP_string & s,
                             const MP_string & t = SPACES)
{
  MP_string d (s);
  MP_string::size_type i (d.find_last_not_of (t));
  if (i == MP_string::npos)
    return "";
  else
    return d.erase (d.find_last_not_of (t) + 1) ;
}
 
inline MP_string trim_left (const MP_string & s,
                            const MP_string & t = SPACES)
{
  MP_string d (s);
  return d.erase (0, s.find_first_not_of (t)) ;
}
 
inline MP_string trim_all (const MP_string & s,
                           const MP_string & t = SPACES)
{
  MP_string d (s);
  return trim_left (trim_right (d, t), t) ;
}
 
#endif // MCRC_PROGRAMMING_HH