Merge remote-tracking branch 'origin/develop' into HVACSizingSim_Coin…

…cidentPlant

.decent_ci-Linux.yaml

@@ -2,6 +2,10 @@ compilers:
   - name: "gcc"
     version: "4.8"
     build_package_generator: "STGZ"
+    release_build_enable_pgo: true
+    release_build_training_cmake_extra_flags: -DPROFILE_GENERATE:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=OFF
+    release_build_training_ctest_filter:  -R  "integration.(RefBldg.*|.*Slab|.*[^g]Basement|.*5Zone.*|Rad|Pip|.*Network.*|Window|CentralChillerHeaterSystem_Cooling_Heating|CmplxGlz_.*|ConvectionAdaptiveSmallOffice|DElight.*|DaylightingDevice.*|DisplacementVent_Nat_AirflowNetwork_AdaptiveComfort|DOADualDuctSchool|EMS.*|Flr_Rf_8Sides|FluidCooler|GSHP.*|GeneratorswithPV|HeatPumpWaterToAir.*|HospitalBaselineReheatReportEMS|HospitalLowEnergy|MicroCogeneration|PlantApplicationsGuide.*|PlateHeatExchanger|PurchAirWithDaylighting|RefrigeratedWarehouse|SolarCollectorFlatPlateWater|SurfaceTest|ThermalChimneyTest|UserDefinedRoomAirPatterns|VSHeatPumpWaterToAirEquationFit|WaterHeater.*|_CTFTestsPart2|_HybridVentilationControlGlobalAN|CentralChillerHeaterSystem)"
+    release_build_cmake_extra_flags: -DPROFILE_GENERATE:BOOL=OFF -DPROFILE_USE:BOOL=ON -DENABLE_LTO:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON
     cmake_extra_flags: -DBUILD_FORTRAN=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=$REGRESSION_BASELINE -DREGRESSION_SCRIPT_PATH:PATH=$REGRESSION_DIR -DREGRESSION_BASELINE_SHA:STRING=$REGRESSION_BASELINE_SHA -DCOMMIT_SHA=$COMMIT_SHA
   - name: cppcheck
     compiler_extra_flags: --enable=warning  --suppress="*:*gtest*" --suppress="constStatement:*Objex*" --suppress="cppcheckError:*" --suppress="uninitvar:*" --suppress="syntaxError:*" --suppress="*:*sqlite*" --suppress="invalidscanf:*DElight*" --suppress="uninitMemberVar:*DElight*" --suppress="invalidScanfArgType_int:*DElight*"

.decent_ci-MacOS.yaml

@@ -1,5 +1,6 @@
 compilers:
   - name: clang
+    release_build_cmake_extra_flags: -DENABLE_LTO:BOOL=ON
     cmake_extra_flags: -DBUILD_FORTRAN=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=$REGRESSION_BASELINE -DREGRESSION_SCRIPT_PATH:PATH=$REGRESSION_DIR -DREGRESSION_BASELINE_SHA:STRING=$REGRESSION_BASELINE_SHA -DCOMMIT_SHA=$COMMIT_SHA
   - name: clang
     build_type: Debug

.decent_ci-Windows.yaml

@@ -1,10 +1,24 @@
 compilers:
   - name: Visual Studio
     version: 12
-    cmake_extra_flags: -DBUILD_FORTRAN=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=%REGRESSION_BASELINE% -DREGRESSION_SCRIPT_PATH:PATH=%REGRESSION_DIR% -DREGRESSION_BASELINE_SHA:STRING=%REGRESSION_BASELINE_SHA% -DCOMMIT_SHA=%COMMIT_SHA%
+    release_build_enable_pgo: false
+    release_build_cmake_extra_flags: -DENABLE_LTO:BOOL=ON
+    cmake_extra_flags: -DBUILD_FORTRAN:BOOL=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=%REGRESSION_BASELINE% -DREGRESSION_SCRIPT_PATH:PATH=%REGRESSION_DIR% -DREGRESSION_BASELINE_SHA:STRING=%REGRESSION_BASELINE_SHA% -DCOMMIT_SHA=%COMMIT_SHA%
   - name: Visual Studio
     version: 12
     architecture: Win64
