DataGlobals.hh

// EnergyPlus, Copyright (c) 1996-present, The Board of Trustees of the University of Illinois,
// The Regents of the University of California, through Lawrence Berkeley National Laboratory
// (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
// National Laboratory, managed by UT-Battelle, Alliance for Energy Innovation, LLC, and other
// contributors. All rights reserved.
//
// NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
// U.S. Government consequently retains certain rights. As such, the U.S. Government has been
// granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
// worldwide license in the Software to reproduce, distribute copies to the public, prepare
// derivative works, and perform publicly and display publicly, and to permit others to do so.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted
// provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this list of
//     conditions and the following disclaimer.
//
// (2) Redistributions in binary form must reproduce the above copyright notice, this list of
//     conditions and the following disclaimer in the documentation and/or other materials
//     provided with the distribution.
//
// (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
//     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
//     used to endorse or promote products derived from this software without specific prior
//     written permission.
//
// (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
//     without changes from the version obtained under this License, or (ii) Licensee makes a
//     reference solely to the software portion of its product, Licensee must refer to the
//     software as "EnergyPlus version X" software, where "X" is the version number Licensee
//     obtained under this License and may not use a different name for the software. Except as
//     specifically required in this Section (4), Licensee shall not use in a company name, a
//     product name, in advertising, publicity, or other promotional activities any name, trade
//     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
//     similar designation, without the U.S. Department of Energy's prior written consent.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#ifndef DataGlobals_hh_INCLUDED
#define DataGlobals_hh_INCLUDED

// C++ Headers
#include <functional>
#include <iosfwd>
#include <string>

// EnergyPlus Headers
#include <EnergyPlus/Data/BaseData.hh>
#include <EnergyPlus/DataGlobalConstants.hh>
#include <EnergyPlus/EnergyPlus.hh>
#include <EnergyPlus/IOFiles.hh>

