Flumy [Free API]
Process based model for meandering chanelized systems
FlumyAPI.hpp
1 #pragma once
2 
3 #include "flumy_export.hpp"
4 
5 class iDomain;
6 class iSimulator;
7 
36 class FLUMY_EXPORT Flumy {
37 public:
46  Flumy(int nx, int ny, double mesh, bool verbose = false);
47  virtual ~Flumy();
48 
67  bool launch(int seed, double hmax, int isbx, double ng, double zul = -1.,
68  int niter = -1, bool lvb = true);
74  const iDomain* getDomain() const;
75 
77  int getAge() const;
79  double getAggradationRate() const;
81  double getMigrationRate() const;
85  double getSinuosity() const;
87  double getTortuosity() const;
89  double getWavelength() const;
91  double getSandBodyExtension() const;
93  int getNbCutoff() const;
94 
95 private:
96  Flumy(const Flumy &flumy) = delete;
97  Flumy &operator=(const Flumy &) = delete;
98 
99 private:
100  iSimulator* _simu;
101 };
Top level entry point of the Flumy "Lite" API (Free)
Definition: FlumyAPI.hpp:36
double getSandBodyExtension() const
Return the current channel observed mean sandbodies extension (m)
double getMeanVelocityPerturbation() const
Return the observed mean velocity perturbation among all meanders (m)
double getTortuosity() const
Return the current channel observed tortuosity.
Flumy(int nx, int ny, double mesh, bool verbose=false)
Create a Flumy simulator given the output grid parameters.
double getMigrationRate() const
Return the observed channel lateral migration rate (m/it)
double getSinuosity() const
Return the current channel observed sinuosity (formula from Allen, 1983)
int getNbCutoff() const
Return the number of meander cutoffs occured since the simulation begining.
int getAge() const
Return the last age of the simulation (number of iterations since the begining)
bool launch(int seed, double hmax, int isbx, double ng, double zul=-1., int niter=-1, bool lvb=true)
Launch a non conditional Flumy simulation.
double getWavelength() const
Return the current channel observed wave length (m)
virtual ~Flumy()
const iDomain * getDomain() const
Get the Domain object in order to access to simulated deposits.
double getAggradationRate() const
Return the observed aggradation rate (m/it)
Interface class used to access Domain informations.
Definition: iDomain.hpp:68