lid.h File Reference

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "infil.h"

Include dependency graph for lid.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	TSurfaceLayer
struct	TPavementLayer
struct	TSoilLayer
struct	TStorageLayer
struct	TDrainLayer
struct	TDrainMatLayer
struct	TLidProc
struct	TWaterBalance
struct	TLidRptFile
struct	TLidUnit

Macros
#define	MAX_LAYERS   4

Enumerations
enum	LidTypes {   BIO_CELL ,   RAIN_GARDEN ,   GREEN_ROOF ,   INFIL_TRENCH ,   POROUS_PAVEMENT ,   RAIN_BARREL ,   VEG_SWALE ,   ROOF_DISCON }
enum	TimePeriod {   PREVIOUS ,   CURRENT }

Functions
void	lid_create (int lidCount, int subcatchCount)
void	lid_delete (void)
int	lid_readProcParams (char *tok[], int ntoks)
int	lid_readGroupParams (char *tok[], int ntoks)
int	lid_setDrainParams (int lidIndex, double coeff, double expon, double offset)
void	lid_validate (void)
void	lid_initState (void)
void	lid_setOldGroupState (int subcatch)
double	lid_getPervArea (int subcatch)
double	lid_getFlowToPerv (int subcatch)
double	lid_getDrainFlow (int subcatch, int timePeriod)
double	lid_getStoredVolume (int subcatch)
void	lid_addDrainLoads (int subcatch, double c[], double tStep)
void	lid_addDrainRunon (int subcatch)
void	lid_addDrainInflow (int subcatch, double f)
void	lid_getRunoff (int subcatch, double tStep)
void	lid_writeSummary (void)
void	lid_writeWaterBalance (void)
void	lidproc_initWaterBalance (TLidUnit *lidUnit, double initVol)
double	lidproc_getOutflow (TLidUnit *lidUnit, TLidProc *lidProc, double inflow, double evap, double infil, double maxInfil, double tStep, double *lidEvap, double *lidInfil, double *lidDrain)
void	lidproc_saveResults (TLidUnit *lidUnit, double ucfRainfall, double ucfRainDepth)

Macro Definition Documentation

MAX_LAYERS

#define MAX_LAYERS   4

Enumeration Type Documentation

LidTypes

enum LidTypes

Enumerator
BIO_CELL
RAIN_GARDEN
GREEN_ROOF
INFIL_TRENCH
POROUS_PAVEMENT
RAIN_BARREL
VEG_SWALE
ROOF_DISCON

TimePeriod

enum TimePeriod

Enumerator
PREVIOUS
CURRENT

Function Documentation

lid_addDrainInflow()

void lid_addDrainInflow	(	int	subcatch,
		double	f )

Here is the call graph for this function:

lid_addDrainLoads()

void lid_addDrainLoads	(	int	subcatch,
		double	c[],
		double	tStep )

Here is the call graph for this function:

Here is the caller graph for this function:

lid_addDrainRunon()

void lid_addDrainRunon

(

int

subcatch

)

Here is the call graph for this function:

Here is the caller graph for this function:

lid_create()

void lid_create	(	int	lidCount,
		int	subcatchCount )

lid_delete()

void lid_delete

(

void

)

lid_getDrainFlow()

double lid_getDrainFlow	(	int	subcatch,
		int	timePeriod )

Here is the caller graph for this function:

lid_getFlowToPerv()

double lid_getFlowToPerv

(

int

subcatch

)

Here is the caller graph for this function:

lid_getPervArea()

double lid_getPervArea

(

int

subcatch

)

Here is the caller graph for this function:

lid_getRunoff()

void lid_getRunoff	(	int	subcatch,
		double	tStep )

Here is the call graph for this function:

Here is the caller graph for this function:

lid_getStoredVolume()

double lid_getStoredVolume

(

int

subcatch

)

Here is the caller graph for this function:

lid_initState()

void lid_initState

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

lid_readGroupParams()

int lid_readGroupParams	(	char *	tok[],
		int	ntoks )

Here is the call graph for this function:

lid_readProcParams()

int lid_readProcParams	(	char *	tok[],
		int	ntoks )

Here is the call graph for this function:

lid_setDrainParams()

int lid_setDrainParams	(	int	lidIndex,
		double	coeff,
		double	expon,
		double	offset )

Here is the call graph for this function:

lid_setOldGroupState()

void lid_setOldGroupState

(

int

subcatch

)

Here is the caller graph for this function:

lid_validate()

void lid_validate

(

void

)

Here is the caller graph for this function:

lid_writeSummary()

void lid_writeSummary

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

lid_writeWaterBalance()

void lid_writeWaterBalance

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

lidproc_getOutflow()

double lidproc_getOutflow	(	TLidUnit *	lidUnit,
		TLidProc *	lidProc,
		double	inflow,
		double	evap,
		double	infil,
		double	maxInfil,
		double	tStep,
		double *	lidEvap,
		double *	lidInfil,
		double *	lidDrain )

For debugging only ******************************************** if (i == 0) { fprintf(Frpt.file, "\n WARNING 09: integration failed to converge at %s %s", theDate, theTime); fprintf(Frpt.file, "\n for LID %s placed in subcatchment %s.", theLidProc->ID, theSubcatch->ID); }

Here is the call graph for this function:

lidproc_initWaterBalance()

void lidproc_initWaterBalance	(	TLidUnit *	lidUnit,
		double	initVol )

Here is the caller graph for this function:

lidproc_saveResults()

void lidproc_saveResults	(	TLidUnit *	lidUnit,
		double	ucfRainfall,
		double	ucfRainDepth )

Here is the call graph for this function: