Line data    Source code

       1              : // EnergyPlus, Copyright (c) 1996-2025, 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 PLANTCOMPONENT_HH_INCLUDED
      49              : #define PLANTCOMPONENT_HH_INCLUDED
      50              : 
      51              : #include <EnergyPlus/DataGlobals.hh>
      52              : 
      53              : namespace EnergyPlus {
      54              : 
      55              : // Forward declarations
      56              : struct EnergyPlusData;
      57              : struct PlantLocation;
      58              : 
      59              : class PlantComponent
      60              : {
      61              : 
      62              : public:
      63              :     bool oneTimeInitFlag = true;
      64              : 
      65              :     virtual void simulate(EnergyPlusData &state, const PlantLocation &calledFromLocation, bool FirstHVACIteration, Real64 &CurLoad, bool RunFlag) = 0;
      66              : 
      67         1190 :     virtual void getDesignCapacities([[maybe_unused]] EnergyPlusData &state,
      68              :                                      [[maybe_unused]] const PlantLocation &calledFromLocation,
      69              :                                      [[maybe_unused]] Real64 &MaxLoad,
      70              :                                      [[maybe_unused]] Real64 &MinLoad,
      71              :                                      [[maybe_unused]] Real64 &OptLoad)
      72              :     {
      73         1190 :     }
      74              : 
      75         1392 :     virtual void getDesignTemperatures([[maybe_unused]] Real64 &TempDesCondIn, [[maybe_unused]] Real64 &TempDesEvapOut)
      76              :     {
      77         1392 :     }
      78              : 
      79          265 :     virtual void getSizingFactor([[maybe_unused]] Real64 &SizFac)
      80              :     {
      81          265 :     }
      82              : 
      83         1120 :     virtual void onInitLoopEquip([[maybe_unused]] EnergyPlusData &state, [[maybe_unused]] const PlantLocation &calledFromLocation)
      84              :     {
      85         1120 :     }
      86              : 
      87              :     virtual void oneTimeInit(EnergyPlusData &state) = 0;
      88              : 
      89           22 :     virtual void oneTimeInit_new([[maybe_unused]] EnergyPlusData &state)
      90              :     {
      91           22 :     }
      92              : 
      93        11624 :     virtual Real64 getDynamicMaxCapacity([[maybe_unused]] EnergyPlusData &state)
      94              :     {
      95        11624 :         return 0.0;
      96              :     }
      97              : 
      98            0 :     virtual void getCurrentPower([[maybe_unused]] EnergyPlusData &state, [[maybe_unused]] Real64 &power)
      99              :     {
     100            0 :     }
     101              : 
     102         4847 :     virtual ~PlantComponent() = default;
     103              : };
     104              : 
     105              : } // namespace EnergyPlus
     106              : 
     107              : #endif