PeriodicEvent.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_PERIODICEVENT_HPP_
#define GEOS_EVENTS_PERIODICEVENT_HPP_
 
#include "events/EventBase.hpp"
 
namespace geos
{
 
class PeriodicEvent : public EventBase
{
public:
 
  PeriodicEvent( const string & name,
                 Group * const parent );
 
  virtual ~PeriodicEvent() override;
 
  static string catalogName() { return "PeriodicEvent"; }
 
  virtual void estimateEventTiming( real64 const time,
                                    real64 const dt,
                                    integer const cycle,
                                    DomainPartition & domain ) override;
 
  void checkOptionalFunctionThreshold( real64 const time,
                                       real64 const dt,
                                       integer const cycle,
                                       DomainPartition & domain );
 
  virtual real64 getEventTypeDtRequest( real64 const time ) override;
 
  virtual void cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  virtual void validate() const override;
 
  dataRepository::Group * m_functionTarget;
 
  struct viewKeyStruct
  {
    static constexpr char const * timeFrequencyString() { return "timeFrequency"; }
    static constexpr char const * cycleFrequencyString() { return "cycleFrequency"; }
    static constexpr char const * targetExactTimestepString() { return "targetExactTimestep"; }
    static constexpr char const * functionNameString() { return "function"; }
    static constexpr char const * functionInputObjectString() { return "object"; }
    static constexpr char const * functionInputSetnameString() { return "set"; }
    static constexpr char const * functionSetNamesString() { return "setNames"; }
    static constexpr char const * functionStatOptionString() { return "stat"; }
    static constexpr char const * eventThresholdString() { return "threshold"; }
 
    dataRepository::ViewKey timeFrequency = { timeFrequencyString() };
    dataRepository::ViewKey cycleFrequency = { cycleFrequencyString() };
    dataRepository::ViewKey targetExactTimestep = { targetExactTimestepString() };
    dataRepository::ViewKey functionName = { functionNameString() };
    dataRepository::ViewKey functionInputObject = { functionInputObjectString() };
    dataRepository::ViewKey functionInputSetname = { functionInputSetnameString() };
    dataRepository::ViewKey functionSetNames = { functionSetNamesString() };
    dataRepository::ViewKey functionStatOption = { functionStatOptionString() };
    dataRepository::ViewKey eventThreshold = { eventThresholdString() };
  } periodicEventViewKeys;
 
  real64 m_timeFrequency;
  integer m_cycleFrequency;
  integer m_targetExactTimestep;
  string m_functionName;
  string m_functionInputObject;
  string m_functionInputSetname;
  integer m_functionStatOption;
  real64 m_eventThreshold;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_EVENTS_PERIODICEVENT_HPP_ */