Line data    Source code

       1             : // EnergyPlus, Copyright (c) 1996-2024, 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 DataHVACSystems_hh_INCLUDED
      49             : #define DataHVACSystems_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <string>
      53             : 
      54             : // EnergyPlus Headers
      55             : #include <EnergyPlus/EnergyPlus.hh>
      56             : 
      57             : namespace EnergyPlus {
      58             : 
      59             : // Forward declarations
      60             : struct EnergyPlusData;
      61             : 
      62             : // base class for all HVAC systems
      63             : class HVACSystemData
      64             : {
      65             : 
      66             : public:
      67             :     // Default Constructor
      68        2268 :     HVACSystemData()
      69        2268 :     {
      70        2268 :     }
      71             : 
      72             :     virtual void simulate(EnergyPlusData &state,
      73             :                           std::string_view Name,
      74             :                           bool const firstHVACIteration,
      75             :                           int AirLoopNum,
      76             :                           int &CompIndex,
      77             :                           bool &HeatActive,
      78             :                           bool &CoolActive,
      79             :                           int const OAUnitNum,         // If the system is an equipment of OutdoorAirUnit
      80             :                           Real64 const OAUCoilOutTemp, // the coil inlet temperature of OutdoorAirUnit
      81             :                           bool const ZoneEquipment,    // TRUE if called as zone equipment
      82             :                           Real64 &sysOutputProvided,   // sensible output at supply air node
      83             :                           Real64 &latOutputProvided    // latent output at supply air node
      84             :                           ) = 0;
      85             : 
      86             :     virtual void sizeSystem(EnergyPlusData &state, bool const FirstHVACIteration, int const AirLoopNum) = 0;
      87             :     virtual int getAirInNode(EnergyPlusData &state, std::string_view UnitarySysName, int const ZoneOAUnitNum, bool &errFlag) = 0;
      88             :     virtual int getAirOutNode(EnergyPlusData &state, std::string_view UnitarySysName, int const ZoneOAUnitNum, bool &errFlag) = 0;
      89             :     virtual int getAirOutletNode() = 0;
      90             :     virtual int getMixerOANode() = 0;
      91             :     virtual int getMixerMixNode() = 0;
      92             :     virtual int getMixerRetNode() = 0;
      93             :     virtual int getEquipIndex() = 0;
      94             : };
      95             : 
      96             : } // namespace EnergyPlus
      97             : 
      98             : #endif // DataHVACSystems_hh_INCLUDED