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

epyt_flow/EPANET/EPANET/SRC_engines/smatrix.c

@@ -1,7 +1,7 @@
 /*
  ******************************************************************************
  Project:      OWA EPANET
- Version:      2.2
+ Version:      2.3
  Module:       smatrix.c
  Description:  solves a sparse set of linear equations
  Authors:      see AUTHORS
@@ -48,8 +48,8 @@ static int     paralink(Network *, Smatrix *, int, int, int k);
 static void    xparalinks(Network *);
 static int     reordernodes(Project *);
 static int     factorize(Project *);
-static int     growlist(Project *, int);
-static int     newlink(Project *, Padjlist);
+static int     growlist(Project *, int, int *);
+static int     newlink(Project *, Padjlist, int *);
 static int     linked(Network *, int, int);
 static int     addlink(Network *, int, int, int);
 static int     storesparse(Project *, int);
@@ -443,8 +443,8 @@ int factorize(Project *pr)
     Padjlist alink;
 
     // Find degree of each junction node
-    sm->Degree = (int *)calloc(net->Nnodes + 1, sizeof(int));
-    if (sm->Degree == NULL) return 101;
+    int *degree = (int *)calloc(net->Nnodes + 1, sizeof(int));
+    if (degree == NULL) return 101;
 
     // NOTE: For purposes of node re-ordering, Tanks (nodes with
     //       indexes above Njuncs) have zero degree of adjacency.
@@ -453,7 +453,7 @@ int factorize(Project *pr)
     {
         for (alink = net->Adjlist[k]; alink != NULL; alink = alink->next)
         {
-            if (alink->node > 0) sm->Degree[k]++;
+            if (alink->node > 0) degree[k]++;
         }
     }
 
@@ -463,19 +463,19 @@ int factorize(Project *pr)
     for (k = 1; k <= net->Njuncs; k++)          // Examine each junction
     {
         knode = sm->Order[k];                   // Re-ordered index
-        if (!growlist(pr, knode))               // Augment adjacency list
+        if (!growlist(pr, knode, degree))               // Augment adjacency list
         {
             errcode = 101;
             break;
         }
-        sm->Degree[knode] = 0;                  // In-activate node
+        degree[knode] = 0;                  // In-activate node
     }
-    free(sm->Degree);
+    free(degree);
     return errcode;
 }
 
 
-int  growlist(Project *pr, int knode)
+int  growlist(Project *pr, int knode, int *degree)
 /*
 **--------------------------------------------------------------
 ** Input:   knode = node index
@@ -496,10 +496,10 @@ int  growlist(Project *pr, int knode)
     for (alink = net->Adjlist[knode]; alink != NULL; alink = alink -> next)
     {
         node = alink->node;                   // End node of connecting link
-        if (node > 0 && sm->Degree[node] > 0) // End node is active
+        if (node > 0 && degree[node] > 0) // End node is active
         {
-            sm->Degree[node]--;           // Reduce degree of adjacency
-            if (!newlink(pr, alink))      // Add to adjacency list
+            degree[node]--;           // Reduce degree of adjacency
+            if (!newlink(pr, alink, degree))      // Add to adjacency list
             {
                 return 0;
             }
@@ -509,7 +509,7 @@ int  growlist(Project *pr, int knode)
 }
 
 
-int  newlink(Project *pr, Padjlist alink)
+int  newlink(Project *pr, Padjlist alink, int *degree)
 /*
 **--------------------------------------------------------------
 ** Input:   alink = element of node's adjacency list
@@ -533,7 +533,7 @@ int  newlink(Project *pr, Padjlist alink)
 
         // If jnode still active, and inode not connected to jnode,
         // then add a new connection between inode and jnode.
-        if (jnode > 0 && sm->Degree[jnode] > 0)  // jnode still active
+        if (jnode > 0 && degree[jnode] > 0)  // jnode still active
         {
             if (!linked(net, inode, jnode))      // inode not linked to jnode
             {
@@ -545,8 +545,8 @@ int  newlink(Project *pr, Padjlist alink)
                 // reflect the new connection.
                 if (!addlink(net, inode, jnode, sm->Ncoeffs)) return 0;
                 if (!addlink(net, jnode, inode, sm->Ncoeffs)) return 0;
-                sm->Degree[inode]++;
-                sm->Degree[jnode]++;
+                degree[inode]++;
+                degree[jnode]++;
             }
         }
     }
@@ -651,7 +651,7 @@ int  sortsparse(Smatrix *sm, int n)
 /*
 **--------------------------------------------------------------
 ** Input:   n = number of rows in solution matrix
-** Output:  returns eror code
+** Output:  returns error code
 ** Purpose: puts row indexes in ascending order in NZSUB
 **--------------------------------------------------------------
 */
