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             : #include <EnergyPlus/Data/EnergyPlusData.hh>
      49             : #include <EnergyPlus/DataBranchAirLoopPlant.hh>
      50             : #include <EnergyPlus/DataLoopNode.hh>
      51             : #include <EnergyPlus/Plant/Branch.hh>
      52             : #include <EnergyPlus/PlantUtilities.hh>
      53             : 
      54             : namespace EnergyPlus {
      55             : namespace DataPlant {
      56             : 
      57   176435092 :     Real64 BranchData::DetermineBranchFlowRequest(EnergyPlusData &state)
      58             :     {
      59             : 
      60             :         // SUBROUTINE INFORMATION:
      61             :         //       AUTHOR         Edwin Lee
      62             :         //       DATE WRITTEN   September 2010
      63             :         //       MODIFIED       na
      64             :         //       RE-ENGINEERED  na
      65             : 
      66             :         // PURPOSE OF THIS SUBROUTINE:
      67             :         // This routine will analyze the given branch and determine the representative
      68             :         //  flow request.
      69             : 
      70             :         // METHODOLOGY EMPLOYED:
      71             :         // Several possibilities are available.  In any case, the request is constrained to within
      72             :         //  branch outlet min/max avail.  This assumes that the component flow routines will properly
      73             :         //  propagate the min/max avail down the branch.
      74             :         // Some possibilities for flow request are:
      75             :         //  1) take the outlet flow rate -- assumes that the last component wins
      76             :         //  2) take the inlet flow rate request -- assumes that the request is propagated up and is good
      77             :         //  3) take the maximum request
      78             :         //  4) move down the loop and take the maximum "non-load-range-based" request within min/max avail bounds
      79             :         //     This assumes that load range based should not request flow for load-rejection purposes, and we
      80             :         //     should only "respond" to other component types.
      81             : 
      82   176435092 :         int const BranchInletNodeNum = this->NodeNumIn;
      83   176435092 :         int const BranchOutletNodeNum = this->NodeNumOut;
      84   176435092 :         Real64 OverallFlowRequest = 0.0;
      85             : 
      86   176435092 :         if (this->controlType != DataBranchAirLoopPlant::ControlType::SeriesActive) {
      87   175372367 :             OverallFlowRequest = state.dataLoopNodes->Node(BranchInletNodeNum).MassFlowRateRequest;
      88             :         } else { // is series active, so take largest request of all the component inlet nodes
      89     3240425 :             for (int CompCounter = 1; CompCounter <= this->TotalComponents; ++CompCounter) {
      90     2177700 :                 int const CompInletNode = this->Comp(CompCounter).NodeNumIn;
      91     2177700 :                 OverallFlowRequest = max(OverallFlowRequest, state.dataLoopNodes->Node(CompInletNode).MassFlowRateRequest);
      92             :             }
      93             :         }
      94             : 
      95             :         //~ Now use a worker to bound the value to outlet min/max avail
      96   176435092 :         OverallFlowRequest = PlantUtilities::BoundValueToNodeMinMaxAvail(state, OverallFlowRequest, BranchOutletNodeNum);
      97             : 
      98   176435092 :         return OverallFlowRequest;
      99             :     }
     100             : 
     101             : } // namespace DataPlant
     102             : } // namespace EnergyPlus