epyt-flow 0.14.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

epyt_flow/EPANET/EPANET-MSX/Src/msxdispersion.c

@@ -1,586 +0,0 @@
-/******************************************************************************
-**  MODULE:        MSXDISPERSION.C
-**  PROJECT:       EPANET-MSX
-**  DESCRIPTION:   Dispersion solver for Lagrangian ADR
-******************************************************************************/
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <math.h>
-#include <omp.h>
-
-#include "msxtypes.h"
-#include "dispersion.h"
-#include "smatrix.h"
-
-#define ERRCODE(x) (errcode = ((errcode>100) ? (errcode) : (x)))
-//  External variables
-//--------------------
-extern MSXproject  MSX;                // MSX project data
-
-static double* al;                         //vector helping solve tridaigonal system of eqns.
-static double* bl;                         //vector helping solve tridaigonal system of eqns.
-static double* cl;                         //vector helping solve tridaigonal system of eqns.
-static double* rl;                         //vector helping solve tridaigonal system of eqns.
-static double* sol;                        //vector helping solve tridaigonal system of eqns.
-
-static double* gam;
-
-#pragma omp threadprivate(al, bl, cl, rl, sol, gam)
-
-int dispersion_open()
-{
-	int errcode=0;
-#pragma omp parallel
-	{
-		al = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		bl = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		cl = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		rl = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		sol = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		gam = (double*)calloc(MSX.MaxSegments + 2, sizeof(double));
-		#pragma omp critical
-		{
-			ERRCODE(MEMCHECK(al));
-			ERRCODE(MEMCHECK(bl));
-			ERRCODE(MEMCHECK(cl));
-			ERRCODE(MEMCHECK(rl));
-			ERRCODE(MEMCHECK(sol));
-			ERRCODE(MEMCHECK(gam));	
-		}
-	}
-	return errcode;
-
-}
-
-int dispersion_close()
-{
-	int errcode = 0;
-#pragma omp parallel
-	{
-		FREE(al);
-		FREE(bl);
-		FREE(cl);
-		FREE(rl);
-		FREE(sol);
-		FREE(gam);
-	}
-	return errcode;
-}
-
-void dispersion_pipe(int m, double tstep)
-{
-
-	double cons = 0.0;
-	double ldispersion = 0.0;
-	double flowrate = 0.0, velocity = 0.0, area = 0.0;
-	int nseg = 0, k;
-	double diam = 0.0;
-	double vd = 0.0, vu = 0.0, vself = 0.0, asquare = 0.0, dh = 0.0, frictionfactor = 0.0;
-	double reynolds=0, shearvelocity=0;
-	Pseg seg = NULL;
-
-	double elpt = 0.0;
-	double d0 = 1.292e-8;   //molecular diffusivity 1.292e-8 ft^2/s   1.2e-9 m^2/s
-	
-	d0 = MSX.Dispersion.md[m];
-	#pragma omp parallel
-	{
-		#pragma omp for private(seg, cons, vd, vu, vself, k, nseg, asquare, velocity, diam, area, flowrate, reynolds, dh, frictionfactor, shearvelocity, ldispersion, elpt)
-		for (k = 1; k <= MSX.Nobjects[LINK]; k++)
-		{
-			
-			velocity = 0;
-			if (MSX.FirstSeg[k] == NULL)
-				continue;
-			diam = MSX.Link[k].diam;
-			// Compute Reynolds No.
-			flowrate = (MSX.S[k] <= CLOSED) ? 0.0 : MSX.Q[k];
-			area = PI * diam * diam / 4.0;         // pipe area
-			if (area > 0.0 && MSX.Link[k].len > 0.0 && ABS(flowrate) > 0.0)
-			{
-				velocity = fabs(flowrate) / area;              // flow velocity
-				reynolds = velocity * diam / MSX.Dispersion.viscosity;     // Reynolds number  //#define   VISCOS    1.1E-5     // Kinematic viscosity of water // @ 20 deg C (sq ft/sec)
-				dh = ABS(MSX.H[MSX.Link[k].n1] - MSX.H[MSX.Link[k].n2]);
-				if (dh > 0.00001)
-					frictionfactor = 39.725 * dh * pow(diam, 5) / (MSX.Link[k].len * SQR(flowrate));
-				else
-					frictionfactor = 0.0;
-				shearvelocity = velocity * sqrt(frictionfactor / 8);
-
-				if (d0 < 0)
-				{
-					ldispersion = MSX.Dispersion.ld[m];
-				}
-				else if (reynolds > 2300) //Basha 2007
-				{
-					ldispersion = 0.5 * diam * shearvelocity * (10.1 + 577 * pow(reynolds / 1000.0, -2.2));
-
-				}
-	/*			else   //Basha 2007
-				{
-					ldispersion = SQR(0.5 * diam * velocity) / (48 * d0);
-					elpt = MSX.Link[k].len / velocity;
-					ldispersion = ldispersion * (1 - exp(-12.425 * d0 * elpt / SQR(0.5 * diam)));
-					ldispersion += d0;
-				}*/
-				else  //Lee 2004 averaged
-				{ 
-					ldispersion = SQR(0.5 * diam * velocity) / (48 * d0);
-					elpt = MSX.Link[k].len / velocity;
-					double interv = 16.0 * d0 * elpt / (0.25 * diam * diam);
-					ldispersion = ldispersion * (1 - (1 - exp(-interv))/interv);
-					ldispersion += d0;
-
-				}
-			
-			}
-			else
-			{
-				ldispersion = 0;
-			}
-
-			if (ldispersion < 0.0)
-			{
-				ldispersion = 0;
-				MSX.Dispersion.pipeDispersionCoeff[k] = 0;
-				continue;
-			}
-
-			double domi;
-
-			if (velocity > 0)
-				domi = ldispersion / (velocity * velocity * tstep);
-			else
-				domi = 1000;
-			if (domi >= 0.000 && MSX.Link[k].len*velocity/ldispersion < MSX.Dispersion.PecletLimit)  //Peclet numer
-			{
-				MSX.Dispersion.pipeDispersionCoeff[k] = ldispersion;
-			}
-			else
-			{
-				MSX.Dispersion.pipeDispersionCoeff[k] = 0;
-				continue;
-			}
-			asquare = area * area;
-			seg = MSX.FirstSeg[k];   //downstream
-			cons = 2.0 * ldispersion * asquare * tstep;
-			vd = 0.0;
-			bl[0] = 1.0;
-			cl[0] = 0.0;
-			rl[0] = 0.0;
-			nseg = 0;
-
-			while (seg != NULL)
-			{
-				nseg++;
-				vself = seg->v;
-				rl[nseg] = seg->c[m];
-				seg = seg->prev;
-				if (seg)
-					vu = seg->v;
-				else
-					vu = 0.0;
-				al[nseg] = -cons / (vself * vself + vself * vd);
-				cl[nseg] = -cons / (vself * vself + vself * vu);
-				bl[nseg] = 1 - al[nseg] - cl[nseg];
-
-				vd = vself;
-			}
-			if (nseg == 0)
-				continue;
-		
-
-			al[nseg + 1] = 0.0;
-			bl[nseg + 1] = 1.0;
-			rl[nseg + 1] = 0.0;
-
-			if (reynolds >= 0)
-				tridiag(nseg + 2, al, bl, cl, rl, sol); //nseg+2 <= 1000 here 
-			else
-			{
-				for (int p = 0; p <= nseg + 1; p++)
-					sol[p] = rl[p];
-			}
-
-			seg = MSX.FirstSeg[k];   //downstream segment
-			int segindex = 1;
-			while (seg != NULL)
-			{
-				seg->hresponse = sol[segindex];
-				seg = seg->prev;
-				segindex++;
-			}
-			/*clear initial condition*/
-			for (int p = 1; p < nseg + 1; p++)
-				rl[p] = 0.0;
-
-			/*downstream unit boundary condition*/
-			rl[0] = 1.0;
-			if (reynolds >= 0)
-				tridiag(nseg + 2, al, bl, cl, rl, sol);
-			else
-			{
-				for (int p = 0; p <= nseg + 1; p++)
-					sol[p] = rl[p];
-			}
-
-			seg = MSX.FirstSeg[k];   //downstream
-			segindex = 1;
-			while (seg != NULL)
-			{
-				seg->dresponse = sol[segindex];
-				seg = seg->prev;
-				segindex++;
-			}
-
-			/*upstream unit boundary condition*/
-			rl[0] = 0.0;
-			rl[nseg + 1] = 1.0;
-			if (reynolds >= 0)
-				tridiag(nseg + 2, al, bl, cl, rl, sol); //nseg+2 <= 100 here 
-			else
-			{
-				for (int p = 0; p <= nseg + 1; p++)
-					sol[p] = rl[p];
-			}
-
-			seg = MSX.FirstSeg[k];   //downstream
-			segindex = 1;
-			while (seg != NULL)
-			{
-				seg->uresponse = sol[segindex];
-				seg = seg->prev;
-				segindex++;
-			}
-		}
-	}
-}
-
-void solve_nodequal(int m, double tstep)
-{
-
-	Pseg firstseg;
-	Pseg lastseg;
-	Psource source;
-	int n1, n2;
-	double diam, area, asquare;
-
-	//	double dispersion =  147.25;
-	double ldispersion;
-	double coelastseg, coefirstseg;
-
-	int njuncs = MSX.Nobjects[NODE] - MSX.Nobjects[TANK];
-	int found = 0;
-
-
-	//let's take a look of the matrix
-
-	memset(MSX.Dispersion.Aii, 0, (MSX.Nobjects[NODE] + 1) * sizeof(double));
-	memset(MSX.Dispersion.Aij, 0, (MSX.Dispersion.Ncoeffs + 1) * sizeof(double));
-	memset(MSX.Dispersion.F, 0, (MSX.Nobjects[NODE] + 1) * sizeof(double));
-	for (int k = 1; k <= MSX.Nobjects[LINK]; k++)
-	{
-		ldispersion = MSX.Dispersion.pipeDispersionCoeff[k];
-		if (ldispersion <= 0)
-			continue;
-		n1 = MSX.Link[k].n1;  //upstream
-		n2 = MSX.Link[k].n2;  //downstream
-		if (MSX.FlowDir[k] < 0)
-		{
-			n1 = MSX.Link[k].n2;  //upstream
-			n2 = MSX.Link[k].n1;  //downstream
-		}
-		diam = MSX.Link[k].diam;
-		area = 0.25 * PI * diam * diam;
-		asquare = area * area;
-		firstseg = MSX.FirstSeg[k];   //downstream
-		lastseg =  MSX.LastSeg[k];		//upstream	
-
-
-		if (firstseg == NULL)
-			continue;
-
-		coefirstseg = ldispersion * asquare / firstseg->v;   //dispersion should be pipe by pipe
-		coelastseg = ldispersion * asquare / lastseg->v;   //dispersion should be pipe by pipe
-		MSX.Dispersion.Aij[MSX.Dispersion.Ndx[k]] -= coefirstseg * firstseg->uresponse; //coefirstseg*firstseg->greenu = coelastseg*lastseg->greend 
-
-		found = 0;
-		source = MSX.Node[n2].sources;
-		while(source != NULL)
-		{
-			if (source->species == m)
-			{
-				found = 1;
-				break;
-			}
-			else
-				source = source->next;
-		}
-		
-		if (n2 <= njuncs)
-		{
-			if (source == NULL || source->c0 <= 0.0)
-			{
-				MSX.Dispersion.Aii[MSX.Dispersion.Row[n2]] += coefirstseg * (1.0 - firstseg->dresponse);
-
-				MSX.Dispersion.F[MSX.Dispersion.Row[n2]] += coefirstseg * firstseg->hresponse;
-			}
-			else
-			{
-				MSX.Dispersion.Aij[MSX.Dispersion.Ndx[k]] = 0;
-				MSX.Dispersion.F[MSX.Dispersion.Row[n1]] += coelastseg * MSX.LastSeg[k]->dresponse * MSX.Node[n2].c[m];
-			}
-		}
-		else
-		{
-			MSX.Dispersion.F[MSX.Dispersion.Row[n1]] += coelastseg * MSX.LastSeg[k]->dresponse * MSX.Node[n2].c[m];
-		}
-
-			
-		found = 0;
-		source = MSX.Node[n1].sources;
-		while (source != NULL)
-		{
-			if (source->species == m)
-			{
-				found = 1;
-				break;
-			}
-			else
-				source = source->next;
-		}
-
-		if (n1 <= njuncs)
-		{
-			source = MSX.Node[n1].sources;
-			if (source == NULL || source->c0 <= 0.0)
-			{
-				MSX.Dispersion.Aii[MSX.Dispersion.Row[n1]] += coelastseg * (1.0 - lastseg->uresponse);
-				MSX.Dispersion.F[MSX.Dispersion.Row[n1]] += coelastseg * lastseg->hresponse;
-			}
-			else
-			{
-				MSX.Dispersion.Aij[MSX.Dispersion.Ndx[k]] = 0;   //sure
-				MSX.Dispersion.F[MSX.Dispersion.Row[n2]] += coefirstseg * firstseg->uresponse * MSX.Node[n1].c[m];
-			}
-
-		}
-		else
-		{
-			MSX.Dispersion.F[MSX.Dispersion.Row[n2]] += coefirstseg * firstseg->uresponse * MSX.Node[n1].c[m];
-		}
-	}
-	for (int i = 1; i <= njuncs; i++)
-	{
-		if (MSX.Dispersion.Aii[MSX.Dispersion.Row[i]] == 0.0)		//no dispersion around the junction at all
-		{
-			MSX.Dispersion.Aii[MSX.Dispersion.Row[i]] = 1.0;
-
-			MSX.Dispersion.F[MSX.Dispersion.Row[i]] = 1.0 * MSX.Node[i].c[m];
-		}
-	}
-
-	int errcode = msx_linsolve(njuncs, MSX.Dispersion.Aii, MSX.Dispersion.Aij, MSX.Dispersion.F);
-
-	for (int i = 1; i <= njuncs; i++)
-	{
-		MSX.Node[i].c[m] = MSX.Dispersion.F[MSX.Dispersion.Row[i]];
-	}
-
-}
-
-
-void   segqual_update(int m, double tstep)
-{
-
-	Pseg seg = NULL;
-	Psource source = NULL;
-	int n1 = 0, n2 = 0, k;
-	double mass1 = 0;
-	double mass2 = 0;
-	double dispersedin = 0;
-	double ldispersion = 0, massin = 0;
-	double area = 0.0;
-	int njuncs = MSX.Nobjects[NODE] - MSX.Nobjects[TANK];
-#pragma omp parallel
-	{
-		#pragma omp for private(k, n1, n2, seg, source, mass1, mass2, ldispersion, massin, area)
-		for (k = 1; k <= MSX.Nobjects[LINK]; k++)
-		{
-			mass1 = 0;
-			mass2 = 0;
-			ldispersion = MSX.Dispersion.pipeDispersionCoeff[k];
-			if (ldispersion <= 0.0)
-				continue;
-			area = 0.25 * PI * MSX.Link[k].diam * MSX.Link[k].diam;
-			n1 = MSX.Link[k].n1;
-			n2 = MSX.Link[k].n2;
-			if (MSX.FlowDir[k] < 0.0)
-			{
-				n1 = MSX.Link[k].n2;
-				n2 = MSX.Link[k].n1;
-			}
-			seg = MSX.FirstSeg[k];
-			while (seg != NULL)   //update segment concentration based on new up/down node quality
-			{
-				mass1 += seg->c[m] * seg->v;
-				seg->c[m] = seg->hresponse + MSX.Node[n2].c[m] * seg->dresponse + MSX.Node[n1].c[m] * seg->uresponse;
-
-				mass2 += seg->c[m] * seg->v;
-				seg = seg->prev;
-			}
-			if (MSX.FirstSeg[k] == NULL)
-				continue;
-
-			source = MSX.Node[n2].sources;
-			while (source != NULL)
-			{
-				if (source->species == m)
-					break;
-				source = source->next;
-			}
-			massin = 0;
-			if (source != NULL && source->c0 > 0)
-			{
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n2].c[m] - MSX.FirstSeg[k]->c[m]) * LperFT3 / MSX.FirstSeg[k]->v;
-			}
-			else if (n2 > njuncs && MSX.Tank[n2 - njuncs].a == 0)  //we assume constant tank and reservoir concentration during dispersion which may not be true for small tanks
-			{
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n2].c[m] - MSX.FirstSeg[k]->c[m]) * LperFT3 / MSX.FirstSeg[k]->v;
-			}
-			else if (n2 > njuncs && MSX.Tank[n2 - njuncs].a > 0.0)
-			{
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n2].c[m] - MSX.FirstSeg[k]->c[m]) * LperFT3 / MSX.FirstSeg[k]->v;
-				
-			}
-#pragma omp critical
-			{
-				dispersedin += massin;
-			}
-			source = MSX.Node[n1].sources;
-			while (source != NULL)
-			{
-				if (source->species == m)
-					break;
-				source = source->next;
-			}
-			massin = 0;
-			if (source != NULL && source->c0 > 0)
-			{
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n1].c[m] - MSX.LastSeg[k]->c[m]) * LperFT3 / MSX.LastSeg[k]->v;
-			}
-			else if (n1 > njuncs && MSX.Tank[n1 - njuncs].a == 0)
-			{
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n1].c[m] - MSX.LastSeg[k]->c[m]) * LperFT3 / MSX.LastSeg[k]->v;
-			}
-			else if (n1 > njuncs && MSX.Tank[n1 - njuncs].a > 0.0)
-			{
-
-				massin = 2.0 * ldispersion * tstep * area * area * (MSX.Node[n1].c[m] - MSX.LastSeg[k]->c[m]) * LperFT3 / MSX.LastSeg[k]->v;
-				
-			}
-#pragma omp critical
-			{
-				dispersedin += massin;
-			}
-		}
-	}
-	MSX.MassBalance.indisperse[m] += dispersedin;
-
-
-}
-
-
-void disperse_tankqual(int n, int m, double massin)
-{
-	int j, tm, k;
-	Pseg   seg;
-	double c, v;
-
-	j = MSX.Node[n].tank;
-	if (j < 0)
-		return;
-	else if (MSX.Tank[j].a == 0)
-		return;
-
-	k = MSX.Nobjects[LINK] + j;
-	tm = MSX.Tank[j].mixModel;
-	
-	if (tm == MIX1|| tm == MIX2)
-	{
-		seg = MSX.LastSeg[k];
-		if (seg)
-		{
-			v = seg->v;
-			c = seg->c[m];
-			if (v > 0)
-				c = (c * v * LperFT3 + massin) / (v * LperFT3);
-			
-			c = MAX(0, c);
-			seg->c[m] = c;
-			MSX.Tank[j].c[m] = c;
-			MSX.Node[n].c[m] = c;
-		}
-	}
-	else if (tm == FIFO)
-	{
-		seg = MSX.FirstSeg[k];
-		if (seg)
-		{
-			v = seg->v;
-			c = seg->c[m];
-			if (v > 0)
-				c = (c * v * LperFT3 + massin) / (v * LperFT3);
-			
-			if( c < 0)
-				c = MAX(0, c);
-			seg->c[m] = c;
-
-		}
-	}
-	else if (tm == LIFO)
-	{
-		seg = MSX.FirstSeg[k];
-		if (seg)
-		{
-			v = seg->v;
-			c = seg->c[m];
-			if (v > 0)
-				c = (c * v * LperFT3 + massin) / (v * LperFT3);
-
-			c = MAX(0, c);
-			seg->c[m] = c;
-
-		}
-
-	}
-
-
-}
-
-
-
-
-
-// Solve tri-daigonal system of eqns. using Thomas' algorithm
-
-void tridiag(int n, double *a, double *b, double *c, double *r, double *y)
-{
-	int j;
-	double bet;
-
-	bet = b[0];
-	y[0] = r[0] / bet;
-	for (j = 1; j < n; j++)
-	{
-		gam[j] = c[j - 1] / bet;
-		bet = b[j] - a[j] * gam[j];
-		y[j] = (r[j] - a[j] * y[j - 1]) / bet;
-	}
-	for (j = n - 2; j >= 0; j--)
-	{
-		y[j] -= gam[j + 1] * y[j + 1];
-	}
-}

