Skip to content

Commit

Permalink
Add comments to function parameters in SWE.h
Browse files Browse the repository at this point in the history
  • Loading branch information
echoix committed Dec 30, 2023
1 parent b596a54 commit a5fd00f
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions src/raster/r.damflood/SWE.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,20 @@ and method=3
returns void
*/

void shallow_water(
double **m_h1, double **m_u1,
double **m_v1, /* water depth and velocities of the i step*/
float **m_z, /* DTM */
float **m_DAMBREAK, /* DTM changes (e.g. DTM) */
float **m_m, /* manning coefficient */
int **m_lake, /* lake filter, default>0, if equal to 0 --> do not apply
swe!!!*/
double **m_h2, double **m_u2,
double **m_v2, /* water depth and velocities of the i+1 step*/
int row, int col, int nrows, int ncols, /* matrix size*/
float timestep, /* timestep (normally optimized with another function) */
float res_ew, float res_ns, /* grid resolutions*/
int method, /* default = 3, various hypothesis*/
int num_cell, int num_break, /* number of cell of lake only in case of
method 1 or 2, elsewhere 0*/
double t); /* computational instant */
double **m_h1, /* water depth of the i step */
double **m_u1, double **m_v1, /* water velocities of the i step */
float **m_z, /* DTM */
float **m_DAMBREAK, /* DTM changes (e.g. DTM) */
float **m_m, /* manning coefficient */
int **m_lake, // lake filter, default>0, if equal to 0 --> do not apply swe!
double **m_h2, /* water depth of the i+1 step */
double **m_u2, double **m_v2, /* water velocities of the i+1 step */
int row, int col, int nrows, int ncols, /* matrix size */
float timestep, /* timestep (normally optimized with another function) */
float res_ew, float res_ns, /* grid resolutions */
int method, /* default = 3, various hypothesis */
int num_cell, int num_break, /* number of cells of lake only in case of
method 1 or 2, elsewhere 0 */
double t /* computational instant */
);

0 comments on commit a5fd00f

Please sign in to comment.