namespace EnergyPlus {

// Forward declarations
struct EnergyPlusData;

enum class BooleanSwitch
{
    Invalid = -1,
    No,
    Yes,
    Num
};

struct DataGlobal : BaseGlobalStruct
{
    bool BeginDayFlag = false;           // True at the start of each day, False after first time step in day
    bool BeginEnvrnFlag = false;         // True at the start of each environment, False after first time step in environ
    bool BeginHourFlag = false;          // True at the start of each hour, False after first time step in hour
    bool BeginSimFlag = false;           // True until any actual simulation (full or sizing) has begun, False after first time step
    bool BeginTimeStepFlag = false;      // True at the start of each time step, False after first subtime step of time step
    int DayOfSim = 0;                    // Counter for days (during the simulation)
    int CalendarYear = 0;                // Calendar year of the current day of simulation
    std::string CalendarYearChr;         // Calendar year of the current day of simulation (character -- for reporting)
    bool EndEnvrnFlag = false;           // True at the end of each environment (last time step of last hour of last day of environ)
    bool EndDesignDayEnvrnsFlag = false; // True at the end of the last design day environment
    bool AnnualSimulation = false;
    std::string DayOfSimChr = "0"; // Counter for days (during the simulation) (character -- for reporting)
    bool runReadVars = false;
    bool DDOnlySimulation = false;
    bool outputEpJSONConversion = false;
    bool outputEpJSONConversionOnly = false;
    bool isEpJSON = false;
    bool preserveIDFOrder = true;
    bool stopSimulation = false;
    std::function<void(void *)> externalHVACManager;
    bool externalHVACManagerInitialized = false;
    Constant::KindOfSim KindOfSim = Constant::KindOfSim::Invalid;
    bool sizingAnalysisEioHeaderDoneOnce = false;
    bool EndDayFlag = false;         // True at the end of each day (last time step of last hour of day)
    bool EndHourFlag = false;        // True at the end of each hour (last time step of hour)
    int PreviousHour = 0;            // Previous Hour Index
    int HourOfDay = 0;               // Counter for hours in a simulation day
    Real64 WeightPreviousHour = 0.0; // Weighting of value for previous hour
    Real64 WeightNow = 0.0;          // Weighting of value for current hour
    int NumOfDayInEnvrn = 0;         // Number of days in the simulation for a particular environment
    bool OverrideTimestep = false;   // True if PerformancePrecision object overrides the number of time steps in each hour
    int TimeStepsInHour = 0;         // Number of time steps in each hour of the simulation
    int NumOfZones = 0;              // Total number of Zones for simulation
    int numSpaces = 0;               // Total number of Spaces for simulation
    int numSpaceTypes = 0;           // Number of unique space types
    int TimeStep = 0;                // Counter for time steps (fractional hours)
    Real64 TimeStepZone = 0.0;       // Zone time step in fractional hours
    bool SetupFlag = false;          // True during the setup portion of a simulation
    bool WarmupFlag = false;         // True during the warmup portion of a simulation
    Int64 StdOutputRecordCount = 0;  // Count of Standard output records
    Int64 StdMeterRecordCount = 0;   // Count of Meter output records
    bool ZoneSizingCalc = false;     // TRUE if zone sizing calculation
    bool SysSizingCalc = false;      // TRUE if system sizing calculation
    bool DoZoneSizing = false;       // User input in SimulationControl object
    bool DoSystemSizing = false;     // User input in SimulationControl object
    bool DoPlantSizing = false;      // User input in SimulationControl object
    bool DoDesDaySim = false;        // User input in SimulationControl object
    bool DoWeathSim = false;         // User input in SimulationControl object
    bool DoPureLoadCalc = false;     // if true, just run sizing and no full simulation of design days, or weather days, or HVAC Sizing Simulations
    bool DoHVACSizingSimulation = false;              // User input in SimulationControl object
    int HVACSizingSimMaxIterations = 0;               // User input in SimulationControl object
    bool WeathSimReq = false;                         // Input has a RunPeriod request
    bool DoOutputReporting = false;                   // TRUE if variables to be written out
    bool DoingSizing = false;                         // TRUE when "sizing" is being performed (some error messages won't be displayed)
    bool DoingHVACSizingSimulations = false;          // true when HVAC Sizing Simulations are being performed.
    bool DoingInputProcessing = false;                // TRUE when "IP" is being performed (some error messages are cached)
    bool DisplayAllWarnings = false;                  // True when selection for  "DisplayAllWarnings" is entered (turns on other warning flags)
    bool DisplayExtraWarnings = false;                // True when selection for  "DisplayExtraWarnings" is entered
    bool DisplayUnusedObjects = false;                // True when selection for  "DisplayUnusedObjects" is entered
    bool DisplayUnusedSchedules = false;              // True when selection for  "DisplayUnusedSchedules" is entered
    bool DisplayAdvancedReportVariables = false;      // True when selection for  "DisplayAdvancedReportVariables" is entered
    bool DisplayZoneAirHeatBalanceOffBalance = false; // True when selection for  "DisplayZoneAirHeatBalanceOffBalance" is entered
    bool DisplayInputInAudit = false;                 // True when environmental variable "DisplayInputInAudit" is used
    bool CreateMinimalSurfaceVariables = false;       // True when selection for  "CreateMinimalSurfaceVariables" is entered
    Real64 CurrentTime = 0.0;                         // CurrentTime, in fractional hours, from start of day. Uses Loads time step.
    int SimTimeSteps = 0;                             // Number of (Loads) timesteps since beginning of run period (environment).
    int MinutesInTimeStep = 0;    // Minutes per time step calculated from NumTimeStepInHour (number of minutes per load time step)
    Real64 TimeStepZoneSec = 0.0; // Seconds per time step
    bool MetersHaveBeenInitialized = false;
    bool KickOffSimulation = false;                // Kick off simulation -- meaning run each environment for 1 or 2 time steps.
    bool KickOffSizing = false;                    // Kick off sizing -- meaning run each environment for 1 or 2 time steps.
    bool RedoSizesHVACSimulation = false;          // doing kick off simulation for redoing sizes as part of sizing
                                                   //    bool FinalSizingHVACSizingSimIteration = false; // when doing HVAC sizing Simulation
    bool AnyEnergyManagementSystemInModel = false; // true if there is any EMS or Erl in model.  otherwise false
    bool AnySurfPropOverridesInModel = false;      // true if there is any EMS or Erl overriding the surface properties for any surface.
    bool AnyConstrOverridesInModel = false;        // true if there is any EMS or Erl overriding the constructions for any surface.
    bool AnyShadingControlInModel = false;         // true if there is any window shading control for any fenestration surface
    bool AnyInsideShelf = false;                   // true if these is any inside daylighting shelf
    bool AnyLocalEnvironmentsInModel = false;      // true if there is any local environmental data objected defined in model, otherwise false
    bool AnyPlantInModel = false;                  // true if there are any plant or condenser loops in model, otherwise false
    bool AnyIdealCondEntSetPointInModel = false;   // true if there is any ideal condenser entering set point manager in model.
    bool RunOptCondEntTemp = false;                // true if the ideal condenser entering set point optimization is running
    bool CompLoadReportIsReq = false;              // true if the extra sizing calcs are performed to create a "pulse" for the load component report
    bool isPulseZoneSizing = false;                // true during the set of zone sizing calcs that include the "pulse" for the load component report
    bool doLoadComponentPulseNow = false;          // true for the time step that is the "pulse" for the load component report
    bool ShowDecayCurvesInEIO = false;             // true if the Radiant to Convective Decay Curves should appear in the EIO file
    bool AnySlabsInModel = false;                  // true if there are any zone-coupled ground domains in the input file
    bool AnyBasementsInModel = false;              // true if there are any basements in the input file
    bool DoCoilDirectSolutions = false;            // true if use coil direction solutions
    bool createPerfLog = false; // true if the _perflog.csv file should be created and a PerformancePrecisionTradeoffs object is used
    bool ReportPlantCompWaterFlowDataFlag = true;
    void (*fProgressPtr)(int const) = nullptr;
    void (*fMessagePtr)(std::string const &) = nullptr;
    std::function<void(int const)> progressCallback = nullptr;
    std::function<void(const std::string &)> messageCallback = nullptr;
    std::function<void(EnergyPlus::Error e, const std::string &)> errorCallback = nullptr;
    bool eplusRunningViaAPI = false;
    int NumOfWaterHeater = 0;
    bool CountNonZoneEquip = true;
    int FDsimDay = 0;
    int FDnumIterYears = 0;
    bool printConsoleOutput = true;
    bool installRootOverride = false;
    int numThread = 1;
    bool AirLoopHVACDOASUsedInSim = false;

    void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
    {
    }

    void init_state([[maybe_unused]] EnergyPlusData &state) override
    {
    }

    void clear_state() override
    {
        new (this) DataGlobal();
    }
};

} // namespace EnergyPlus

#endif