inflow.c File Reference

External, dry-weather, and interface inflow calculations. More...

#include <stdlib.h>
#include <string.h>
#include "headers.h"

Include dependency graph for inflow.c:

Macros
#define	_CRT_SECURE_NO_DEPRECATE

Functions
double	getPatternFactor (int p, int month, int day, int hour)
	Computes time pattern multiplier for a specific point in time.
int	inflow_readExtInflow (char *tok[], int ntoks)
	Reads parameters of a direct external inflow from a line of input.
int	inflow_setExtInflow (int nodeIndex, int param, int type, int tseries, int basePat, double cf, double baseline, double sf)
	This function assigns property values to the inflow object.
void	inflow_deleteExtInflows (int nodeIndex)
	Deletes all time series inflow data for a node.
double	inflow_getExtInflow (TExtInflow *inflow, DateTime aDate)
	Retrieves the value of an external inflow at a specific date and time.
int	inflow_readDwfInflow (char *tok[], int ntoks)
	Reads dry weather inflow parameters from line of input data.
void	inflow_deleteDwfInflows (int nodeIndex)
	Free every dry-weather inflow record owned by a node.
void	inflow_initDwfInflow (TDwfInflow *inflow)
	Initialzes a dry weather inflow by ordering its time patterns.
double	inflow_getDwfInflow (TDwfInflow *inflow, int month, int day, int hour)
	Computes dry weather inflow value at a specific point in time.
void	inflow_initDwfPattern (int patternIndex)
	Initialzes a dry weather inflow time pattern.
int	inflow_readDwfPattern (char *tok[], int ntoks)
	Reads values of a time pattern from a line of input data.

Detailed Description

External, dry-weather, and interface inflow calculations.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com (OpenSWMM maintenance and extensions)

Copyright

Copyright (c) 2026 Caleb Buahin. OpenSWMM contributions only; original EPA SWMM credits are retained.

License

Apache-2.0 for OpenSWMM contributions; original EPA SWMM provenance is retained.

Macro Definition Documentation

_CRT_SECURE_NO_DEPRECATE

#define _CRT_SECURE_NO_DEPRECATE

Function Documentation

getPatternFactor()

double getPatternFactor	(	int	p,
		int	month,
		int	day,
		int	hour )

Computes time pattern multiplier for a specific point in time.

Parameters

[in]	p	Time pattern index.
[in]	month	Current month of year of simulation.
[in]	day	Current day of week of simulation.
[in]	hour	Current hour of day of simulation.

Returns

Value of a time pattern multiplier.

Here is the caller graph for this function: