CSE 0.827

Penumbra instantiated iff needed
Reduced OpenGL requirements
Better Penumbra error messages

Author: chipbarnaby

src/CGWTHR.CPP

@@ -66,8 +66,8 @@ RC TOPRAT::tp_WfInit()  	// Initialize weather file.  Displays any error message
 // also uses: Top.tp_wfName [,.isDT]
 // returns non-RCOK if error, message already issued.
 {
-	RC rc = Wfile.wf_Open( tp_wfName, tp_TDVfName, WRN);	// open wthr file and option TDV file
-															// init WFILE object msg if error.
+	RC rc = Wfile.wf_Open( tp_wfName, tp_TDVfName);	// open wthr file and option TDV file
+													// init WFILE object, msg if error.
 	if (!rc)
 		rc = Wfile.wf_FillWDYEAR( WRN);
 	return rc;

src/CNCULT2.CPP

@@ -469,7 +469,7 @@ RC TOPRAT::tp_Wfile(		// find/check weather file / init top members with data fr
 		ppFindFile( tp_TDVfName);		// auxiliary TDV (time dependent value) file if any
 
 // open weather file
-	RC rc = Wfile.wf_Open( tp_wfName, tp_TDVfName, WRN);	// reports err if can't open.
+	RC rc = Wfile.wf_Open( tp_wfName, tp_TDVfName);	// reports err if can't open.
 	if (!rc)					// if opened ok
 	{
 		// fetch latitude, longitude, time zone to Top members
@@ -767,6 +767,9 @@ void TOPRAT::freeDM()		// free child objects in DM
 #endif
 	delete tp_pAirNet;
 	tp_pAirNet = NULL;
+
+	tp_PumbraDestroy();		// cleanup / delete Penumbra shading machinery
+
 	//CHP monStr does not point into dm.
 }		// TOPRAT::freeDM
 //---------------------------------------------------------------------------

src/CNGLOB.H

@@ -470,6 +470,7 @@ typedef void* DMP;	// Dynamic memory block pointer: ptr to any type, record stru
 inline void IncP( void **pp, int b) { *pp = (void *)((char*)(*pp) + b); }
 typedef USI PSOP;	// type for pseudo-code opcodes -- used in sevaral .cpp files and in cuparse.h
 struct RXPORTINFO;
+namespace Pumbra { class Penumbra; }
 
 #ifdef WINorDLL
   // control of scattered code for returning file names used via a cne() argument.

src/CNRECS.DEF

@@ -298,6 +298,7 @@ RECORD TOPRAT "top" *RAT	/* top level RAT: contains control info and all once-on
 //TOP: setup: exterior (non-overhang/fin) shading
 	*r INT tp_exshNShade;		// # of shading surfaces in model
 	*r INT tp_exshNRec;			// # of receiving surfaces in model (may also be shading)
+	*declare "int tp_ExshCount();"
 	*declare "RC tp_ExshRunInit();"
 	*declare "RC tp_ExshBegHour();"
 
@@ -569,6 +570,15 @@ x								// not maintained, 12-12
 // TOP: runtime: AIRNET solution
 	*declare "AIRNET* tp_pAirNet;"
 
+// TOP: runtime: pointer to Penumbra (GPU shading) object
+//      instantiated iff needed
+	*declare "class Pumbra::Penumbra* tp_pPumbra;"
+	*declare "RC tp_PumbraInit();"
+	*declare "int tp_PumbraClearIf();"
+	*declare "void tp_PumbraDestroy();"
+	*declare "int tp_PumbraAvailability() const;"
+	*declare "RC tp_PumbraSetModel();"
+
     *r SI ck5aa5		// stuffed with 0x5aa5 from topCult for verifying initialization & matching versions
 *END		// TOPRAT
 
@@ -621,13 +631,13 @@ RECORD PY4 "4th power poly sub" *SUBSTRUCT	// 4th power polynomial. for GT, whic
 RECORD WFILE "weatherFile" *RAT	// weather file info, one static instance "Wfile", made a record 1-94 so probe-able
 
 // CAUTION: record layout matches code in wfpak.cpp, do not change without updating header decode !!
-
+    *prefix wf_
     *excon			// declare constructor WFILE( basAnc *b, TI i, SI noZ=0) in wfpak.cpp: calls init().
     *exdes			// d'tor
     *ovrcopy		// overridden Copy()
     *declare "WFILE();"		// default c'tor
     *declare "void wf_Init();"	// initialization member fcn
-    *declare "RC wf_Open( const char* wfName, const char* TDVfName, int erOp=WRN, int wrA=FALSE, char* hdr=NULL,"
+    *declare "RC wf_Open( const char* wfName, const char* TDVfName, int erOp=ERR, int wrA=FALSE, char* hdr=NULL,"
     *declare "    float* clrnss=NULL, float* turbid=NULL, float* atmois=NULL);"
 	*declare "RC wf_Close( char *hdr=NULL);"
 	*declare "const char* wf_FilePath() const;"
@@ -660,7 +670,7 @@ RECORD WFILE "weatherFile" *RAT	// weather file info, one static instance "Wfile
 
      *declare "int wf_IsPacked() const { return wFileFormat==BSGS || wFileFormat==BSGSdemo || wFileFormat==ET1 || wFileFormat==ET2; }"
 
- // Header info: from file hdr decode (wfpak:wfOpen) or computed from hourly
+ // Header info: from file hdr decode or computed from hourly
     *r WFLOC loc		// char loc[]  Location (for ET, is loc 1 only: city etc).
     *r WFLID lid		// char lid[]  Location ID
     *r SI yr			// Year of weather data (00 - 99, -1 if N/A)
@@ -696,8 +706,8 @@ RECORD WFILE "weatherFile" *RAT	// weather file info, one static instance "Wfile
     // *array 12 *r float atmois	// monthly aveage atmospheric moisture, for daylight calcs
 
 // TDV file header info
-    *r WFLOC wf_TDVFileTimeStamp		// timestamp string
-	*r WFLOC wf_TDVFileTitle			// title string (identifies file CZ, fuel, vintage, )
+    *f WFLOC wf_TDVFileTimeStamp	// timestamp string
+	*f WFLOC wf_TDVFileTitle		// title string (identifies file CZ, fuel, vintage, )
 
  //internal
     *r *hide SI hdrBytes 	// # header bytes before first record (used in wfread for file positioning)

src/MSGTBL.CPP

@@ -1527,7 +1527,7 @@ x  { MH_T0003, "\nReport file name: %s" },
 	{ MH_I0116, "I0116: Unrecognized character(s) after %snumber \"%s\"." },
 	{ MH_I0117, "I0117: Internal error: Invalid call to YACAM::get(): \n    NULL not found at end arg list.\n" },
 	//errFlLn meta-message, no msg number in text:
-	{ MH_I0118, ": Error in %s %s near line %d:\n  %s" },
+	{ MH_I0118, "%s '%s' (near line %d):\n  %s" },
 
 // nb: no terminator, use msgTblCount
 };

src/PVCalc.cpp

@@ -401,7 +401,7 @@ RC PVARRAY::pv_CalcPOA()
 	// Calculate plane-of-array incidence
 	int sunupSrf;	// nz iff
 	float cosi, fBeam;
-	if (pv_HasPenumbraShading())
+	if (pv_HasPenumbraShading() && Top.tp_PumbraAvailability() > 0)
 		sunupSrf = pv_CalcBeamShading( cosi, fBeam);
 	else
 	{	// tracking: Penumbra shading not supported

src/SHADING.CPP

@@ -37,8 +37,13 @@
 
 #include <penumbra/penumbra.h>
 
+#define PUMBRAIF
+#if defined PUMBRAIF
+#define PUMBRA( m) (Top.tp_pPumbra->m)
+#else
 static Pumbra::Penumbra pumbra;
-
+#define PUMBRA( m) (pumbra.m)
+#endif
 
 ///////////////////////////////////////////////////////////////////////////////
 // overhang/fin shading
@@ -420,7 +425,7 @@ int SURFGEOMDET::gxd_SetupShading(	// convert polygon to Penumbra format
 				plg.push_back( float( p3[ iD]));
 		}
 		Pumbra::Surface pnSurf( plg);
-		pnIdx = pumbra.addSurface( pnSurf);
+		pnIdx = PUMBRA( addSurface( pnSurf));
 	}
 	return pnIdx;
 }		// SURFGEOMDET::gxd_SetupShading
@@ -583,12 +588,12 @@ int SURFGEOM::gx_CalcBeamShading(		// beam shading for current hour
 		slsdc( azm, kPiOver2-alt, dcSun);
 		cosi = DotProd3( dcSrf, dcSun);		// replace cosi with value
 											//   consistent with alt and azm
-		if (pumbra.setSunPosition( azm, alt) != Pumbra::PN_SUCCESS)
+		if (PUMBRA(setSunPosition)( azm, alt) != Pumbra::PN_SUCCESS)
 		{	cosi = fBeam = 0.f;
 			sunupSrf = -1;	// unexpected
 		}
 		else
-		{	float PSSF = pumbra.calculatePSSF( gx_pnIdx);
+		{	float PSSF = PUMBRA( calculatePSSF)( gx_pnIdx);
 			fBeam = PSSF / (cosi*gx_area);
 			if (fBeam > 1.f)
 			{	
@@ -666,23 +671,130 @@ RC SHADEX::sx_CkF()
 ///////////////////////////////////////////////////////////////////////////////
 // TOPRAT interface to shading model
 ///////////////////////////////////////////////////////////////////////////////
-static void PemumbraMessageHandler(
+static void PenumbraMessageHandler(
 	const int messageType,
 	const std::string message,
 	void* contextPtr)
 {
-	contextPtr;
+	// TOPRAT* pTop = (TOPRAT *)contextPtr;
 
-	(messageType == Pumbra::MSG_ERR ? per : messageType == Pumbra::MSG_WARN ? pWarn : pInfo)
-		( "Penumbra msg: %s", message.c_str());
+	int erOp;
+	const char* what;
+	if (messageType == Pumbra::MSG_ERR)
+	{	erOp = ABT;		// message / keypress / abort
+		what = "error";
+	}
+	else if (messageType == Pumbra::MSG_WARN)
+	{	erOp = ERR;		// message / keypress / continue
+		what = "warning";
+	}
+	else
+	{	erOp = INF;		// message / continue
+		what = "info";
+	}
+	err(
+		erOp | NOPREF,			// do not prepend "Error:"
+		"Shading %s: %s", what, message.c_str());
 
 }		// penumbraMessageHandler
 //-----------------------------------------------------------------------------
+RC TOPRAT::tp_PumbraInit()
+{	RC rc = RCOK;
+	if (!tp_pPumbra)
+	{	const int size = 512;	// context size (=# of pixels)
+		tp_pPumbra = new Pumbra::Penumbra( PenumbraMessageHandler, this, size);
+		if (!tp_pPumbra)
+			rc = RCBAD;		// not expected
+	}
+	else
+		tp_PumbraClearIf();
+
+	return rc;
+}	// TOPRAT::tp_PumbraInit
+//-----------------------------------------------------------------------------
+void TOPRAT::tp_PumbraDestroy()
+{	delete tp_pPumbra;
+	tp_pPumbra = NULL;
+}		// TOPRAT::tp_PumbraDestroy
+//-----------------------------------------------------------------------------
+int TOPRAT::tp_PumbraClearIf()		// clear Penumbra data if any
+// returns 0 if Penumbra not instantiated, nothing done
+//         1 if data successfully cleared
+{	if (!tp_pPumbra)
+		return 0;		// nothing to do
+
+	tp_pPumbra->clearModel();
+	return 1;
+}		// TOPRAT::tp_PumbraClearIf
+//-----------------------------------------------------------------------------
+int TOPRAT::tp_PumbraAvailability() const
+{
+	return tp_pPumbra != NULL;
+}		// TOPRAT::tp_PumbraAvailability
+//-----------------------------------------------------------------------------
+RC TOPRAT::tp_PumbraSetModel()
+{
+	RC rc = tp_pPumbra->setModel() == Pumbra::PN_SUCCESS
+				? RCOK
+				: RCBAD;
+	// message?
+	return rc;
+}		// TOPRAT::tp_PumbraSetModel
+//-----------------------------------------------------------------------------
+int TOPRAT::tp_ExshCount()
+// returns nz if current project has ANY shading surface
+{
+	int pvCount = 0;
+	PVARRAY* pPV;
+	RLUP( PvR, pPV)
+	{	if (pPV->pv_HasPenumbraShading())
+			pvCount++;
+	}
+
+	int sxCount = SxR.GetCount();
+
+	tp_exshNShade = pvCount + sxCount;	// # of shade surfaces
+	tp_exshNRec = pvCount;				// # of receiving surfaces
+
+	return pvCount > 1 || (pvCount > 0 && sxCount > 0);
+}	// TOPRAT::tp_ExshCount
+//-----------------------------------------------------------------------------
 RC TOPRAT::tp_ExshRunInit()		// start-of-run init for Penumbra shading
 // sets up Penumbra model from all shading or receiving objects
 {
 	RC rc = RCOK;
 
+#if defined( PUMBRAIF)
+	if (!tp_ExshCount())
+	{	tp_PumbraClearIf();		// clear Penumbra data if any
+		return RCOK;
+	}
+
+	// shading is required
+	tp_PumbraInit();
+
+	// building rotation
+	//   construct rotation matrix re C_SHADETY_BLDG
+	CT3D MRot( 1);		// rotation matrix
+	MRot.Rotate( tp_bldgAzm, -2);	// rotate about z axis
+									//  -2 = right-handed coord system
+
+	int NShade = 0;		// # of shade surfaces
+	int NRec = 0;		// # of receiving surfaces
+
+	// create Penumbra surface model
+	PVARRAY* pPV;
+	RLUP( PvR, pPV)
+		rc |= pPV->pv_SetupShading( NRec, &MRot);
+
+	SHADEX* pSX;
+	RLUP( SxR, pSX)
+		rc |= pSX->sx_SetupShading( NShade, &MRot);
+
+	if (!rc)
+		rc = tp_PumbraSetModel();
+#else
+
 	// route Penumbra messages to CSE output
 	//   use pumbra as context even though only one
 	pumbra.setMessageCallback( PemumbraMessageHandler, &pumbra);
@@ -712,7 +824,7 @@ RC TOPRAT::tp_ExshRunInit()		// start-of-run init for Penumbra shading
 	{	if (pumbra.setModel() != Pumbra::PN_SUCCESS)
 			rc |= RCBAD;
 	}
-
+#endif
 	return rc;
 
 }		// TOPRAT::tp_ExshRunInit
@@ -740,5 +852,6 @@ RC TOPRAT::tp_ExshBegHour()		// once-per-hour exterior shading setup
 }		// TOPRAT::tp_ExshBegHour
 
 
+
 // shading.cpp end
 

src/WFPAK.CPP

@@ -1037,7 +1037,8 @@ RC WFILE::wf_Open(	// Open existing weather file and initialize WFILE structure
 
 	const char* wfName,		// file path
 	const char* TDVfName,	// optional TDV file path, NULL = no TDV file
-	int erOp /*=WRN*/,		// error handling: WRN, IGN etc
+	int erOp /*=ERR*/,		// error handling: ERR, WRN, IGN etc
+							//   default ERR: report error, return rc != RCOK
 	int wrAccess/*=FALSE*/,	// write access desired. Used only in utilities (not in CSE).
 	char* hdr /*=NULL*/,	// non-null to return raw header of packed files. For wthr utility programs.
 							// WFHDRSZ bytes returned even if file's hdr smaller.
@@ -1048,7 +1049,7 @@ RC WFILE::wf_Open(	// Open existing weather file and initialize WFILE structure
 	float* turbid /*=NULL*/,	// receives 12 monthly average atmospheric turbidity values
 	float* atmois /*=NULL*/ )	// receives 12 monthly average atmospheric moisure values
 
-// returns RCOK if all ok,
+// returns RCOK iff success
 //		else other value, message issued per erOp
 
 // sets isLeap if leap year file (future ET1 files 10-94).
@@ -1095,7 +1096,7 @@ x 							   xfFindOnPath issued msg per erOp.*/
 		RC rcTDV = wf_TDVOpen( TDVfName, erOp);
 		if (rcTDV)
 		{	err( erOp,			// display msg per erOp, rmkerr.cpp
-			 rc==RCBAD2
+			 rcTDV==RCBAD2
 			   ? (char *)MH_R0101	//  "R0101: %s file '%s': bad format or header"
 			   : (char *)MH_R0100,	//  "R0100: %s file '%s': open failed"
 			 "TDV",  TDVfName);
@@ -1761,8 +1762,10 @@ RC WFILE::wf_TDVReadHdr( int erOp)		// read / decode TDV file header
 
 	// initial tag
 	rc = yacTDV->getLineCSV( erOp, 0, "CC", _C( T1), _C( T2), NULL);
-	if (!strMatch( T1, "TDV Data (TDV/Btu)"))
-		rc = err( erOp, "Munged header");
+	const char* TDVFileTag = "TDV Data (TDV/Btu)";
+	if (!strMatch( T1, TDVFileTag))
+		rc =  yacTDV->errFlLn( "Incorrect first item \"%s\" -- expected \"%s\"",
+				T1, TDVFileTag);
 	if (!rc)
 		// time stamp
 		rc = yacTDV->getLineCSV( erOp, 0, "C", _C( wf_TDVFileTimeStamp), NULL);
@@ -1773,8 +1776,8 @@ RC WFILE::wf_TDVReadHdr( int erOp)		// read / decode TDV file header
 		// column heads (ignored)
 		rc = yacTDV->getLineCSV( erOp, 0, "CC", _C(T1), _C( T2), NULL);
 
-	if (!rc)
-		wf_TDVInitHdrInfo();
+	if (rc)
+		wf_TDVInitHdrInfo();	// error: clear any partial data
 
 	return rc;