Merge develop into this branch, resolve conflicts;

[#972110]

.gitignore

@@ -2,6 +2,8 @@
 *.d
 *.dll
 *.exe
+*.gcda
+*.ilk
 *.lib
 *.log
 *.map

CMakeLists.txt

@@ -6,7 +6,9 @@ set( CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH}
 
 set( CMAKE_VERSION_MAJOR 8 )
 set( CMAKE_VERSION_MINOR 2 )
-set( CMAKE_VERSION_PATCH 3 ) 
+set( CMAKE_VERSION_PATCH 4 ) 
+
+set( ENERGYPLUS_VERSION "${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}.${CMAKE_VERSION_PATCH}" )
 
 set( CMAKE_VERSION_BUILD "Unknown" CACHE STRING "Build number" )
 find_package(Git)
@@ -96,6 +98,12 @@ INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/ObjexxFCL/src/ )
 INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/SQLite/ SYSTEM )
 INCLUDE_DIRECTORIES("${CMAKE_SOURCE_DIR}/third_party/Expat" "${CMAKE_SOURCE_DIR}/third_party/Expat/lib" SYSTEM)
 
+if( BUILD_TESTING )
+  option( TEST_ANNUAL_SIMULATION "Use annual simulations for tests instead of only design days" OFF )
+  enable_testing()
+  include(CTest)
+endif()
+
 # E+ required libraries
 ADD_SUBDIRECTORY(third_party/SQLite)
 ADD_SUBDIRECTORY(third_party/ObjexxFCL)
@@ -112,9 +120,6 @@ ENDIF()
 ADD_SUBDIRECTORY(src/EnergyPlus)
 
 if( BUILD_TESTING )
-  option( TEST_ANNUAL_SIMULATION "Use annual simulations for tests instead of only design days" OFF )
-  enable_testing()
-  include(CTest)
   ADD_SUBDIRECTORY(third_party/gtest)
   ADD_SUBDIRECTORY(testfiles)
   ADD_SUBDIRECTORY(tst/EnergyPlus/unit)

README.md

