infil.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//   infil.h
//
//   Project: EPA SWMM5
//   Version: 5.2
//   Date:    11/01/21 (Build 5.2.0)
//   Author:  L. Rossman
//
//   Public interface for infiltration functions.
//
//   Update History
//   ==============
//   Build 5.1.010:
//   - New Modified Green Ampt infiltration option added.
//   Build 5.1.013:
//   - New function infil_setInfilFactor() added.
//   Build 5.1.015:
//   - Support added for multiple infiltration methods within a project.
//-----------------------------------------------------------------------------

 
#ifndef INFIL_H
#define INFIL_H
 
//---------------------
// Enumerated Constants
//---------------------
enum InfilType {
    HORTON,         // Horton infiltration
    MOD_HORTON,     // Modified Horton infiltration
    GREEN_AMPT,     // Green-Ampt infiltration
    MOD_GREEN_AMPT, // Modified Green-Ampt infiltration
    CURVE_NUMBER
}; // SCS Curve Number infiltration
 
//---------------------
// Horton Infiltration
//---------------------
typedef struct {
    double f0;    // initial infil. rate (ft/sec)
    double fmin;  // minimum infil. rate (ft/sec)
    double Fmax;  // maximum total infiltration (ft);
    double decay; // decay coeff. of infil. rate (1/sec)
    double regen; // regeneration coeff. of infil. rate (1/sec)
    //-----------------------------
    double tp;  // present time on infiltration curve (sec)
    double Fe;  // cumulative infiltration (ft)
    double Fmh; // mod Horton cumulative infiltration (ft)   //(5.2.5)
} THorton;
 
//-------------------------
// Green-Ampt Infiltration
//-------------------------
typedef struct {
    double S;      // avg. capillary suction (ft)
    double Ks;     // saturated conductivity (ft/sec)
    double IMDmax; // max. soil moisture deficit (ft/ft)
    //-----------------------------
    double IMD; // current initial soil moisture deficit
    double F;   // current cumulative infiltrated volume (ft)
    double Fu;  // current upper zone infiltrated volume (ft)
    double Lu;  // depth of upper soil zone (ft)
    double T;   // time until start of next rain event (sec)
    char Sat;   // saturation flag
} TGrnAmpt;
 
//--------------------------
// Curve Number Infiltration
//--------------------------
typedef struct {
    double Smax;  // max. infiltration capacity (ft)
    double regen; // infil. capacity regeneration constant (1/sec)
    double Tmax;  // maximum inter-event time (sec)
    //-----------------------------
    double S;  // current infiltration capacity (ft)
    double F;  // current cumulative infiltration (ft)
    double P;  // current cumulative precipitation (ft)
    double T;  // current inter-event time (sec)
    double Se; // current event infiltration capacity (ft)
    double f;  // previous infiltration rate (ft/sec)
 
} TCurveNum;
 
//-----------------------------------------------------------------------------
//   Exported Variables
//-----------------------------------------------------------------------------
extern THorton* HortInfil;
extern TGrnAmpt* GAInfil;
extern TCurveNum* CNInfil;
 
//-----------------------------------------------------------------------------
//   Infiltration Methods
//-----------------------------------------------------------------------------
void infil_create(int n);
void infil_delete(void);
int infil_readParams(int m, char* tok[], int ntoks);
void infil_initState(int j);
void infil_getState(int j, double x[]);
void infil_setState(int j, double x[]);
void infil_setInfilFactor(int j);
double infil_getInfil(int area, double tstep, double rainfall, double runon, double depth);
 
void grnampt_getParams(int j, double p[]);
int grnampt_setParams(TGrnAmpt* infil, double p[]);
void grnampt_initState(TGrnAmpt* infil);
double grnampt_getInfil(TGrnAmpt* infil, double tstep, double irate, double depth, int modelType);
 
#endif