EventManager.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
 
#ifndef GEOS_EVENTS_EVENTMANAGER_HPP_
#define GEOS_EVENTS_EVENTMANAGER_HPP_
 
#include "dataRepository/Group.hpp"
#include "EventBase.hpp"
#include "common/format/LogPart.hpp"
 
namespace geos
{
 
class DomainPartition;
 
namespace dataRepository
{
namespace keys
{
string const Events( "Events" );
}
}
 
class EventManager : public dataRepository::Group
{
public:
  EventManager( string const & name,
                Group * const parent );
 
  virtual ~EventManager() override;
 
  virtual Group * createChild( string const & childKey, string const & childName ) override;
 
  virtual void expandObjectCatalogs() override;
 
  bool run( DomainPartition & domain );
 
  struct viewKeyStruct
  {
    static constexpr char const * minTimeString() { return "minTime"; }
    static constexpr char const * maxTimeString() { return "maxTime"; }
    static constexpr char const * maxCycleString() { return "maxCycle"; }
 
    static constexpr char const * timeString() { return "time"; }
    static constexpr char const * dtString() { return "dt"; }
    static constexpr char const * cycleString() { return "cycle"; }
    static constexpr char const * currentSubEventString() { return "currentSubEvent"; }
 
    static constexpr char const * timeOutputFormat() { return "timeOutputFormat"; }
 
 
    dataRepository::ViewKey time = { "time" };
    dataRepository::ViewKey dt = { "dt" };
    dataRepository::ViewKey cycle = { "cycle" };
    dataRepository::ViewKey minTime = { "minTime" };
    dataRepository::ViewKey maxTime = { "maxTime" };
    dataRepository::ViewKey maxCycle = { "maxCycle" };
    dataRepository::ViewKey currentSubEvent = { "currentSubEvent" };
  } viewKeys;
 
  using CatalogInterface = dataRepository::CatalogInterface< EventBase, string const &, Group * const >;
 
  static CatalogInterface::CatalogType & getCatalog();
 
  enum class TimeOutputFormat : integer
  {
    seconds,
    minutes,
    hours,
    days,
    years,
    full
  };
 
private:
 
 
  void outputTime( LogPart & section ) const;
 
  void logEndOfCycleInformation( LogPart & logpart,
                                 integer const cycleNumber,
                                 integer const numOfSubSteps,
                                 std::vector< real64 > const & subStepDts ) const;
 
  real64 m_minTime;
 
  real64 m_maxTime;
 
  integer m_maxCycle;
 
  real64 m_time;
 
  real64 m_dt;
 
  integer m_cycle;
 
  integer m_currentSubEvent;
 
  TimeOutputFormat m_timeOutputFormat;
};
 
ENUM_STRINGS( EventManager::TimeOutputFormat,
              "seconds",
              "minutes",
              "hours",
              "days",
              "years",
              "full" );
 
} /* namespace geos */
 
#endif /* GEOS_EVENTS_EVENTMANAGER_HPP_ */