LCOV - code coverage report
Current view: top level - EnergyPlus - SizingAnalysisObjects.hh (source / functions) Hit Total Coverage
Test: lcov.output.filtered Lines: 5 5 100.0 %
Date: 2023-01-17 19:17:23 Functions: 13 13 100.0 %

          Line data    Source code
       1             : // EnergyPlus, Copyright (c) 1996-2023, The Board of Trustees of the University of Illinois,
       2             : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
       3             : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
       4             : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
       5             : // contributors. All rights reserved.
       6             : //
       7             : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
       8             : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
       9             : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
      10             : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
      11             : // derivative works, and perform publicly and display publicly, and to permit others to do so.
      12             : //
      13             : // Redistribution and use in source and binary forms, with or without modification, are permitted
      14             : // provided that the following conditions are met:
      15             : //
      16             : // (1) Redistributions of source code must retain the above copyright notice, this list of
      17             : //     conditions and the following disclaimer.
      18             : //
      19             : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
      20             : //     conditions and the following disclaimer in the documentation and/or other materials
      21             : //     provided with the distribution.
      22             : //
      23             : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
      24             : //     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
      25             : //     used to endorse or promote products derived from this software without specific prior
      26             : //     written permission.
      27             : //
      28             : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
      29             : //     without changes from the version obtained under this License, or (ii) Licensee makes a
      30             : //     reference solely to the software portion of its product, Licensee must refer to the
      31             : //     software as "EnergyPlus version X" software, where "X" is the version number Licensee
      32             : //     obtained under this License and may not use a different name for the software. Except as
      33             : //     specifically required in this Section (4), Licensee shall not use in a company name, a
      34             : //     product name, in advertising, publicity, or other promotional activities any name, trade
      35             : //     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
      36             : //     similar designation, without the U.S. Department of Energy's prior written consent.
      37             : //
      38             : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
      39             : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
      40             : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
      41             : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      42             : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      43             : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      44             : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
      45             : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      46             : // POSSIBILITY OF SUCH DAMAGE.
      47             : 
      48             : #ifndef SizingAnalysisObjects_hh_INCLUDED
      49             : #define SizingAnalysisObjects_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <map>
      53             : #include <string>
      54             : #include <vector>
      55             : 
      56             : // EnergyPlus Headers
      57             : #include <EnergyPlus/Data/BaseData.hh>
      58             : #include <EnergyPlus/EnergyPlus.hh>
      59             : 
      60             : namespace EnergyPlus {
      61             : 
      62             : // Forward declarations
      63             : struct EnergyPlusData;
      64             : 
      65       67526 : class SystemTimestepObject
      66             : {
      67             : public:
      68             :     Real64 CurMinuteStart = 0.0;   // minutes at beginning of system timestep
      69             :     Real64 CurMinuteEnd = 0.0;     // minutes at end of system timestep
      70             :     Real64 TimeStepDuration = 0.0; // in fractional hours, length of timestep
      71             :     Real64 LogDataValue = 0.0;     // raw hard value, obtained from pointer
      72             :     int stStepsIntoZoneStep = 0;
      73             : };
      74             : 
      75      555946 : class ZoneTimestepObject
      76             : {
      77             : public:
      78             :     DataGlobalConstants::KindOfSim kindOfSim = DataGlobalConstants::KindOfSim::Invalid;
      79             :     int envrnNum = 0;
      80             :     int dayOfSim = 0; // since start of simulation
      81             :     int hourOfDay = 0;
      82             :     int ztStepsIntoPeriod = 0;     // count of zone timesteps into period
      83             :     Real64 stepStartMinute = 0.0;  // minutes at beginning of zone timestep
      84             :     Real64 stepEndMinute = 0.0;    // minutes at end of zone timestep
      85             :     Real64 timeStepDuration = 0.0; // in fractional hours, length of timestep
      86             :     Real64 logDataValue = 0.0;
      87             :     Real64 runningAvgDataValue = 0.0;
      88             :     bool hasSystemSubSteps = false;
      89             :     int numSubSteps = 0;
      90             :     std::vector<SystemTimestepObject> subSteps; // nested object array for system timesteps inside here.
      91             : 
      92             :     ZoneTimestepObject( // full constructor
      93             :         DataGlobalConstants::KindOfSim kindSim,
      94             :         int environmentNum,
      95             :         int daySim,
      96             :         int hourDay,
      97             :         int timeStep,
      98             :         Real64 timeStepDurat,
      99             :         int numOfTimeStepsPerHour);
     100             : 
     101             :     ZoneTimestepObject(); // default constructor
     102             : };
     103             : 
     104         444 : class SizingLog
     105             : {
     106             : public:
     107             :     SizingLog(double &rVariable);
     108             : 
     109             :     int NumOfEnvironmentsInLogSet;
     110             :     int NumOfDesignDaysInLogSet;
     111             :     int NumberOfSizingPeriodsInLogSet;
     112             :     std::map<int, int> ztStepCountByEnvrnMap; // key is the seed original Environment number, or index in the Environment Structure
     113             :     std::map<int, int>
     114             :         envrnStartZtStepIndexMap; // key is the seed original Environment number, produces index in zone step vector where that period begins
     115             :     std::map<int, int> newEnvrnToSeedEnvrnMap; // key is the new HVAC sim envrionment number, produces Seed environment number
     116             :     int NumOfStepsInLogSet;                    // sum of all zone timestep steps in log
     117             :     int timeStepsInAverage;                    // breadth back in time for running average, zone timesteps
     118             :     Real64 &p_rVariable;                       // reference to variable being loggged
     119             : 
     120             :     std::vector<ZoneTimestepObject> ztStepObj; // will be sized to the sum of all steps, eg. timesteps in hour * 24 hours * 2 design days.
     121             : 
     122             :     void FillZoneStep(ZoneTimestepObject tmpztStepStamp);
     123             : 
     124             :     void FillSysStep(ZoneTimestepObject tmpztStepStamp, SystemTimestepObject tmpSysStepStamp);
     125             : 
     126             :     void AverageSysTimeSteps();
     127             : 
     128             :     void ProcessRunningAverage();
     129             : 
     130             :     ZoneTimestepObject GetLogVariableDataMax(EnergyPlusData &state);
     131             : 
     132             :     Real64 GetLogVariableDataAtTimestamp(ZoneTimestepObject tmpztStepStamp);
     133             : 
     134             :     void ReInitLogForIteration();
     135             : 
     136             :     void SetupNewEnvironment(int const seedEnvrnNum, int const newEnvrnNum);
     137             : 
     138             : private:
     139             :     int GetSysStepZtStepIndex(const ZoneTimestepObject tmpztStepStamp);
     140             : 
     141             :     int GetZtStepIndex(const ZoneTimestepObject tmpztStepStamp);
     142             : };
     143             : 
     144          22 : class SizingLoggerFramework
     145             : {
     146             : public:
     147             :     std::vector<SizingLog> logObjs;
     148             : 
     149             :     int SetupVariableSizingLog(EnergyPlusData &state, Real64 &rVariable, int stepsInAverage);
     150             : 
     151             :     ZoneTimestepObject PrepareZoneTimestepStamp(EnergyPlusData &state);
     152             : 
     153             :     void UpdateSizingLogValuesZoneStep(EnergyPlusData &state);
     154             : 
     155             :     void UpdateSizingLogValuesSystemStep(EnergyPlusData &state);
     156             : 
     157             :     void SetupSizingLogsNewEnvironment(EnergyPlusData &state);
     158             : 
     159             :     void IncrementSizingPeriodSet();
     160             : 
     161             : private:
     162             :     int NumOfLogs = 0;
     163             : };
     164             : 
     165          62 : class PlantCoinicidentAnalysis
     166             : {
     167             : public:
     168             :     // this object collects data and methods for analyzing coincident sizing for a single plant loop
     169             :     int plantLoopIndex = 0;         // index in plant loop data structure.
     170             :     int supplySideInletNodeNum = 0; // node index for supply side inlet node
     171             :     int plantSizingIndex = 0;
     172             :     int numTimeStepsInAvg = 0;
     173             :     ZoneTimestepObject newFoundMassFlowRateTimeStamp; // result for max mass flow, as a timestamp object
     174             :     Real64 peakMdotCoincidentReturnTemp;
     175             :     Real64 peakMdotCoincidentDemand;
     176             :     bool anotherIterationDesired = false;
     177             :     int supplyInletNodeFlow_LogIndex; // loop flow rate index for vector of log objects in the logger framework
     178             :     int supplyInletNodeTemp_LogIndex; // loop return temperature index for vector of log objects in the logger framework
     179             :     // variables related to loop demand
     180             :     int loopDemand_LogIndex; // Loop demand load index for vector of log objects in the logger framework
     181             :     bool peakDemandAndFlowMismatch;
     182             :     ZoneTimestepObject NewFoundMaxDemandTimeStamp; // result for max loop demand, as a timestamp object
     183             : 
     184             :     Real64 peakDemandReturnTemp;
     185             :     Real64 peakDemandMassFlow;
     186             : 
     187             :     PlantCoinicidentAnalysis(std::string loopName, int loopIndex, int nodeNum, Real64 density, Real64 cp, int numStepsInAvg, int sizingIndex);
     188             : 
     189             :     void ResolveDesignFlowRate(EnergyPlusData &state, int const HVACSizingIterCount);
     190             : 
     191             : private:
     192             :     std::string name = "";                // name of analysis object
     193             :     Real64 newAdjustedMassFlowRate = 0.0; // with sizing factor included...
     194             :     Real64 newFoundMassFlowRate = 0.0;
     195             :     Real64 significantNormalizedChange = 0.005; // criteria for if sizing algorithm yeild a change large enough worth making another pass.
     196             :     Real64 densityForSizing = 0.0;
     197             :     Real64 specificHeatForSizing = 0.0;
     198             :     Real64 previousVolDesignFlowRate = 0.0;
     199             :     Real64 newVolDesignFlowRate = 0.0;
     200             : 
     201             :     bool CheckTimeStampForNull(ZoneTimestepObject testStamp);
     202             : };
     203             : 
     204             : } // namespace EnergyPlus
     205             : 
     206             : #endif

Generated by: LCOV version 1.13