-    cmake_extra_flags: -DBUILD_FORTRAN=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=%REGRESSION_BASELINE% -DREGRESSION_SCRIPT_PATH:PATH=%REGRESSION_DIR% -DREGRESSION_BASELINE_SHA:STRING=%REGRESSION_BASELINE_SHA% -DCOMMIT_SHA=%COMMIT_SHA%
+    release_build_enable_pgo: false
+    release_build_cmake_extra_flags: -DENABLE_LTO:BOOL=ON
+    cmake_extra_flags: -DBUILD_FORTRAN:BOOL=ON -DBUILD_PACKAGE:BOOL=ON -DBUILD_TESTING:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON -DREGRESSION_BASELINE_PATH:PATH=%REGRESSION_BASELINE% -DREGRESSION_SCRIPT_PATH:PATH=%REGRESSION_DIR% -DREGRESSION_BASELINE_SHA:STRING=%REGRESSION_BASELINE_SHA% -DCOMMIT_SHA=%COMMIT_SHA%
 
 
+
+# The following lines are useful and should replace their counterparts above if you want to
+# enable profile-guided-optimization on MSVC builds
+#
+#    release_build_enable_pgo: true
+#    release_build_training_cmake_extra_flags: -DPROFILE_GENERATE:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=OFF
+#    release_build_training_ctest_filter:  -R  "integration.(RefBldg.*|.*Slab|.*[^g]Basement|.*5Zone.*|Rad|Pip|.*Network.*|Window|CentralChillerHeaterSystem_Cooling_Heating|CmplxGlz_.*|ConvectionAdaptiveSmallOffice|DElight.*|DaylightingDevice.*|DisplacementVent_Nat_AirflowNetwork_AdaptiveComfort|DOADualDuctSchool|EMS.*|Flr_Rf_8Sides|FluidCooler|GSHP.*|GeneratorswithPV|HeatPumpWaterToAir.*|HospitalBaselineReheatReportEMS|HospitalLowEnergy|MicroCogeneration|PlantApplicationsGuide.*|PlateHeatExchanger|PurchAirWithDaylighting|RefrigeratedWarehouse|SolarCollectorFlatPlateWater|SurfaceTest|ThermalChimneyTest|UserDefinedRoomAirPatterns|VSHeatPumpWaterToAirEquationFit|WaterHeater.*|_CTFTestsPart2|_HybridVentilationControlGlobalAN|CentralChillerHeaterSystem)"
+#    release_build_cmake_extra_flags: -DPROFILE_GENERATE:BOOL=OFF -DPROFILE_USE:BOOL=ON -DENABLE_REGRESSION_TESTING:BOOL=ON
+#
+

.decent_ci.yaml

@@ -9,3 +9,6 @@ regression_baseline_master : ""
 notification_recipients:
   - lgentile
 aging_pull_requests_notification: true
+
+
+

CMakeLists.txt

@@ -6,7 +6,7 @@ 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 6 ) 
+set( CMAKE_VERSION_PATCH 7 ) 
 
 set( ENERGYPLUS_VERSION "${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}.${CMAKE_VERSION_PATCH}" )
 