epyt_flow/EPANET/EPANET-MSX/Src/msxerr.c

@@ -1,116 +0,0 @@
-/******************************************************************************
-**  MODULE:        MSXERR.C
-**  PROJECT:       EPANET-MSX
-**  DESCRIPTION:   Math error reporting routines.
-**  AUTHORS:       see AUTHORS
-**  Copyright:     see AUTHORS
-**  License:       see LICENSE
-**  VERSION:       2.0.00
-**  LAST UPDATE:   04/14/2021
-******************************************************************************/
-
-#include <stdio.h>
-#include <string.h>
-
-#include "msxtypes.h"
-#include "epanet2.h"
-
-//  External variables
-//--------------------
-extern MSXproject  MSX;                // MSX project data
-
-//  Local variables
-//-----------------
-static int   mathError;                // math error flag
-static char  mathErrorMsg[1024];       // math error message
-static char* elementTxt[] =            // see ObjectType in msxtypes.h
-    {"", "pipe", "tank"};
-static char* exprTypeTxt[] =           // see ExpressionType in msxtypes.h
-    {"", "rate", "formula", "equilibrium"};
-
-//  Exported functions
-//--------------------
-void   MSXerr_clearMathError(void);
-int    MSXerr_mathError(void);
-double MSXerr_validate(double x, int index, int element, int exprType);
-void   MSXerr_writeMathErrorMsg(void);
-
-
-//=============================================================================
-
-void MSXerr_clearMathError()
-/*
-**  Purpose:
-**    clears the math error flag.
-*/
-{
-	mathError = 0;
-	strcpy(mathErrorMsg, "");
-}
-
-//=============================================================================
-
-int  MSXerr_mathError()
-/*
-**  Purpose:
-**    returns the current state of the math error flag.
-*/
-{
-    return mathError;
-}
-
-//=============================================================================
-
-void MSXerr_writeMathErrorMsg()
-/*
-**  Purpose:
-**    writes math error message to EPANET report file.
-*/
-{
-	ENwriteline(mathErrorMsg);
-	ENwriteline("");
-}
-
-//=============================================================================
-
-double  MSXerr_validate(double x, int index, int element, int exprType)
-/*
-**  Purpose:
-**    checks if a number is valid or not.
-**
-**  Input:
-**    x = the number to check
-**    index = array index of species or term that x was computed for
-**    element = LINK for a pipe element or TANK for a tank element
-**    exprType = type of expression that produced x
-**
-**  Returns:
-**    the value of x if it's a valid number or 0 otherwise.
-*/
-{
-	// return x if it's a valid number
-	if (x == x) return x;
-
-	// return 0 if the math error flag has previously been set
-	// (we only want the first math error identified since others
-	//  may have propagated from it)
-	if (mathError) return 0.0;
-
-	// construct a math error message
-	if ( exprType == TERM )
-	{
-		sprintf(mathErrorMsg,
-		"Ilegal math operation occurred for term:\n  %s",
-		MSX.Term[index].id);
-	}
-	else
-	{
-		sprintf(mathErrorMsg,
-		"Ilegal math operation occurred in %s %s expression for species:\n  %s",
-		elementTxt[element], exprTypeTxt[exprType], MSX.Species[index].id);
-	}
-
-	// set the math error flag and return 0
-	mathError = 1;
-	return 0.0;
-}