Merge pull request #441 from cse-sim/airnet-msg-control

AirNet pressure warnings/errors: add user input / refine logic

Author: nealkruis

doc/src/records/top-members.md

@@ -411,6 +411,29 @@ AirNet relative convergence tolerance.  See AnTolAbs just above.
   required: "No",
   variability: "constant") %>
 
+**ANPressWarn=*float***
+
+AirNet pressure warning threshold. A warning message is issued when the absolute value of the AirNet-calculated zone pressure exceeds ANPressWarn.  Note the default for ANPressWarn conservatively large. 10 lb/ft2 is about 500 pascals -- a pressure that is probably impossible in a building.  The intent of this value is to alert the user to incorrect modeling inputs while avoiding excessive messages.
+
+<%= member_table(
+  units: "lb/ft2",
+  legal_range: "x $\\gt$ 0",
+  default: "10",
+  required: "No",
+  variability: "constant") %>
+
+**ANPressErr=*float***
+
+AirNet pressure error threshold.  The simulation terminates with a message if the absolute value of any AirNet-calculated zone pressure exceeds ANPressErr.  Note the default value for ANPressErr is physically unrealistic. 30 lb/ft2 is about 1500 pascals -- a pressure that would never be possible in a building.  The intent of this value is to prevent simulation crashes due to numerical errors in AirNet calculations.
+
+<%= member_table(
+  units: "lb/ft2",
+  legal_range: "x $\\gt$ 0",
+  default: "30",
+  required: "No",
+  variability: "constant") %>
+
+
 The ASHWAT complex fenestration model used when WINDOW wnModel=ASHWAT yields several heat transfer results that are accurate over local ranges of conditions.  Several values control when these value are recalculated.  If any of the specified values changes more than the associated threshold, a full ASHWAT calculation is triggered.  Otherwise, prior results are used.  ASHWAT calculations are computationally expensive and conditions often change only incrementally between time steps.
 
 **AWTrigT=*float***

src/CNRECS.DEF