@@ -88,6 +88,18 @@ set( CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Products" )
 set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Products" )
 set( CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Products" )
 
+# Advanced, time consuming compiler optimization options
+
+option(ENABLE_LTO "Enable link-time-optimization" FALSE)
+option(PROFILE_GENERATE "Generate profile data" FALSE)
+option(PROFILE_USE "Use profile data" FALSE)
+
+
+if (PROFILE_USE AND PROFILE_GENERATE)
+  message(SEND_ERROR "Cannot enable PROFILE_USE and PROFILE_GENERATE simultaneously")
+endif()
+
+
 include(cmake/ProjectMacros.cmake)
 include(cmake/CompilerFlags.cmake)
 
@@ -163,3 +175,129 @@ if( BUILD_PACKAGE )
   include(cmake/Install.cmake)
 endif()
 
+
+set(OPTIMIZABLE_TARGETS
+  sqlite objexx bcvtb epexpat epfmiimport miniziplib DElight EnergyPlus EnergyPlusAPI EnergyPlusLib EnergyPlusLib2 
+    )
+if(NOT APPLE AND NOT MSVC)
+  list(APPEND OPTIMIZABLE_TARGETS parser)
+endif()
+
+if(NOT MSVC)
+  list(APPEND OPTIMIZABLE_TARGETS objexx_tests EnergyPlus_tests)
+endif()
+
+if(MSVC AND (PROFILE_GENERATE OR PROFILE_USE OR ENABLE_LTO) )
+  get_filename_component(LINKER_DIR "${CMAKE_LINKER}" PATH)
+  get_filename_component(LINKER_DIR_NAME "${LINKER_DIR}" NAME)
+
+  if (MSVC12)
+    set(PGORTVER "120")
+  elseif(MSVC14)
+    set(PGORTVER "140")
+  endif()
+
+  message("Examining ${LINKER_DIR_NAME} for PGO RT DLL")
+
+  if ("${LINKER_DIR_NAME}" MATCHES ".*amd64.*")
+    get_filename_component(LINKER_PARENT_DIR "${LINKER_DIR}" PATH)
+    set(PGORTDIR "${LINKER_PARENT_DIR}/amd64")
+    message("Retrieving amd64 PGO dll from: ${PGORTDIR}")
+  else()
+    set(PGORTDIR "${LINKER_DIR}")
+  endif()
+
+  file(COPY "${PGORTDIR}/pgort${PGORTVER}.dll" DESTINATION "${CMAKE_BINARY_DIR}/Products/Release" )
+
+  foreach(target ${OPTIMIZABLE_TARGETS})
+    get_target_property(targ_link_flags ${target} LINK_FLAGS)
+    get_target_property(targ_static_link_flags ${target} STATIC_LIBRARY_FLAGS)
+    get_target_property(targ_compile_flags ${target} COMPILE_FLAGS)
+
+    # message("${target}: ${targ_link_flags}; ${targ_static_link_flags}; ${targ_compile_flags}")
+    if(targ_link_flags STREQUAL "targ_link_flags-NOTFOUND")
+      set(targ_link_flags "")
+    endif()
+
+    if(targ_static_link_flags STREQUAL "targ_static_link_flags-NOTFOUND")
+      set(targ_static_link_flags "")
+    endif()
+
+    if(targ_compile_flags STREQUAL "targ_compile_flags-NOTFOUND")
+      set(targ_compile_flags "")
+    endif()
+
+    if (ENABLE_LTO OR PROFILE_GENERATE OR PROFILE_USE)
+      set(targ_compile_flags "${targ_compile_flags} /GL")
+    endif()
+
+    if(ENABLE_LTO AND NOT PROFILE_GENERATE AND NOT PROFILE_USE)
+      set(targ_link_flags "${targ_link_flags} /LTCG")
+      set(targ_static_link_flags "${targ_static_link_flags} /LTCG")
+    endif()
+
+    if (PROFILE_GENERATE)
+      set(targ_link_flags "${targ_link_flags} /LTCG:PGI")
+      set(targ_static_link_flags "${targ_static_link_flags} /LTCG")
+    endif()
+
+    if (PROFILE_USE)
+      set(targ_link_flags "${targ_link_flags} /LTCG:PGO")
+      set(targ_static_link_flags "${targ_static_link_flags} /LTCG")
+    endif()
+
+    set_target_properties(${target} PROPERTIES LINK_FLAGS "${targ_link_flags}" STATIC_LIBRARY_FLAGS "${targ_static_link_flags}" 
+       COMPILE_FLAGS "${targ_compile_flags}")
+
+  endforeach()
+
+elseif (CMAKE_COMPILER_IS_GNUCXX)
+  if(ENABLE_LTO)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-flto=7 -fno-use-linker-plugin" COMPILE_FLAGS "-flto=7 -fno-use-linker-plugin")
+    set_target_properties(EnergyPlus
+      PROPERTIES LINK_FLAGS "-flto=7 -fuse-linker-plugin -fwhole-program" COMPILE_FLAGS "-flto=7 -fuse-linker-plugin -fwhole-program")
+  endif()
+
+  if (PROFILE_GENERATE)
+    set_target_properties(${OPTIMIZABLE_TARGETS} EnergyPlus_tests TestEnergyPlusCallbacks
+      PROPERTIES LINK_FLAGS "-fprofile-generate"  COMPILE_FLAGS "-fprofile-generate")
+  endif()
+
+  if (PROFILE_USE)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-fprofile-use"  COMPILE_FLAGS "-fprofile-use")
+  endif()
+
+  if (PROFILE_USE AND ENABLE_LTO)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-flto=7 -fno-use-linker-plugin -fprofile-use" COMPILE_FLAGS "-flto=7 -fno-use-linker-plugin -fprofile-use")
+    set_target_properties(EnergyPlus
+      PROPERTIES LINK_FLAGS "-flto=7 -fuse-linker-plugin -fwhole-program -fprofile-use" COMPILE_FLAGS "-flto=7 -fuse-linker-plugin -fwhole-program -fprofile-use")
+  endif()
+elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" ) # Clang
+  if(ENABLE_LTO)
+    set_target_properties(EnergyPlus
+      PROPERTIES LINK_FLAGS "-flto" COMPILE_FLAGS "-flto")
+  endif()
+
+  if (PROFILE_GENERATE)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-fprofile-instr-generate" COMPILE_FLAGS "-fprofile-instr-generate") 
+  endif()
+
+  if (PROFILE_USE)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-fprofile-instr-use=${CMAKE_BINARY_DIR}/profdata" COMPILE_FLAGS "-fprofile-instr-use=${CMAKE_BINARY_DIR}/profdata")
+  endif()
+
+  if (PROFILE_USE AND ENABLE_LTO)
+    set_target_properties(${OPTIMIZABLE_TARGETS}
+      PROPERTIES LINK_FLAGS "-flto -fprofile-instr-use=${CMAKE_BINARY_DIR}/profdata" COMPILE_FLAGS "-flto -fprofile-instr-use=${CMAKE_BINARY_DIR}/profdata")
+  endif()
+
+
+endif()
+
+
+

README.md

@@ -25,11 +25,11 @@ The C++ code in EnergyPlus utilizes many C++11 features, and so a modern compile
 
 1. Install Visual Studio 2013 Express **for WIndows Desktop**, at least update 3.  This is available [here](http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop)
 2. Install cmake, from [http://www.cmake.org/cmake/resources/software.html].  This includes a GUI.  From the start menu, you should be able to launch the gui (it is called cmake-gui).  
-3. Point cmake source code to the root of the repository, the root of the source tree.
-4. Point cmake build to the folder you created, the root of the build tree.  CMake will offer to create this folder if it doesn't exist.
+3. Point cmake source code to the root of the repository, the root of the source tree. e.g. C:\GitHubClones\EnergyPlus
+4. Point cmake build to the folder you created, the root of the build tree.  CMake will offer to create this folder if it doesn't exist. e.g. C:\GitHubClones\EnergyPlus\Build (This may be anywhere on your system, but this arrangement is convenient, because the EnergyPlus repo ignores folders named Build or build.)
 5. Click configure.  This may bring up a dialog box where you choose the build environment to use. Choose Visual Studio 12 or Visual Studio 12 Win64 (for 64-bit builds), which is the 2013 version of the toolchain.
 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.
+7. Browse to the build folder and there will be a Visual Studio solution file you can click on, EnergyPlus.sln. 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```.  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.
 

cmake/CompilerFlags.cmake

@@ -2,6 +2,9 @@
 # Compiler-agnostic compiler flags first
 ADD_CXX_DEBUG_DEFINITIONS("-DOBJEXXFCL_FARRAY_INIT -DOBJEXXFCL_FARRAY_INIT_DEBUG") # Objexx DEFinition
 
+# Make sure expat is compiled as a static library
+ADD_DEFINITIONS("-DXML_STATIC")
+
 IF ( MSVC ) # visual c++ (VS 2013)
 
     # Disabled Warnings:
@@ -30,7 +33,8 @@ IF ( MSVC ) # visual c++ (VS 2013)
 
     # ADDITIONAL RELEASE-MODE-SPECIFIC FLAGS
     ADD_CXX_RELEASE_DEFINITIONS("-GS-") # Disable buffer overrun checks for performance in release mode
-
+
+
 ELSEIF ( CMAKE_COMPILER_IS_GNUCXX OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" ) # g++/Clang
     option(ENABLE_THREAD_SANITIZER "Enable thread sanitizer testing in gcc/clang" FALSE)
     set(LINKER_FLAGS "")

cmake/ProjectMacros.cmake

@@ -124,8 +124,14 @@ function( ADD_SIMULATION_TEST )
     set(ANNUAL_SIMULATION false)
   endif()
 
+
   get_filename_component(IDF_NAME "${ADD_SIM_TEST_IDF_FILE}" NAME_WE)
-
+
+  if ( PROFILE_GENERATE AND IDF_NAME MATCHES "^(ChilledWaterStorage-Mixed|AirflowNetwork3zVent|AirflowNetwork3zVentAutoWPC|DElightCFSWindow|PipeHeatTransfer_Outair|RadHiTempElecTermReheat|RadLoTempCFloTermReheat|RadLoTempHydrMulti10|RefBldgSmallOfficeNew2004_Chicago|WindowTestsSimple|.*CentralChillerHeaterSystem.*|EMSCustomOutputVariable|EMSTestMathAndKill)$")
+    message("Setting ANNUAL_SIMULATION to true for ${IDF_NAME} for the purpose of PGO training")
+    set(ANNUAL_SIMULATION true)
+  endif()
+
   add_test(NAME "integration.${IDF_NAME}" COMMAND ${CMAKE_COMMAND}
     -DSOURCE_DIR=${CMAKE_SOURCE_DIR}
     -DBINARY_DIR=${CMAKE_BINARY_DIR}
@@ -137,15 +143,25 @@ function( ADD_SIMULATION_TEST )
     -P ${CMAKE_SOURCE_DIR}/cmake/RunSimulation.cmake
   )  
 
+  # MSVC's profile generator does not work with parallel runs
+  #if( MSVC AND PROFILE_GENERATE )
+    #set_tests_properties("integration.${IDF_NAME}" PROPERTIES RUN_SERIAL true)
+  #endif()
+
   # 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")
+    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")
+    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 ( PROFILE_GENERATE AND ANNUAL_SIMULATION )
+    set_tests_properties("integration.${IDF_NAME}" PROPERTIES TIMEOUT 4500)
   endif()
 
+
   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}