LCOV - code coverage report
Current view: top level - EnergyPlus - AirTerminalUnit.hh (source / functions) Hit Total Coverage
Test: lcov.output.filtered Lines: 1 1 100.0 %
Date: 2023-01-17 19:17:23 Functions: 2 2 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 AirTerminalUnit_hh_INCLUDED
      49             : #define AirTerminalUnit_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <string>
      53             : 
      54             : // EnergyPlus Headers
      55             : #include <EnergyPlus/Data/BaseData.hh>
      56             : #include <EnergyPlus/EnergyPlus.hh>
      57             : 
      58             : namespace EnergyPlus {
      59             : 
      60             : // Forward declarations
      61             : struct EnergyPlusData;
      62             : 
      63             : // types of air terminal units, refactored from old DataDefineEquip
      64             : enum AirTerminalUnitType
      65             : {
      66             :     notYetDetermined,
      67             :     dualDuctConstVolume,
      68             :     dualDuctVAV,
      69             :     singleDuctVAVReheat,
      70             :     singleDuctConstVolReheat,
      71             :     singleDuctConstVolNoReheat,
      72             :     singleDuctVAVNoReheat,
      73             :     singleDuct_SeriesPIU_Reheat,
      74             :     singleDuct_ParallelPIU_Reheat,
      75             :     singleDuct_ConstVol_4PipeInduc,
      76             :     singleDuctVAVReheatVSFan,
      77             :     singleDuctCBVAVReheat,
      78             :     singleDuctCBVAVNoReheat,
      79             :     singleDuctConstVolCooledBeam,
      80             :     dualDuctVAVOutdoorAir,
      81             :     singleDuctUserDefined,
      82             :     singleDuctATMixer,
      83             :     singleDuctConstVolFourPipeBeam
      84             : };
      85             : 
      86             : // base class for all air distribution units.  zone air terminals for connecting to central air handlers
      87          30 : class AirTerminalUnit
      88             : {
      89             : 
      90             : public: // Methods
      91             :     virtual void simulate(EnergyPlusData &state,
      92             :                           bool FirstHVACIteration, // TRUE if first HVAC iteration in time step
      93             :                           Real64 &NonAirSysOutput  // convective cooling by the beam system [W]
      94             :                           ) = 0;
      95             : 
      96             :     virtual int getZoneIndex() = 0;
      97             : 
      98             :     virtual int getAirLoopNum() = 0;
      99             : 
     100             :     virtual Real64 getPrimAirDesignVolFlow() = 0;
     101             : 
     102             :     virtual int getTermUnitSizingIndex() = 0;
     103             : 
     104             : protected:                                               // Data
     105             :     AirTerminalUnitType terminalType = notYetDetermined; // Type of air distribution unit  //Legacy For use during transition to OO
     106             :     std::string name;                                    // name of unit
     107             :     std::string unitType;                                // type of unit = e.g. AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam
     108             :     int aDUNum = 0;                                      // index of this unit in the corresponding air distribution unit structure
     109             :     int airAvailSchedNum = 0;                            // index to schedule for pimary air availability
     110             :     bool airAvailable = false;                           // true if primary air is available
     111             :     Real64 vDotDesignPrimAir = 0.0;                      // Design primary air volume flow rate m3/s (autosizable)
     112             :     bool vDotDesignPrimAirWasAutosized = false;          // true if user input for design air flow was autsized on input
     113             :     Real64 mDotDesignPrimAir = 0.0;                      // Design primary air mass flow rate kg/s
     114             :     int airInNodeNum = 0;                                // unit air inlet system node number, air enters into air terminal unit
     115             :     int airOutNodeNum = 0;                               // unit air outlet system node number, air enters into zone from air terminal
     116             :     int zoneIndex = 0;                                   // zone index for this air terminal unit
     117             :     int zoneNodeIndex = 0;                               // index in node structure for the zone node for this air terminal
     118             :     int ctrlZoneInNodeIndex = 0;                         // which controlled zone inlet node number corresponds with this unit
     119             :     int airLoopNum = 0;                                  // index to airloop that this terminal unit is connected to
     120             :     int termUnitSizingNum = 0;                           // index to TermUnitSizing, TermUnitFinalZoneSizing, and more for this air distribution unit
     121             : };                                                       // AirTerminalUnit
     122             : 
     123             : } // namespace EnergyPlus
     124             : 
     125             : #endif // AirTerminalUnit_hh_INCLUDED

Generated by: LCOV version 1.13