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

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

@@ -1,524 +0,0 @@
-/*******************************************************************************
-**  MODULE:        MSXUTILS.C
-**  PROJECT:       EPANET-MSX
-**  DESCRIPTION:   Utility functions used by the EPANET Multi-Species Extension
-**                 toolkit.
-**  AUTHORS:       see AUTHORS
-**  Copyright:     see AUTHORS
-**  License:       see LICENSE
-**  VERSION:       2.0.00
-**  LAST UPDATE:   2/8/11
-*******************************************************************************/
-
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
-#include <math.h>
-#include <float.h>
-
-#include "msxutils.h"
-// --- define WINDOWS
-
-#undef WINDOWS
-#ifdef _WIN32
-  #define WINDOWS
-#endif
-#ifdef __WIN32__
-  #define WINDOWS
-#endif
-
-#define UCHAR(x) (((x) >= 'a' && (x) <= 'z') ? ((x)&~32) : (x))
-#define TINY1 1.0e-20
-
-//=============================================================================
-
-char * MSXutils_getTempName(char *s)                                           
-/*
-**  Purpose:
-**    gets the name of a temporary file with path name and periods stripped
-**
-**  Input:
-**    s = character string (must be of size L_tmpnam)
-**  
-**  Returns:
-**    a pointer to the file name.
-*/
-{
-#ifdef WINDOWS
-    char *ptr;
-    char fname[L_tmpnam];
-    unsigned int i;
-
-	// --- use tmpnam() function to create a temporary file name
-    tmpnam(fname);
-
-	// --- replace any '.' characters (they cause problems for some compilers)
-    for (i=0; i<strlen(fname); i++)
-    {
-	    if ( fname[i] == '.' ) fname[i] = '_';
-    }
-
-	// --- set ptr to non-path portion of file name
-    ptr = strrchr(fname, '\\');
-    if ( ptr ) ++ptr;
-    else ptr = fname;
-
-	// --- use '.\' as path name to keep file in current directory
-	strcpy(s, ".\\");
-    strcat(s, ptr);
-#else
-    // --- use system function mkstemp() to create a temporary file name
-    strcpy(s, "msxXXXXXX");
-    mkstemp(s);
-#endif
-    return s;
-}
-
-//=============================================================================
-
-int  MSXutils_strcomp(char *s1, char *s2)
-/*
-**  Purpose:
-**    performs case insensitive comparison of two strings.
-**
-**  Input:
-**    s1 = character string
-**    s2 = character string.
-**  
-**  Returns:
-**    1 if strings are the same, 0 otherwise.
-*/
-{
-   int i;
-   for (i=0; UCHAR(s1[i]) == UCHAR(s2[i]); i++)
-     if (!s1[i+1] && !s2[i+1]) return(1);
-   return(0);
-}
-
-//=============================================================================
-
-int  MSXutils_findmatch(char *s, char *keyword[])
-/*
-**  Purpose:
-**    finds a match between a string and an array of keyword strings.
-**
-**  Input:
-**    s = character string
-**    keyword = array of keyword strings.
-**
-**  Returns:
-**    index of matching keyword or -1 if no match found.
-*/
-{
-   int i = 0;
-   while (keyword[i] != NULL)
-   {
-      if (MSXutils_match(s, keyword[i])) return(i);
-      i++;
-   }
-   return(-1);
-}
-
-//=============================================================================
-
-int  MSXutils_match(char *str, char *substr)
-/*
-**  Purpose:
-**    sees if a sub-string of characters appears in a string
-**    (not case sensitive).
-**
-**  Input:
-**    str = character string being searched
-**    substr = sub-string being searched for.
-**
-**  Returns:
-**    1 if sub-string found, 0 if not.
-*/
-{
-    int i,j;
-
-    // --- fail if substring is empty
-    if (!substr[0]) return(0);
-
-    // --- skip leading blanks of str
-    for (i=0; str[i]; i++)
-        if (str[i] != ' ') break;
-
-    // --- check if substr matches remainder of str
-    for (i=i,j=0; substr[j]; i++,j++)
-        if (!str[i] || UCHAR(str[i]) != UCHAR(substr[j]))
-            return(0);
-    return(1);
-}
-
-//=============================================================================
-
-int MSXutils_strToSeconds(char *s, long *seconds)
-/*
-**  Purpose:
-**    converts a string in either decimal hours or hr:min:sec
-**    format to number of seconds.
-**
-**  Input:
-**    s = string value of a time. 
-**
-**  Output:
-**    seconds = number of seconds.
-**
-**  Returns:
-**    1 if conversion successful, 0 if not.
-*/
-{
-    int  n, hr = 0, min = 0, sec = 0;
-    double hours;
-    *seconds = 0;
-    if ( MSXutils_getDouble(s, &hours) )
-    {
-        *seconds = (long)(3600.0*hours);
-        return 1;
-    }
-    n = sscanf(s, "%d:%d:%d", &hr, &min, &sec);
-    if ( n == 0 ) return 0;
-    *seconds = 3600*hr + 60*min + sec;
-    return 1;
-}
-
-//=============================================================================
-
-int  MSXutils_getInt(char *s, int *y)
-/*
-**  Purpose:
-**    converts a string to an integer number.
-**
-**  Input:
-**    s = a character string.
-**
-**  Output:
-**    y = converted value of s.
-**
-**  Returns:
-**    1 if conversion successful, 0 if not.
-*/
-{
-    double x;
-    if ( MSXutils_getDouble(s, &x) )
-    {
-        if ( x < 0.0 ) x -= 0.01;
-        else x += 0.01;
-        *y = (int)x;
-        return 1;
-    }
-    *y = 0;
-    return 0;
-}
-
-//=============================================================================
-
-int  MSXutils_getFloat(char *s, float *y)
-/*
-**  Purpose:
-**    converts a string to a single precision floating point number.
-**
-**  Input:
-**    s = a character string.
-**
-**  Output:
-**    y = converted value of s
-**
-**  Returns:
-**    1 if conversion successful, 0 if not.
-*/
-{
-    char *endptr;
-    *y = (float) strtod(s, &endptr);
-    if (*endptr > 0) return(0);
-    return(1);
-}
-
-//=============================================================================
-
-int  MSXutils_getDouble(char *s, double *y)
-/*
-**  Purpose:
-**    converts a string to a double precision floating point number.
-**
-**  Input:
-**    s = a character string.
-**
-**  Output:
-**    y = converted value of s.
-**
-**  Returns:
-**    1 if conversion successful, 0 if not.
-*/
-{
-    char *endptr;
-    *y = strtod(s, &endptr);
-    if (*endptr > 0) return(0);
-    return(1);
-}
-
-//=============================================================================
-
-double ** createMatrix(int nrows, int ncols)
-/*
-**  Purpose:
-**    allocates memory for a 2-dimensional array of doubles.
-**
-**  Input:
-**    nrows = number of rows (0-based)
-**    ncols = number of columns (0-based).
-**
-**  Returns:
-**    a pointer to the matrix (a = matrix(nr, nc)).
-*/
-{
-    int i,j;
-    double **a;
-
-// --- allocate pointers to rows
-
-    a = (double **) malloc(nrows * sizeof(double *));
-    if ( !a ) return NULL;
-    
-// --- allocate rows and set pointers to them
-
-    a[0] = (double *) malloc (nrows * ncols * sizeof(double));
-    if ( !a[0] ) return NULL;
-    for ( i = 1; i < nrows; i++ ) a[i] = a[i-1] + ncols;
-
-    for ( i = 0; i < nrows; i++)
-    {
-        for ( j = 0; j < ncols; j++) a[i][j] = 0.0;
-    }
-    
-// --- return pointer to array of pointers to rows
-
-    return a;
-}
-
-//=============================================================================
-
-void freeMatrix(double **a)
-/*
-**  Purpose:
-**    frees the memory allocated for a matrix of doubles.
-**
-**  Input:
-**    a = pointer to a matrix of doubles.
-*/
-{
-    if ( a != NULL )
-    {
-        if ( a[0] != NULL ) free( a[0] );
-        free( a );
-    }
-}
-
-//=============================================================================
-
-int factorize(double **a, int n, double *w, int *indx)
-/*
-**  Purpose:
-**    performs an LU decomposition of a matrix.
-**
-**  Input:
-**    a[1..n][1..n] = a square matrix of doubles
-**    n = matrix size (1-based)
-**    w[1..n] = work array of doubles.
-**
-**  Output:
-**    a[][] = matrix that contains elements of L and U matrices
-**    indx[1..n] = vector that records the row permutation
-**                 effected by the partial pivoting.
-**
-**  Returns:
-**    1 if successful, 0 if matrix is singular.
-**
-**  Note:
-**    The arrays and matrices used in this function are 1-based, so
-**    they must have been sized to n+1 when first created.
-*/
-{
-    int    i, imax, j, k;
-    double big, dum, sum, temp;
-
-    for (i = 1; i <= n; i++) 
-    { 
-	/*Loop over rows to get the implicit scaling information.*/
-	big = 0.0;
-	for (j = 1;j <= n;j++)
-	    if ((temp = fabs(a[i][j])) > big) big = temp;
-        if (big == 0.0) 
-	return 0;  /* Warning for singular matrix*/
-	/*No nonzero largest element.*/
-	w[i] = 1.0/big; /*Save the scaling.*/
-    }
-    for (j = 1;j <= n;j++) /**for each column*/
-    { 
-	/*This is the loop over columns of Crout�s method.*/
-	for (i = 1; i < j; i++) 
-	{ 
-	    /*Up from the diagonal*/
-	    sum = a[i][j];
-	    for (k = 1;k < i;k++) sum -= a[i][k]*a[k][j];
-	    a[i][j] = sum;
-	}
-	big = 0.0; /*Initialize for the search for largest pivot element.*/
-	imax = j;
-	for (i = j; i <= n; i++) 
-	{ 
-	    sum = a[i][j];
-	    for (k = 1; k < j; k++) sum -= a[i][k]*a[k][j];
-            a[i][j] = sum;
-            if ( (dum = w[i]*fabs(sum)) >= big) 
-	    {
-                big = dum;
-	        imax = i;
-            }
-	}
-	if (j != imax) 
-	{
-	    /*Do we need to interchange rows?*/
-	    for (k = 1; k <= n; k++) 
-            { 
-                /*Yes,do so...*/
-                dum = a[imax][k];
-                a[imax][k] = a[j][k];
-                a[j][k] = dum;
-            }
-            w[imax] = w[j]; /* interchange the scale factor.*/
-        } 
-        indx[j] = imax;
-	if (a[j][j] == 0.0) a[j][j] = TINY1;
-	if (j != n) /* divide by the pivot element.*/
-	{ 
-	    dum = 1.0/(a[j][j]);
-	    for (i = j+1;i <= n;i++) a[i][j] *= dum;	
-        }
-    } 
-    return 1;
-}
-
-//=============================================================================
-
-void solve(double **a, int n, int *indx, double b[])
-/*
-**  Purpose:
-**    solves linear equations AX = B after LU decomposition of A.
-**
-**  Input:
-**    a[1..n][1..n] = LU decomposed square matrix A returned by factorize
-**    n = matrix size
-**    indx[1..n] = permutation vector returned by factorize
-**    b[1..n] = right-hand side vector B.
-**
-**  Output:
-**    b[1..n] = solution vector X.
-**
-**  Note:
-**    The arrays and matrices used in this function are 1-based, so
-**    they must have been sized to n+1 when first created.
-*/
-{
-	int i, ii=0, ip, j;
-	double sum;
-	
-	/*forward substitution */
-	for (i=1; i<=n; i++) 
-	{ 
-		ip=indx[i];
-		sum=b[ip];
-		b[ip]=b[i];
-		if (ii)
-			for (j=ii; j<=i-1; j++) 
-				sum -= a[i][j]*b[j];
-		else if (sum) ii=i; 
-		b[i]=sum;
-	}
-	
-	/* back substitution */
-	for (i=n; i>=1; i--) 
-	{ 
-		sum=b[i];
-		for (j=i+1; j<=n; j++) 
-			sum -= a[i][j]*b[j];
-		b[i]=sum/a[i][i]; 
-	}
-}
-
-//=============================================================================
-
-void jacobian(double *x, int n, double *f, double *w, double **a,
-              void (*func)(double, double*, int, double*))
-/*
-**  Purpose: 
-**    computes Jacobian matrix of F(t,X) at given X
-**
-**  Input:
-**    x[1..n] = vector of function variables
-**    n = number of variables
-**    f[1..n] = a work vector
-**    w[1..n] = a work vector
-**    func = user supplied routine that computes the function
-**           values at x.
-**
-**  Output:
-**    f[1..n] = function values at x
-**    a[1..n][1..n] = coeffs. of the Jacobian matrix.
-**
-**  Notes:
-**  1. Arguments for func() are:
-**      t = independent variable (not used)
-**      x[1..n] = vector of dependent variables
-**      n = number of functions
-**      f[1..n] = function values at x.
-**  
-**  2. The arrays and matrices used in this function are 1-based, so
-**     they must have been sized to n+1 when first created.
-*/
-{
-
-    int    i, j;
-    double temp, eps = 1.0e-7, eps2;
-
-    for (j=1; j<=n; j++)
-    {
-        temp = x[j];
-        x[j] = temp + eps;
-        func(0.0, x, n, f);
-        if ( temp == 0.0 )
-        {
-            x[j] = temp;
-            eps2 = eps;
-        }
-        else
-        {
-            x[j] = temp - eps;
-            eps2 = 2.0*eps;
-        }
-        func(0.0, x, n, w);
-        for (i=1; i<=n; i++) a[i][j] = (f[i] - w[i]) / eps2;
-        x[j] = temp;
-    }
-
-
-/* --- An alternative method that uses forward differencing
-	int    i,j;
-	double temp, h;
-    double eps = sqrt(DBL_EPSILON);
-
-    func(0.0, x, n, f);
-	for (j=1; j<=n; j++) 
-	{
-		temp = x[j];
-		h = eps*fabs(temp);
-		if (h == 0.0) h = eps;
-		x[j] = temp + h;
-        func(0.0, x, n, w);
-		for (i=1; i<=n; i++) a[i][j] = (w[i] - f[i]) / h;
-		x[j] = temp;
-	}
-*/
-
-}