@@ -7,7 +7,7 @@ This is the EnergyPlus Development Repository.
 
  - The Department of Energy maintains a [public website for EnergyPlus](www.energyplus.gov) where you can find much more information about the program.  
  - For detailed developer information, consult the [wiki](https://github.com/nrel/EnergyPlusTeam/wiki).  
- - For support questions, plese utilize the [EnergyPlus Helpdesk](http://energyplus.helpserve.com/).
+ - For support questions, please utilize the [EnergyPlus Helpdesk](http://energyplus.helpserve.com/).
 
 # Releases
 Although iteration **(pre-)releases** will be posted to this repository during a development cycle, users should generally avoid these, as input syntax may change which won't be supported by the major release version transition tools, and could require manual intervention to remedy.  If a release is intended for active use by users, such as a bug-fix-only or performance-only re-release, it will be clearly specified on the release notes and a public announcement will accompany this type of release.
@@ -31,7 +31,7 @@ The C++ code in EnergyPlus utilizes many C++11 features, and so a modern compile
 6. Check the configuration settings, keeping them default should suffice, and click Generate.
 7. Browse to the build folder and there will be a Visual Studio solution file you can click on, and it will include multiple projects for each build target.  Choose the type of build (Debug or Release), then right click on EnergyPlus in the solution explorer and "Build".  This will build EnergyPlus and all of its dependencies.  The target executables will be found in the Products subfolder.
 8. The solution will include the ZERO_CHECK project as the default target to run when you execute, so when you are ready to debug, manually set the default target to EnergyPlus.
-9. In the EnergyPlus and EnergyPlusLib projects: right click on each project and select Properties. Under Configuration Properties select Debugging. In the Enviroment field, enter ```_NO_DEBUG_HEAP=1```, without quote marks.  The debug heap in Visual Studio doesn't play nicely with the input processor in EnergyPlus, and for debug builds, skipping this will result in a _very_ long IDD reading time.
+9. In the EnergyPlus and EnergyPlusLib projects: right click on each project and select Properties. Under Configuration Properties select Debugging. In the Enviroment field, enter ```_NO_DEBUG_HEAP=1```.  The debug heap in Visual Studio doesn't play nicely with the input processor in EnergyPlus, and for debug builds, skipping this will result in a _very_ long IDD reading time.
 
 ## Linux
 

bin/README.md

@@ -0,0 +1 @@
+I was hoping there would be no binaries in the main repo.  But alas, here is EPMacro.  The code is too awful to translate up to gfortran.  But I want to start including the macro files in the test suite.  

cmake/CMakeCPackOptions.cmake.in

@@ -80,7 +80,7 @@ if(CPACK_GENERATOR MATCHES "NSIS")
       CopyFiles \"$INSTDIR\\temp\\Gswdll32.dll\" \"$WINDIR\\SysWOW64\\Gswdll32.dll\"
       CopyFiles \"$INSTDIR\\temp\\Gsw32.exe\" \"$WINDIR\\SysWOW64\\Gsw32.exe\"
       CopyFiles \"$INSTDIR\\temp\\Graph32.ocx\" \"$WINDIR\\SysWOW64\\Graph32.ocx\"
-      CopyFiles \"$INSTDIR\\temp\\MSINET.OCX\" \"$WINDIR\\SysWOW64\\MSINET.OCX]\"
+      CopyFiles \"$INSTDIR\\temp\\MSINET.OCX\" \"$WINDIR\\SysWOW64\\MSINET.OCX\"
       CopyFiles \"$INSTDIR\\temp\\Vsflex7L.ocx\" \"$WINDIR\\SysWOW64\\Vsflex7L.ocx\"
       CopyFiles \"$INSTDIR\\temp\\Msflxgrd.ocx\" \"$WINDIR\\SysWOW64\\Msflxgrd.ocx\"
       RegDLL \"$WINDIR\\SysWOW64\\MSCOMCTL.OCX\"
@@ -97,7 +97,7 @@ if(CPACK_GENERATOR MATCHES "NSIS")
       CopyFiles \"$INSTDIR\\temp\\Gswdll32.dll\" \"$WINDIR\\System32\\Gswdll32.dll\"
       CopyFiles \"$INSTDIR\\temp\\Gsw32.exe\" \"$WINDIR\\System32\\Gsw32.exe\"
       CopyFiles \"$INSTDIR\\temp\\Graph32.ocx\" \"$WINDIR\\System32\\Graph32.ocx\"
-      CopyFiles \"$INSTDIR\\temp\\MSINET.OCX\" \"$WINDIR\\System32\\MSINET.OCX]\"
+      CopyFiles \"$INSTDIR\\temp\\MSINET.OCX\" \"$WINDIR\\System32\\MSINET.OCX\"
       CopyFiles \"$INSTDIR\\temp\\Vsflex7L.ocx\" \"$WINDIR\\System32\\Vsflex7L.ocx\"
       CopyFiles \"$INSTDIR\\temp\\Msflxgrd.ocx\" \"$WINDIR\\System32\\Msflxgrd.ocx\"
       RegDLL \"$WINDIR\\System32\\MSCOMCTL.OCX\"

cmake/ProjectMacros.cmake

@@ -64,7 +64,8 @@ macro(ADD_GOOGLE_TESTS executable)
       string(REGEX MATCHALL "TEST_?F?\\(([A-Za-z_0-9 ,]+)\\)" found_tests ${contents})
       foreach(hit ${found_tests})
         string(REGEX REPLACE ".*\\(( )*([A-Za-z_0-9]+)( )*,( )*([A-Za-z_0-9]+)( )*\\).*" "\\2.\\5" test_name ${hit})
-        add_test(${test_name} "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${executable}" --gtest_filter=${test_name})
+        add_test(NAME ${test_name} 
+                 COMMAND "${executable}" "--gtest_filter=${test_name}")
       endforeach(hit)
     endif()
   endforeach()
@@ -110,7 +111,7 @@ macro( CREATE_TEST_TARGETS BASE_NAME SRC DEPENDENCIES )
 endmacro()
 
 function( ADD_SIMULATION_TEST )
-  set(options ANNUAL_SIMULATION DESIGN_DAY_ONLY)
+  set(options ANNUAL_SIMULATION DESIGN_DAY_ONLY EXPECT_FATAL)
   set(oneValueArgs IDF_FILE EPW_FILE)
   set(multiValueArgs "")
   cmake_parse_arguments(ADD_SIM_TEST "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
@@ -136,10 +137,16 @@ function( ADD_SIMULATION_TEST )
     -P ${CMAKE_SOURCE_DIR}/cmake/RunSimulation.cmake
   )  
 
-  SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES PASS_REGULAR_EXPRESSION "Test Passed")
-  SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES FAIL_REGULAR_EXPRESSION "ERROR;FAIL;Test Failed")
+  # Added the expect_fatal here to detect files that are expected to fatal error properly
+  if( ADD_SIM_TEST_EXPECT_FATAL )
+    SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES PASS_REGULAR_EXPRESSION "Test Failed")
+    SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES FAIL_REGULAR_EXPRESSION "ERROR;FAIL;Test Passed")
+  else()
+    SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES PASS_REGULAR_EXPRESSION "Test Passed")
+    SET_TESTS_PROPERTIES("integration.${IDF_NAME}" PROPERTIES FAIL_REGULAR_EXPRESSION "ERROR;FAIL;Test Failed")
+  endif()
 