@@ -834,7 +834,7 @@ int  linsolve(Smatrix *sm, int n)
       }
    }      // next j
 
-   // Foward substitution
+   // Forward substitution
    for (j = 1; j <= n; j++)
    {
       bj = B[j]/Aii[j];

epyt_flow/EPANET/EPANET/SRC_engines/text.h

@@ -1,13 +1,13 @@
 /*
  ******************************************************************************
  Project:      OWA EPANET
- Version:      2.2
+ Version:      2.3
  Module:       text.h
  Description:  string constants used throughout EPANET
  Authors:      see AUTHORS
  Copyright:    see AUTHORS
  License:      see LICENSE
- Last Updated: 07/15/2019
+ Last Updated: 03/10/2025
  ******************************************************************************
 */
 
@@ -40,6 +40,7 @@
 #define   w_FCV         "FCV"
 #define   w_TCV         "TCV"
 #define   w_GPV         "GPV"
+#define   w_PCV         "PCV"
 
 #define   w_OPEN        "OPEN"
 #define   w_CLOSED      "CLOSED"
@@ -51,9 +52,6 @@
 #define   w_IS          "IS"
 #define   w_NOT         "NOT"
 
-#define   w_ADD         "ADD"
-#define   w_MULTIPLY    "MULT"
-
 #define   w_LIMITING    "LIMIT"
 #define   w_ORDER       "ORDER"
 #define   w_GLOBAL      "GLOB"
@@ -86,11 +84,14 @@
 #define   w_MLD         "MLD"
 #define   w_CMH         "CMH"
 #define   w_CMD         "CMD"
+#define   w_CMS         "CMS"
 #define   w_SI          "SI"
 
 #define   w_PSI         "PSI"
 #define   w_KPA         "KPA"
 #define   w_METERS      "METERS"
+#define   w_BAR         "BAR"
+#define   w_FEET        "FEET"
 
 #define   w_ELEV        "ELEV"
 #define   w_DEMAND      "DEMAND"
@@ -130,6 +131,8 @@
 #define   w_SEGMENTS    "SEGM"
 #define   w_TOLERANCE   "TOLER"
 #define   w_EMITTER     "EMIT"
+#define   w_BACKFLOW    "BACK"
+#define   w_ALLOWED     "ALLOW"
 
 #define   w_PRICE       "PRICE"
 #define   w_DMNDCHARGE  "DEMAN"
@@ -150,6 +153,9 @@
 #define   w_REQUIRED    "REQ"
 #define   w_EXPONENT    "EXP"
 
+#define   w_AREA        "AREA"
+#define   w_EXPAN       "EXPAN"
+
 #define   w_SECONDS     "SEC"
 #define   w_MINUTES     "MIN"
 #define   w_HOURS       "HOU"
@@ -192,6 +198,7 @@
 #define   w_THEN        "THEN"
 #define   w_ELSE        "ELSE"
 #define   w_PRIORITY    "PRIO"
+#define   w_DISABLED    "DISABLED"
 
 // ------ Input File Section Names ------------------------
 
@@ -207,6 +214,7 @@
 #define   s_DEMANDS     "[DEMANDS]"
 #define   s_SOURCES     "[SOURCES]"
 #define   s_EMITTERS    "[EMITTERS]"
+#define   s_LEAKAGE     "[LEAKAGE]"
 #define   s_PATTERNS    "[PATTERNS]"
 #define   s_CURVES      "[CURVES]"
 #define   s_QUALITY     "[QUALITY]"
@@ -234,6 +242,7 @@
 #define   u_IMGD        "Imgd"
 #define   u_LPS         "L/s"
 #define   u_LPM         "Lpm"
+#define   u_CMS         "m3/s"
 #define   u_CMH         "m3/h"
 #define   u_CMD         "m3/d"
 #define   u_MLD         "ML/d"
@@ -263,6 +272,8 @@
 #define   c_PUMP        "PUMP"
 #define   c_EFFIC       "EFFIC"
 #define   c_VOLUME      "VOLUME"
+#define   c_VALVE       "VALVE"
+#define   c_GENERIC     "GENERIC"
 
 //------- Text Phrases ------------------------------------
 

epyt_flow/EPANET/EPANET/SRC_engines/types.h

@@ -1,13 +1,13 @@
 /*
  ******************************************************************************
  Project:      OWA EPANET
- Version:      2.2
+ Version:      2.3
  Module:       types.h
  Description:  symbolic constants and data types used throughout EPANET
  Authors:      see AUTHORS
  Copyright:    see AUTHORS
  License:      see LICENSE
- Last Updated: 10/29/2019
+ Last Updated: 04/19/2025
  ******************************************************************************
 */
 
@@ -31,7 +31,7 @@ typedef  int          INT4;
    Various constants
 ----------------------------------------------
 */
-#define   CODEVERSION        20200
+#define   CODEVERSION        20300
 #define   MAGICNUMBER        516114521
 #define   ENGINE_VERSION     201   // Used for binary hydraulics file
 #define   EOFMARK            0x1A  // Use 0x04 for UNIX systems
@@ -48,6 +48,9 @@ typedef  int          INT4;
 #define   BIG       1.E10
 #define   TINY      1.E-6
 #define   MISSING   -1.E10     // Missing value indicator
+#define   SET_CLOSED -1.E10    // Link set closed indicator
+#define   SET_OPEN    1.E10    // Link set open indicator
+
 #define   DIFFUS    1.3E-8     // Diffusivity of chlorine
                                // @ 20 deg C (sq ft/sec)
 #define   VISCOS    1.1E-5     // Kinematic viscosity of water
@@ -71,6 +74,7 @@ typedef  int          INT4;
 #define   IMGDperCFS  0.5382
 #define   LPSperCFS   28.317
 #define   LPMperCFS   1699.0
+#define   CMSperCFS   0.028317
 #define   CMHperCFS   101.94
 #define   CMDperCFS   2446.6
 #define   MLDperCFS   2.4466
@@ -79,6 +83,7 @@ typedef  int          INT4;
 #define   MperFT      0.3048
 #define   PSIperFT    0.4333
 #define   KPAperPSI   6.895
+#define   BARperPSI   0.068948
 #define   KWperHP     0.7457
 #define   SECperDAY   86400
 
@@ -145,7 +150,8 @@ typedef enum {
   PBV,           // pressure breaker valve
   FCV,           // flow control valve
   TCV,           // throttle control valve
-  GPV            // general purpose valve
+  GPV,           // general purpose valve
+  PCV            // positional control valve
 } LinkType;
 
 typedef enum {
@@ -166,7 +172,8 @@ typedef enum {
   PUMP_CURVE,    // pump curve
   EFFIC_CURVE,   // efficiency curve
   HLOSS_CURVE,   // head loss curve
-  GENERIC_CURVE  // generic curve
+  GENERIC_CURVE, // generic curve
+  VALVE_CURVE    // positional valve loss curve
 } CurveType;
 
 typedef enum {
@@ -225,13 +232,17 @@ typedef enum {
   LPM,           // liters per minute
   MLD,           // megaliters per day
   CMH,           // cubic meters per hour
-  CMD            // cubic meters per day
+  CMD,           // cubic meters per day
+  CMS            // cubic meters per second
 } FlowUnitsType;
 
 typedef enum {
   PSI,           // pounds per square inch
   KPA,           // kiloPascals
-  METERS         // meters
+  METERS,        // meters
+  BAR,           // bar
+  FEET,          // feet
+  DEFAULTUNIT    // default based on unit system (SI or US)
 } PressureUnitsType;
 
 typedef enum {
@@ -287,7 +298,7 @@ typedef enum {
   _VALVES, _CONTROLS, _RULES, _DEMANDS, _SOURCES, _EMITTERS,
   _PATTERNS, _CURVES, _QUALITY, _STATUS, _ROUGHNESS, _ENERGY,
   _REACTIONS, _MIXING, _REPORT, _TIMES, _OPTIONS,
-    _COORDS, _VERTICES, _LABELS, _BACKDROP, _TAGS, _END
+    _COORDS, _VERTICES, _LABELS, _BACKDROP, _TAGS, _LEAKAGE, _END
 } SectionType;
 
 typedef enum {
@@ -355,6 +366,8 @@ typedef struct             // Energy Usage Object
   double KwHrs;            // total kw-hrs consumed
   double MaxKwatts;        // max. kw consumed
   double TotalCost;        // total pumping cost
+  double CurrentPower;     // current pump power (kw)
+  double CurrentEffic;     // current pump efficiency
 } Senergy;
 
 struct Ssource             // Water Quality Source Object
@@ -389,6 +402,7 @@ typedef struct             // Node Object
   int      ResultIndex;    // saved result index
   NodeType Type;           // node type
   char     *Comment;       // node comment
+  char     *Tag;           // optional category tag                                                   
 } Snode;
 
 typedef struct             // Link Object
@@ -398,18 +412,22 @@ typedef struct             // Link Object
   int      N2;             // end node index
   double   Diam;           // diameter
   double   Len;            // length
-  double   Kc;             // roughness
+  double   Kc;             // pipe roughness, pump speed, valve setting
   double   Km;             // minor loss coeff.
   double   Kb;             // bulk react. coeff.
   double   Kw;             // wall react. coef.
   double   R;              // flow resistance
   double   Rc;             // reaction coeff.
+  double   LeakArea;       // leak area (sq mm per 100 pipe length units
+  double   LeakExpan;      // leak expansion (sq mm per unit of head)
   LinkType Type;           // link type
-  StatusType Status;       // initial status
+  StatusType InitStatus;   // initial status
+  double     InitSetting;  // initial setting
   Pvertices  Vertices;     // internal vertex coordinates
   int      Rpt;            // reporting flag
   int      ResultIndex;    // saved result index
   char     *Comment;       // link comment
+  char     *Tag;           // optional category tag                                                   
 } Slink;
 
 typedef struct             // Tank Object
@@ -428,7 +446,7 @@ typedef struct             // Tank Object
   int     Pat;             // fixed grade time pattern
   int     Vcurve;          // volume v. elev. curve index
   MixType MixModel;        // type of mixing model
-  double  V1max;           // mixing compartment size
+  double  V1frac;          // mixing compartment fraction
   int     CanOverflow;     // tank can overflow or not
 } Stank;
 
@@ -453,6 +471,7 @@ typedef struct             // Pump Object
 typedef struct             // Valve Object
 {
   int Link;                // link index of valve
+  int Curve;               // positional loss coeff. curve
 } Svalve;
 
 typedef struct             // Control Statement
@@ -464,6 +483,7 @@ typedef struct             // Control Statement
     double      Setting;   // new link setting
     StatusType  Status;    // new link status
     ControlType Type;      // control type
+    int         isEnabled; // control enabled?
 } Scontrol;
 
 typedef struct             // Field Object of Report Table
