Kinematic wave routing method for overland erosion and deposition 更多...

class  KinWavSed_OL
 Kinematic wave method for overland flow erosion and deposition 更多...
 

详细描述

Kinematic wave routing method for overland erosion and deposition

作者
Hui Wu
日期
Feb. 2012 \revised LiangJun Zhu \revised date May. 2016

Kinematic wave method for overland flow erosion and deposition


类说明

◆ KinWavSed_OL

class KinWavSed_OL

Kinematic wave method for overland flow erosion and deposition

类 KinWavSed_OL 继承关系图:
SimulationModule ccgl::Interface

Public 成员函数

virtual int Execute (void)
 Execute the simulation. Return 0 for success.
 
virtual void SetValue (const char *key, float value)
 Set data, DT_Single, float point number (float or double)
 
virtual void Set1DData (const char *key, int n, float *data)
 Set 1D data, by default, DT_Raster1D, float
 
virtual void Get1DData (const char *key, int *n, float **data)
 Get 1D data, by default, DT_Raster1D, float
 
virtual void Set2DData (const char *key, int nrows, int ncols, float **data)
 Set 2D data, by default, DT_Raster2D, float
 
bool CheckInputData (void)
 check the input data. 更多...
 
bool CheckInputSize (const char *, int)
 check the input size. 更多...
 
- Public 成员函数 继承自 SimulationModule
 SimulationModule ()
 Constructor
 
virtual void SetDate (time_t t, int year_idx)
 Set date time, as well as the sequence number of the entire simulation. Added by LJ for statistics convenient.
 
virtual void SetTheadNumber (const int thread_num)
 Set thread number for OpenMP
 
virtual void SetClimateDataType (int data_type)
 Set climate data type, P, M, PET etc.
 
virtual void SetValue (const char *key, int value)
 Set data, DT_Single, integer
 
virtual void SetValueByIndex (const char *key, int index, int value)
 Set single value to array1D by index, used in MPI version for passing values of subbasins, integer
 
virtual void SetValueByIndex (const char *key, int index, FLTPT value)
 Set single value to array1D by index, used in MPI version for passing values of subbasins, float
 
virtual void Set1DData (const char *key, int n, int *data)
 Set 1D data, by default, DT_Raster1D, integer
 
virtual void Set2DData (const char *key, int nrows, int ncols, int **data)
 Set 2D data, by default, DT_Raster2D, integer
 
virtual void GetValue (const char *key, int *value)
 Get value, DT_Single, integer
 
virtual void GetValue (const char *key, FLTPT *value)
 Get value, DT_Single, float
 
virtual void Get1DData (const char *key, int *n, int **data)
 Get 1D data, by default, DT_Raster1D, integer
 
virtual void Get2DData (const char *key, int *nrows, int *ncols, int ***data)
 Get 2D data, by default, DT_Raster2D, integer
 
virtual void Get2DData (const char *key, int *nrows, int *ncols, FLTPT ***data)
 Get 2D data, by default, DT_Raster2D, float
 
virtual void SetScenario (Scenario *sce)
 Set pointer of Scenario class which contains all BMP information. Added by LJ, 2016-6-14
 
virtual void SetReaches (clsReaches *rches)
 Set pointer of clsReaches class which contains all reaches information. Added by LJ, 2016-7-2
 
virtual void SetSubbasins (clsSubbasins *subbsns)
 Set pointer of clsSubbasins class which contains all subbasins information. Added by LJ, 2016-7-28
 
virtual bool CheckInputSize (const char *module_id, const char *key, int nrows, int &m_nrows)
 Check data length of the first dimension (i.e., nRows) of the input array-based data 更多...
 
virtual bool CheckInputSize2D (const char *module_id, const char *key, int nrows, int ncols, int &m_nrows, int &m_ncols)
 Check data length of the two dimensions (i.e., nRows and nCols) of the input array-based data 更多...
 
virtual void InitialOutputs ()
 Initialize output variables. 更多...
 
virtual void InitialIntermediates ()
 Initialize intermediate parameters for reducing computing amount. 更多...
 
virtual TimeStepType GetTimeStepType ()
 Get time step type, default is hillslope process. 更多...
 
virtual void ResetSubTimeStep ()
 Reset subtime step
 
bool IsInputsSetDone ()
 Whether the inputs (i.e., inputs derived from other modules) have been set.
 
void SetInputsDone (const bool set_done)
 Change the status of setting inputs parameters
 
void SetReCalIntermediates (const bool recal)
 set whether intermediate parameters need to recalculated
 

额外继承的成员函数

- Protected 属性 继承自 SimulationModule
time_t m_date
 date time
 
int m_yearIdx
 index of current year of simulation, e.g., the simulation period from 2010 to 2015, m_yearIdx is 2 when simulate 2012.
 
int m_year
 year
 
int m_month
 month since January - [1,12]
 
int m_day
 day of the month - [1,31]
 
int m_dayOfYear
 day of year - [1, 366]
 
int m_tsCounter
 sub-timestep counter
 
bool m_inputsSetDone
 Whether the inputs parameters (i.e., parameters derived from other modules) have been set.
 
bool m_reCalIntermediates
 need to recalculate intermediate parameters?
 

成员函数说明

◆ CheckInputData()

bool KinWavSed_OL::CheckInputData ( void  )
virtual

check the input data.

Make sure all the input data is available.

返回
bool The validity of the input data.

重载 SimulationModule .

◆ CheckInputSize()

bool KinWavSed_OL::CheckInputSize ( const char *  ,
int   
)

check the input size.

Make sure all the input data have same dimension.

参数
keyThe key of the input data
nThe input data dimension
返回
bool The validity of the dimension