-  if( DO_REGRESSION_TESTING )
+  if( DO_REGRESSION_TESTING AND (NOT ADD_SIM_TEST_EXPECT_FATAL) )
     add_test(NAME "regression.${IDF_NAME}" COMMAND ${CMAKE_COMMAND}
       -DBINARY_DIR=${CMAKE_BINARY_DIR}
       -DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}
@@ -158,7 +165,6 @@ function( ADD_SIMULATION_TEST )
     set_tests_properties("regression.${IDF_NAME}" PROPERTIES FAIL_REGULAR_EXPRESSION "ERROR;FAIL;Test Failed")
   endif()
 
-
 endfunction()
 
 macro( ADD_CXX_DEFINITIONS NEWFLAGS )

cmake/RunCallbackTest.cmake

@@ -0,0 +1,29 @@
+  # Set up for convenience
+  set(TEST_DIR "tst/api_callback")
+  set( ENV{DDONLY} y)
+
+  # Currently the TestEnergyPlusCallbacks runner does not exit. Give it an idf and supporting files so that it will run.
+  execute_process(COMMAND "${CMAKE_COMMAND}" -E copy "${SOURCE_DIR}/testfiles/${IDF_FILE}" "${BINARY_DIR}/${TEST_DIR}/in.idf" )
+  execute_process(COMMAND "${CMAKE_COMMAND}" -E copy "${SOURCE_DIR}/weather/${EPW_FILE}" "${BINARY_DIR}/${TEST_DIR}/in.epw" )
+  execute_process(COMMAND "${CMAKE_COMMAND}" -E copy "${BINARY_DIR}/Energy+.idd" "${BINARY_DIR}/${TEST_DIR}/Energy+.idd" )
+
+  # Find and execute the test executable, passing the argument of the directory to run in
+  if( WIN32 )
+    set(ECHO_CMD cmd /C echo.)
+  else()
+    set(ECHO_CMD "echo")
+  endif()
+  find_program(TEST_EXE TestEnergyPlusCallbacks PATHS "${BINARY_DIR}/Products/" "${BINARY_DIR}/Products/Release/" "${BINARY_DIR}/Products/Debug/" )
+  execute_process(COMMAND ${ECHO_CMD} COMMAND "${TEST_EXE}" "${BINARY_DIR}/${TEST_DIR}")
+
+  # Clean up
+  execute_process(COMMAND "${CMAKE_COMMAND}" -E remove "${BINARY_DIR}/${TEST_DIR}/Energy+.idd" "${BINARY_DIR}/${TEST_DIR}/in.epw" )
+
+  # Check the outputs and return appropriately
+  file(READ "${BINARY_DIR}/${TEST_DIR}/eplusout.end" FILE_CONTENT)
+  string(FIND "${FILE_CONTENT}" "EnergyPlus Completed Successfully" RESULT)
+  if( RESULT EQUAL 0 )
+    message("Test Passed")
+  else()
+    message("Test Failed")
+  endif()