@@ -515,6 +535,7 @@ typedef struct                 // Control Rule Structure
 {
     char     label[MAXID+1];   // rule label
     double   priority;         // priority level
+    int      isEnabled;        // is the rule enabled?
     Spremise *Premises;        // list of premises
     Saction  *ThenActions;     // list of THEN actions
     Saction  *ElseActions;     // list of ELSE actions
@@ -535,8 +556,29 @@ typedef struct                 // Mass Balance Components
     double    reacted;         // mass reacted in system
     double    final;           // final mass in system
     double    ratio;           // ratio of mass added to mass lost
+    int       segCount;        // total number of pipe segments used                       
 } SmassBalance;
 
+typedef struct
+{
+    double    totalInflow;
+    double    totalOutflow;
+    double    consumerDemand;
+    double    emitterDemand;
+    double    leakageDemand;
+    double    deficitDemand;
+    double    storageDemand;
+    double    ratio;
+} SflowBalance;    
+
+typedef struct                 // Node Leakage Object
+{
+  double qfa;                  // fixed area leakage flow
+  double qva;                  // variable area leakage flow
+  double cfa;                  // fixed area leakage coeff.
+  double cva;                  // variable area leakage coeff.
+} Sleakage;
+
 /*
 ------------------------------------------------------
   Wrapper Data Structures
@@ -571,8 +613,7 @@ typedef struct {
     ErrTok,                // Index of error-producing token
     Unitsflag,             // Unit system flag
     Flowflag,              // Flow units flag
-    Pressflag,             // Pressure units flag
-    DefPat;                // Default demand pattern
+    Pressflag;             // Pressure units flag
 
   Spattern *PrevPat;       // Previous pattern processed
   Scurve   *PrevCurve;     // Previous curve processed
@@ -628,7 +669,10 @@ typedef struct {
     Rpt2Fname[MAXFNAME+1], // Secondary report file name
     DateStamp[26];         // Current date & time
 
-  SField   Field[MAXVAR];  // Output reporting fields
+    SField   Field[MAXVAR];  // Output reporting fields
+
+    void (*reportCallback)(void*,void*,const char*); // user-supplied reporting callback
+    void *reportCallbackUserData;  // user-supplied reporting context
 
 } Report;
 
@@ -688,7 +732,6 @@ typedef struct {
     *XLNZ,       // Start position of each column in NZSUB
     *NZSUB,      // Row index of each coeff. in each column
     *LNZ,        // Position of each coeff. in Aij array
-    *Degree,     // Number of links adjacent to each node
     *link,       // Array used by linear eqn. solver
     *first;      // Array used by linear eqn. solver
 
@@ -699,9 +742,11 @@ typedef struct {
 
   double
     *NodeHead,             // Node hydraulic heads
-    *NodeDemand,           // Node demand + emitter flows
-    *DemandFlow,           // Work array of demand flows
-    *EmitterFlow,          // Emitter outflows
+    *NodeDemand,           // Node total demand (consumer + emitter + leakage)
+    *FullDemand,           // Required consumer demand
+    *DemandFlow,           // Demand flow from nodes
+    *EmitterFlow,          // Emitter flow from nodes
+    *LeakageFlow,          // Leakage flow from nodes
     *LinkFlow,             // Link flows
     *LinkSetting,          // Link settings
     Htol,                  // Hydraulic head tolerance
@@ -728,15 +773,18 @@ typedef struct {
     MaxHeadError,          // Max. error for link head loss
     MaxFlowChange,         // Max. change in link flow
     DemandReduction,       // % demand reduction at pressure deficient nodes
+    LeakageLoss,           // % system leakage loss
     RelaxFactor,           // Relaxation factor for flow updating
     *P,                    // Inverse of head loss derivatives
     *Y,                    // Flow correction factors
     *Xflow;                // Inflow - outflow at each node
 
   int
+    DefPat,                // Default demand pattern
     Epat,                  // Energy cost time pattern
     DemandModel,           // Fixed or pressure dependent
     Formflag,              // Head loss formula flag
+    EmitBackFlag,          // Emitter backflow flag
     Iterations,            // Number of hydraulic trials taken
     MaxIter,               // Max. hydraulic trials allowed
     ExtraIter,             // Extra hydraulic trials
@@ -744,12 +792,18 @@ typedef struct {
     MaxCheck,              // Hydraulic trials limit on status checks
     OpenHflag,             // Hydraulic system opened flag
     Haltflag,              // Flag to halt simulation
-    DeficientNodes;        // Number of pressure deficient nodes
+    DeficientNodes,        // Number of pressure deficient nodes
+    HasLeakage;            // TRUE if project has non-zero leakage parameters
+    
+  Sleakage *Leakage;       // Array of node leakage parameters
 
   StatusType
     *LinkStatus,           // Link status
     *OldStatus;            // Previous link/tank status
 
+  SflowBalance
+    FlowBalance;           // Flow balance components
+
   Smatrix smatrix;         // Sparse matrix storage
 
 } Hydraul;

epyt_flow/EPANET/EPANET/SRC_engines/util/cstr_helper.c

@@ -0,0 +1,59 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/cstr_helper.c
+ Description:  Provides C string helper functions
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/02/2019
+ ******************************************************************************
+*/
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "cstr_helper.h"
+
+
+int cstr_duplicate(char **dest, const char *source)
+// Duplicates source string
+{
+    size_t size = 1 + strlen(source);
+    *dest = (char *) calloc(size, sizeof(char));
+
+    if (*dest == NULL)
+        return -1;
+    else {
+#ifdef _MSC_VER
+        strncpy_s(*dest, size, source, size);
+#else
+        strncpy(*dest, source, size);
+#endif
+    }
+    return 0;
+}
+
+
+bool cstr_isvalid(const char *element_id)
+// Determines if invalid characters are present in an element id string
+{
+    const char *invalid_chars = " \";";
+
+    // if invalid char is present a pointer to it is returned else NULL
+    if (strpbrk(element_id, invalid_chars))
+        return false;
+    else
+        return true;
+}
+
+
+bool cstr_isnullterm(const char *source)
+// Determines if the string passed is null terminated or not
+{
+    if (strchr(source, '\0'))
+        return true;
+    else
+        return false;
+}