epyt_flow/EPANET/EPANET-MSX/Src/msxutils.h

@@ -1,56 +0,0 @@
-/*******************************************************************************
-**  MODULE:        MSXUTILS.H
-**  PROJECT:       EPANET-MSX
-**  DESCRIPTION:   Header file for the utility functions used by the EPANET
-**                 Multi-Species Extension toolkit.
-**  AUTHORS:       see AUTHORS
-**  Copyright:     see AUTHORS
-**  License:       see LICENSE
-**  VERSION:       2.0.00
-**  LAST UPDATE:   2/8/11
-*******************************************************************************/
-
-#ifndef MSXUTILS_H
-#define MSXUTILS_H
-
-// Gets the name of a temporary file                                           
-char * MSXutils_getTempName(char *s);
-
-// Case insentive comparison of two strings
-int MSXutils_strcomp(char *s1, char *s2);
-
-// Matches a string against an array of keywords
-int MSXutils_findmatch(char *s, char *keyword[]);
-
-// Case insensitive search of a string for a substring
-int MSXutils_match(char *str, char *substr);
-
-// Converts a 24-hr clocktime to number of seconds
-int MSXutils_strToSeconds(char *s, long *t);
-
-// Converts a string to an integer
-int MSXutils_getInt(char *s, int *y);
-
-// Converts a string to a float
-int MSXutils_getFloat(char *s, float *y);
-
-// Converts a string to a double
-int MSXutils_getDouble(char *s, double *y);
-
-// Creates a two dimensional array
-double ** createMatrix(int nrows, int ncols);
-
-// Deletes a two dimensional array
-void freeMatrix(double **a);
-
-// Applies L-D factorization to a square matrix
-int factorize(double **a, int n, double *w, int *indx);
-
-// Solves a factorized, linear system of equations
-void solve(double **a, int n, int *indx, double b[]);
-
-// Computes the Jacobian matrix of a set of functions
-void jacobian(double *x, int n, double *f, double *w, double **a,
-              void (*func)(double, double*, int, double*));
-
-#endif