cmake/RunSimulation.cmake

@@ -15,12 +15,13 @@ else()
 endif()
 
 get_filename_component(IDF_NAME "${IDF_FILE}" NAME_WE)
+get_filename_component(IDF_EXT "${IDF_FILE}" EXT)
 
 execute_process(COMMAND "${CMAKE_COMMAND}" -E remove_directory "${BINARY_DIR}/testfiles/${IDF_NAME}" )
 
 execute_process(COMMAND "${CMAKE_COMMAND}" -E copy 
                 "${SOURCE_DIR}/testfiles/${IDF_FILE}" 
-                "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf" )
+                "${BINARY_DIR}/testfiles/${IDF_NAME}/in${IDF_EXT}" )
 
 execute_process(COMMAND "${CMAKE_COMMAND}" -E copy 
                 "${SOURCE_DIR}/weather/${EPW_FILE}" 
@@ -30,15 +31,63 @@ execute_process(COMMAND "${CMAKE_COMMAND}" -E copy
                 "${BINARY_DIR}/Energy+.idd" 
                 "${BINARY_DIR}/testfiles/${IDF_NAME}/Energy+.idd" )
 
+# Read the file contents to check for special cases
+file(READ "${BINARY_DIR}/testfiles/${IDF_NAME}/in${IDF_EXT}" IDF_CONTENT)
+
+# Handle setting up datasets files first
+string( FIND "${IDF_CONTENT}" "Window5DataFile.dat" WINDOW_RESULT )
+if ( "${WINDOW_RESULT}" GREATER -1 )
+  file( MAKE_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets" )
+  file( COPY "${SOURCE_DIR}/datasets/Window5DataFile.dat" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets" )
+endif ()
+
+# Handle setting up TDV dataset files next
+string(FIND "${IDF_CONTENT}" "TDV" TDV_RESULT)
+if ( "${TDV_RESULT}" GREATER -1 )
+  file( MAKE_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets" )
+  file( MAKE_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets/TDV" )
+  file( COPY "${SOURCE_DIR}/datasets/TDV/" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets/TDV/" )
+endif ()
+
+# Handle setting up External Interface FMU-import files next
+# Note we only have FMUs for Win32 in the repo, this should be improved
+string(FIND "${IDF_CONTENT}" "ExternalInterface:" EXTINT_RESULT)
+if ( "${EXTINT_RESULT}" GREATER -1 )
+  file( MAKE_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets" )
+  file( MAKE_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets/FMUs" )
+  file( COPY "${SOURCE_DIR}/datasets/FMUs/" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/DataSets/FMUs/" )
+endif ()
+
+# EPMacro should run here first
+if( "${IDF_EXT}" STREQUAL ".imf" )
+  # first bring in all imf files into the run folder
+  file( GLOB SRC_IMF_FILES "${SOURCE_DIR}/testfiles/*.imf" )
+  foreach( IMF_FILE ${SRC_IMF_FILES} )
+    file( COPY "${IMF_FILE}" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/" )
+  endforeach()
+  # find the appropriate macro file
+  if( UNIX AND NOT APPLE )
+    find_program(EPMACRO_EXE EPMacro PATHS "${SOURCE_DIR}/bin/EPMacro/Linux" 
+      NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
+  elseif( APPLE )
+    find_program(EPMACRO_EXE EPMacro PATHS "${SOURCE_DIR}/bin/EPMacro/Mac" 
+      NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
+  else() # windows
+    find_program(EPMACRO_EXE EPMacro PATHS "${SOURCE_DIR}/bin/EPMacro/Windows" 
+      NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
+  endif()
+  # execute EPMacro and rename the idf file
+  message("Executing EPMacro from ${EPMACRO_EXE}")
+  execute_process(COMMAND "${EPMACRO_EXE}" WORKING_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}")
+  file(RENAME "${BINARY_DIR}/testfiles/${IDF_NAME}/out.idf" "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf")
+endif()
+
+
 if(BUILD_FORTRAN)
 
-  # Will want to add EPMacro here eventually
-
   # Parametric preprocessor next
-  file(READ "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf" IDF_CONTENT)
-  string(TOLOWER $IDF_CONTENT idf_content_lower)
-  string(FIND "${idf_content_lower}" "parametric:" PAR_RESULT)
-  if ( NOT $PAR_RESULT EQUAL -1 )
+  string(FIND "${IDF_CONTENT}" "Parametric:" PAR_RESULT)
+  if ( "${PAR_RESULT}" GREATER -1 )
     find_program(PARAMETRIC_EXE parametricpreprocessor PATHS "${BINARY_DIR}/Products/" 
       NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
     message("Executing ParametricPreprocessor from ${PARAMETRIC_EXE}")
@@ -62,20 +111,54 @@ if(BUILD_FORTRAN)
 
     endif ()
 
-  endif ()
-
+  endif () # parametric preprocessor definitions detected
+        
   # ExpandObjects (and other preprocessors) as necessary
   find_program(EXPANDOBJECTS_EXE ExpandObjects PATHS "${BINARY_DIR}/Products/" 
     NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
   message("Executing ExpandObjects from ${EXPANDOBJECTS_EXE}")
   execute_process(COMMAND "${EXPANDOBJECTS_EXE}" WORKING_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}")
+
   if (EXISTS "${BINARY_DIR}/testfiles/${IDF_NAME}/expanded.idf")
+
+    # Copy the expanded idf into in.idf, which could be updated with ground stuff as well
     if (EXISTS "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf")
         file(REMOVE "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf")
     endif()
     file(RENAME "${BINARY_DIR}/testfiles/${IDF_NAME}/expanded.idf" "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf")
-  endif()
-endif()
+
+    # i f we have an expanded.idf, then ExpandObjects must have found something
+    # it is possible this includes ground heat transfer objects, so run them here if needed
+    # Need to copy in Slab/Basement IDDs before ExpandObjects if relevant for this file
+    string(FIND "${IDF_CONTENT}" "GroundHeatTransfer:Slab" SLAB_RESULT)
+    if ( "${SLAB_RESULT}" GREATER -1 )
+      file ( COPY "${SOURCE_DIR}/idd/SlabGHT.idd" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/" )
+      # Find and run slab
+      find_program(SLAB_EXE Slab PATHS "${BINARY_DIR}/Products/" 
+        NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
+      message("Executing Slab from ${SLAB_EXE}")
+      execute_process(COMMAND "${SLAB_EXE}" WORKING_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}")
+      # Then copy slab results into the expanded file
+      file(READ "${BINARY_DIR}/testfiles/${IDF_NAME}/SLABSurfaceTemps.TXT" SLAB_CONTENTS)
+      file(APPEND "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf" "${SLAB_CONTENTS}")
+    endif ()
+
+    string(FIND "${IDF_CONTENT}" "GroundHeatTransfer:Basement" BASEMENT_RESULT)
+    if ( "${BASEMENT_RESULT}" GREATER -1 )
+      file ( COPY "${SOURCE_DIR}/idd/BasementGHT.idd" DESTINATION "${BINARY_DIR}/testfiles/${IDF_NAME}/" )
+      # Find and run basement
+      find_program(BASEMENT_EXE Basement PATHS "${BINARY_DIR}/Products/" 
+        NO_DEFAULT_PATH NO_CMAKE_ENVIRONMENT_PATH NO_CMAKE_PATH NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_CMAKE_FIND_ROOT_PATH)
+      message("Executing Basement from ${BASEMENT_EXE}")
+      execute_process(COMMAND "${BASEMENT_EXE}" WORKING_DIRECTORY "${BINARY_DIR}/testfiles/${IDF_NAME}")
+      # Then copy basement results into the expanded file
+      file(READ "${BINARY_DIR}/testfiles/${IDF_NAME}/EPObjects.TXT" BASEMENT_CONTENTS)
+      file(APPEND "${BINARY_DIR}/testfiles/${IDF_NAME}/in.idf" "${BASEMENT_CONTENTS}")
+    endif ()
+
+  endif() # expand objects found something and created expanded.idf
+
+endif() # build fortran
 
 
 if( WIN32 )