epyt_flow/EPANET/EPANET/SRC_engines/util/cstr_helper.h

@@ -0,0 +1,38 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/cstr_helper.h
+ Description:  Provides C string helper functions
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/02/2019
+ ******************************************************************************
+*/
+
+#ifndef CSTR_HELPER_H_
+#define CSTR_HELPER_H_
+
+
+#include <stdbool.h>
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+
+int cstr_duplicate(char **dest, const char *source);
+
+bool cstr_isvalid(const char *element_id);
+
+bool cstr_isnullterm(const char *source);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+
+#endif /* CSTR_HELPER_H_ */

epyt_flow/EPANET/EPANET/SRC_engines/util/errormanager.c

@@ -0,0 +1,92 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/errormanager.c
+ Description:  Provides a simple interface for managing errors
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 08/02/2023
+ ******************************************************************************
+*/
+
+//#ifdef _WIN32
+//#define _CRTDBG_MAP_ALLOC
+//#include <stdlib.h>
+//#include <crtdbg.h>
+//#else
+#include <stdlib.h>
+//#endif
+#include <string.h>
+
+#include "errormanager.h"
+
+
+typedef struct error_s {
+    int error_status;
+	void (*p_msg_lookup)(int, char*, int);
+} error_handle_t;
+
+
+error_handle_t *create_error_manager(void (*p_error_message)(int, char*, int))
+//
+// Purpose: Constructs a new error handle.
+//
+{
+	error_handle_t *error_handle;
+	error_handle = (error_handle_t*)calloc(1, sizeof(error_handle_t));
+	if (error_handle == NULL) return NULL;
+
+	error_handle->p_msg_lookup = p_error_message;
+
+	return error_handle;
+}
+
+void delete_error_manager(error_handle_t *error_handle)
+//
+// Purpose: Destroys the error handle.
+//
+{
+	free(error_handle);
+}
+
+int set_error(error_handle_t *error_handle, int error_code)
+//
+// Purpose: Sets an error code in the handle.
+//
+{
+	// If the error code is 0 no action is taken and 0 is returned.
+	// This is a feature not a bug.
+	if (error_code)
+		error_handle->error_status = error_code;
+
+	return error_code;
+}
+
+int check_error(error_handle_t *error_handle, char **error_message)
+//
+// Purpose: Returns the error message or NULL.
+//
+// Note: Caller must free memory allocated by check_error
+//
+{   int error_code = error_handle->error_status;
+	char *temp = NULL;
+
+	if (error_code != 0) {
+		temp = (char*) calloc(ERR_MAXMSG + 1, sizeof(char));
+
+		if (temp)
+			error_handle->p_msg_lookup(error_code, temp, ERR_MAXMSG);
+	}
+    *error_message = temp;
+	return error_code;
+}
+
+void clear_error(error_handle_t *error_handle)
+//
+// Purpose: Clears the error from the handle.
+//
+{
+	error_handle->error_status = 0;
+}