@@ -130,14 +130,16 @@ RECORD TOPRAT "top" *RAT	/* top level RAT: contains control info and all once-on
 	*ovrcopy
 	*declare "void freeDM();"
 	*declare "const char* When( IVLCH ivl) const;"
-	*declare "int tp_IsLastStep() const { return isLastDay && isEndDay && isEndHour; }"	// TRUE iff last step of run
-	*declare "int tp_IsLastHour() const { return isLastDay && isEndDay; }"
+	*declare "bool tp_IsLastStep() const { return isLastDay && isEndDay && isEndHour; }"	// true iff last step of run
+	*declare "bool tp_IsLastHour() const { return isLastDay && isEndDay; }"
     *declare "RC FC brFileCk();"   			// checks inputs re binary results files.
     *declare "RC tp_CheckOutputFilePath( const char* filePath, const char** pMsg=NULL);"
     *declare "void tp_SetOptions();"
 	*declare "RC tp_SetDerived();"
     *declare "RC tp_SetCheckTimeSteps();"
 	*declare "RC tp_FazInit();"
+    *declare "RC tp_AirNetInit();"
+    *declare "void tp_AirNetDestroy();"
     *declare "void tp_ClearAuszFlags();"
     *declare "RC tp_Wfile( int* pHotMo);"
     *declare "RC tp_LocInit();"
@@ -233,11 +235,13 @@ RECORD TOPRAT "top" *RAT	/* top level RAT: contains control info and all once-on
 	*i FLOAT_GZ tp_AWTrigSlr;	// incident solar, fraction (default = .05)
 	*i FLOAT_GZ tp_AWTrigH;		// total surface coefficient (conv+rad), fraction (default=.1)
 
-//TOP: inputs: AirNet convergence criteria
+//TOP: inputs: AirNet convergence and error criteria
 								// a zone is deem converged iff
 								//  AMFnet <= max( tolAbs, tolRel*AMFTot)
 	*i FLOAT_GZ tp_ANTolAbs;	//   absolute tolerance, lbm/sec, dflt=.00125 (about 1 cfm)
 	*i FLOAT_GZ tp_ANTolRel;	//   relative tolerance, dflt = .0001
+    *i FLOAT_GZ tp_ANPressWarn; // AirNet pressure that triggers a warning, lb/ft2
+    *i FLOAT_GZ tp_ANPressErr;  // AirNet pressure that triggers a run-ending error, lb/ft2
 
 //TOP: inputs: other
     *i ANGLE tp_bldgAzm		// angle to add to all zone/surface azms
@@ -2225,6 +2229,7 @@ RECORD ZNR "zone" *RAT	// zone runtime info RAT.  Set mainly from separate ZNI
     *declare "RC zn_RadX();"
     *declare "RC zn_FFactors( struct SFPLIST& sfpList);"
     *declare "RC zn_RddInit();"
+    *declare "RC zn_RddDone( bool isAusz);"
 	*declare "RC zn_BegHour1();"
     *declare "RC zn_BegHour2();"
     *declare "RC zn_XFan();"
@@ -2455,6 +2460,9 @@ RECORD ZNR "zone" *RAT	// zone runtime info RAT.  Set mainly from separate ZNI
 									//   [ 1]=maximum (generally infil+vent)
    	*s *e *array 2 DBL zn_pz0W		// working zone pressures relative to patm at nominal z=0, lbf/sf
 									//  [ 0]=infil only; [ 1]=infil+ven
+    *y *e *array 2 INT zn_pz0WarnCount;  // # of unreasonable pressure warnings issued for this zone
+                                        //   [0]=infil only; [1]=infil+vent
+    *declare "RC zn_CheckAirNetPressure( int iV);"
 #if 0   // unused idea
 0    *declare "float zn_GetPressureAtFloorZ( int iV) const { return zn_pz0W[ iV] - i.zn_floorZ*zn_rho; }"
 #endif

src/cgcomp.cpp

@@ -2251,6 +2251,33 @@ RC IZXRAT::iz_EndSubhr()			// end-of-subhour vent calcs
 }		// IZXRAT::iz_EndSubhr
 //=============================================================================
 
+///////////////////////////////////////////////////////////////////////////////
+// Check / initialize for AirNet calcs
+///////////////////////////////////////////////////////////////////////////////
+RC TOPRAT::tp_AirNetInit()
+{
+
+	RC rc = RCOK;
+
+		// AIRNET msg triggers
+	if (Top.tp_ANPressWarn >= Top.tp_ANPressErr)
+		rc |= err("ANPressWarn (%0.1f) must be less than ANPressErr (%0.1f)", Top.tp_ANPressWarn, Top.tp_ANPressErr);
+
+	tp_pAirNet = new AIRNET();
+
+	return rc;
+
+}		// TOPRAT::tp_AirNetInit
+//-----------------------------------------------------------------------------
+void TOPRAT::tp_AirNetDestroy()
+// redundant calls OK
+{
+	delete tp_pAirNet;
+	tp_pAirNet = NULL;
+
+}	// TOPRAT::to_AirNetDestroy
+//=============================================================================
+
 ///////////////////////////////////////////////////////////////////////////////
 // struct AIRNET
 //   finds zone pressures that achieve balanced mass flows
@@ -2538,6 +2565,15 @@ RC AIRNET_SOLVER::an_Calc(			// airnet flow balance
 	if (!bConverge)
 		err(WRN, "%s: AirNet convergence failure", Top.When(C_IVLCH_S));
 
+	// change tiny pressures to 0
+	//   prevents trouble when doubles assigned to floats
+	for (zi = 0; zi < an_nz; zi++)
+	{
+		ZNR* zp = ZrB.GetAt(zi + zi0);
+		if (fabs(zp->zn_pz0W[iV]) < 1.e-20)
+			zp->zn_pz0W[iV] = 0.;
+	}
+
 	rc = RCOK;
 
 	TMRSTOP(TMR_AIRNET);
@@ -2548,33 +2584,60 @@ RC AIRNET_SOLVER::an_Calc(			// airnet flow balance
 RC AIRNET_SOLVER::an_CheckResults(
 	int iV)		// mode (0 or 1)
 {
-	static constexpr int MAXANERRORS = 100;
 
 	RC rc = RCOK;
-	if (an_unreasonablePressureCount >= MAXANERRORS)
-		return RCBAD;		// no further messages
-
+	
 	int zi0 = ZrB.GetSS0();
 	for (int zi = 0; zi < an_nz; zi++)
-	{
-		ZNR* zp = ZrB.GetAt(zi + zi0);
-		if (fabs(zp->zn_pz0W[iV]) > 10.)
-		{	// zone pressure > 10 lb/ft2 (= 500 Pa approx)
-			//   notify user
-			//   ignore during early autosizing --
-			//      transient unreasonable values have been seen
-			if (!Top.tp_autoSizing || Top.tp_pass2)
-			{
-				warn(
-					"Zone '%s', %s: unreasonable mode %d pressure %0.2f lb/ft2\n",
-					zp->Name(), Top.When(C_IVLCH_S), iV, zp->zn_pz0W[iV]);
-				if (++an_unreasonablePressureCount == MAXANERRORS)
-					rc = err("Too many unreasonable zone pressures, abandoning run.");
-			}
-		}
+	{	ZNR* zp = ZrB.GetAt(zi + zi0);
+		rc |= zp->zn_CheckAirNetPressure(iV);
 	}
+
+	// note zn_pz0WarnCount is reported in zn_RddDone()
+	
 	return rc;
 }	// AIRNET_SOLVER::an_CheckResults
+//-----------------------------------------------------------------------------
+RC ZNR::zn_CheckAirNetPressure(			// check zone pressure for reasonableness
+	int iV)	// mode (0 or 1)
+
+// checks zone pressure against tp_ANPressWarn and tp_anPressErr
+
+// returns RCOK iff run should continue
+//        RCBAD if error, run should stop
+
+{	
+	static constexpr int MAXANWARNINGMSGS = 50;	// max warning messages per zone
+	
+	RC rc = RCOK;
+	double pz0Abs = fabs( zn_pz0W[iV]);
+	if (pz0Abs > Top.tp_ANPressWarn)
+	{	// zone pressure > user-settable threshold
+		//   notify user
+		//   ignore during early autosizing --
+		//      transient unreasonable values have been seen
+		if (pz0Abs > Top.tp_ANPressErr)
+		{	// set rc to stop run
+			rc |= orer("mode %d pressure (%0.2f lb/ft2) exceeds ANPressErr (+/- %0.2f lb/ft2)."
+					    "\n    Abandoning run.",
+					    iV, zn_pz0W[iV], Top.tp_ANPressErr);
+		}
+		else if (!Top.tp_autoSizing || Top.tp_pass2)
+		{
+			++zn_pz0WarnCount[iV];
+			if (zn_pz0WarnCount[iV] <= MAXANWARNINGMSGS)
+				// do not set rc
+				orWarn("unreasonable mode %d pressure %0.2f lb/ft2%s",
+					iV, zn_pz0W[iV],
+					zn_pz0WarnCount[iV] == MAXANWARNINGMSGS
+						? "\n    Skipping further pressure warning messages for this zone/mode."
+						: "");
+
+		}
+	}
+
+	return rc;
+}		// ZNR::zn_CheckAirNetPressure
 //=============================================================================
 #else
 AIRNET::AIRNET()

src/cnausz.cpp

@@ -126,8 +126,8 @@ RC FC cgAusz()		// Autosizing entry point
 	Top.tp_ClearAuszFlags();		// error return insurance
 
 // end phase (autosize or main sim) stuff done even after initialization or run error
-	RC rc2 = cgRddDone(TRUE);		// cleanup also done (from tp_EndDesDay) after each design day. Redundant call ok. cnguts.cpp.
-	rc2 |= cgFazDone(TRUE);		// cleanup done once after all design days. cnguts.cpp.  Empty fcn 7-95.
+	RC rc2 = cgRddDone( true);		// cleanup also done (from tp_EndDesDay) after each design day. Redundant call ok. cnguts.cpp.
+	rc2 |= cgFazDone( true);		// cleanup done once after all design days. cnguts.cpp.  Empty fcn 7-95.
 	return rc ? rc : rc2;		// return exact rc from cgAuszI re ^C detection
 }				// cgAusz
 //-----------------------------------------------------------------------------------------------------------
@@ -147,7 +147,7 @@ LOCAL RC FC cgAuszI()		// Autosizing inner routine
     							//  If not verbose, continues line started in cse.cpp.
 	Top.tp_ClearAuszFlags();
 
-	CSE_EF( cgFazInit(TRUE));	// do initialization done once for all design days:
+	CSE_EF( cgFazInit( true));	// do initialization done once for all design days:
 								// Inits autoSizing & peak recording stuff in all objects.
 								// Calls AH::, TU::, HEATPLANT:: etc fazInit's, which call AUSZ::fazInit's
 								// (below, sets .az_px's, etc) & do addl object-specific init.
@@ -204,7 +204,7 @@ RC TOPRAT::tp_BegDesDay()	// init many things before start of repetitions for de
 
 	// init simulator to stardard state before each design day -- 70F zone temps, etc.
 	RC rc;
-	CSE_E( cgRddInit(TRUE));// init repeated for (main sim run or) each autoSize design day, cnguts.cpp.
+	CSE_E( cgRddInit( true));// init repeated for (main sim run or) each autoSize design day, cnguts.cpp.
 							// sets initial state of zones & systems; calls AH::rddInit's, etc.
 							// also allocs results records not used in autosizing, etc, ... .
 							// calls asRddiInit in this file: clears peaks.
@@ -258,7 +258,7 @@ RC TOPRAT::tp_EndDesDay()	// call when done with design day
 	tp_auszDsDayItr = tp_auszDsDayItrMax = 0;	// used eg in exman.cpp::rerIV
 
 // end run stuff: close weather file, import files, binRes, location, etc. cnguts.cpp.
-	RC rc = cgRddDone(TRUE);  			// may also be called at completion of phase; redundant call ok.
+	RC rc = cgRddDone( true);  			// may also be called at completion of phase; redundant call ok.
 
 	return rc;
 }			// TOPRAT::tp_EndDesDay
@@ -710,10 +710,9 @@ LOCAL WStr MakeNotDoneList()
 //===========================================================================================================
 //  cse MAIN SIMULATION support function(s) that use AUSZ stuff
 //===========================================================================================================
-RC FC asFazInit([[maybe_unused]] int isAusz)			// main sim run or autoSize phase init: portion in this file
+RC FC asFazInit([[maybe_unused]] bool isAusz)	// main sim run or autoSize phase init: portion in this file
 
 {
-	// caller: cnguts:cgFazInit() 6-95
 	return RCOK;			// empty fcn, 7-95
 }			// asFazInit
 //-----------------------------------------------------------------------------------------------------------

src/cncult.cpp

@@ -2783,9 +2783,12 @@ CULT cnTopCult[] = 		// Top level table, points to all other tables, used in cal
 	CULT( "AWTrigT",	 DAT,   TOPRAT_AWTRIGT,    0,          0, VEOI,   TYFL,  0,      1.f,            N,   N),
 	CULT( "AWTrigSlr",   DAT,   TOPRAT_AWTRIGSLR,  0,          0, VEOI,   TYFL,  0,      .05f,           N,   N),
 	CULT( "AWTrigH",	 DAT,   TOPRAT_AWTRIGH,    0,          0, VEOI,   TYFL,  0,      .1f,            N,   N),
-// TOP AirNet convergence tolerances (1-2015)
+// TOP AirNet convergence tolerances and msg thresholds
 	CULT( "ANTolAbs",	 DAT,   TOPRAT_ANTOLABS,   0,          0, VEOI,   TYFL,  0,      0.00125f,       N,   N),
 	CULT( "ANTolRel",    DAT,   TOPRAT_ANTOLREL,   0,          0, VEOI,   TYFL,  0,      0.0001f,        N,   N),
+	CULT( "ANPressWarn", DAT,   TOPRAT_ANPRESSWARN,0,          0, VEOI,   TYFL,  0,      10.f,           N,   N),
+	CULT( "ANPressErr",  DAT,   TOPRAT_ANPRESSERR, 0,          0, VEOI,   TYFL,  0,      30.f,           N,   N),
+
 // TOP other
 	CULT( "bldgAzm",     DAT,   TOPRAT_BLDGAZM,    0,          0, VEOI,   TYFL,  0,      0.f,            N,   N),
 	CULT( "skymodel",    DAT,   TOPRAT_SKYMODEL,   0,          0, VEOI,   TYCH,  0,   C_SKYMODCH_ANISO,  N,   N),

src/cncult2.cpp

@@ -455,20 +455,21 @@ RC TOPRAT::tp_FazInit()	// start-of-phase init
 #if defined( DEBUGDUMP)
 	DbDo(dbdSTARTRUN);		// init debug print scheme (re heading control)
 	tp_SetDbMask();		// debug printout mask (dbdXXX), controls internal val dumping
-							//   (can change hourly, set initial value here re print from setup code)
+	//   (can change hourly, set initial value here re print from setup code)
 #endif
 
 //---- find/read weather file name / get lat, long, tz, default elevation, default autosizing stuff. 1-95.
 	int hotMo = 7;				// hottest month 1-12, wthr file hdr to topAusz, July if not set by topWfile
 	CSE_E(tp_Wfile(&hotMo))		// just below. call b4 topAusz.
 
-//---- autosizing setup. call after topWfile. 6-95.
-	CSE_E(tp_Ausz(hotMo))
+		//---- autosizing setup. call after topWfile. 6-95.
+		CSE_E(tp_Ausz(hotMo))
 
-//---- say various texts should be (re)generated before (any further) use as may have new runTitle, repHdrL/R.
-	freeRepTexts();				// cncult4.cpp
+		//---- say various texts should be (re)generated before (any further) use as may have new runTitle, repHdrL/R.
+		freeRepTexts();				// cncult4.cpp
 
-	tp_pAirNet = new AIRNET();
+	// check and set up AIRNET
+	rc |= tp_AirNetInit();
 
 	return rc;
 }			// TOPRAT::tp_fazInit
@@ -827,8 +828,7 @@ void TOPRAT::freeDM()		// free child objects in DM
 	tp_brFileName.Release();
 #endif
 
-	delete tp_pAirNet;
-	tp_pAirNet = NULL;
+	tp_AirNetDestroy();		// cleanup / delete AirNet machinery
 
 	tp_PumbraDestroy();		// cleanup / delete Penumbra shading machinery