PeriodicEvent.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_MANAGERS_EVENTS_PERIODICEVENT_HPP_
#define GEOSX_MANAGERS_EVENTS_PERIODICEVENT_HPP_

#include "managers/Events/EventBase.hpp"

namespace geosx
{

class PeriodicEvent : public EventBase
{
public:

  PeriodicEvent( const std::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,
                                    dataRepository::Group * domain ) override;

  void CheckOptionalFunctionThreshold( real64 const time,
                                       real64 const dt,
                                       integer const cycle,
                                       dataRepository::Group * domain );

  virtual real64 GetEventTypeDtRequest( real64 const time ) override;

  virtual void Cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override;


  dataRepository::Group * m_functionTarget;

  struct viewKeyStruct
  {
    static constexpr auto timeFrequencyString = "timeFrequency";
    static constexpr auto cycleFrequencyString = "cycleFrequency";
    static constexpr auto targetExactTimestepString = "targetExactTimestep";
    static constexpr auto functionNameString = "function";
    static constexpr auto functionInputObjectString = "object";
    static constexpr auto functionInputSetnameString = "set";
    static constexpr auto functionSetNamesString = "setNames";
    static constexpr auto functionStatOptionString = "stat";
    static constexpr auto eventThresholdString = "threshold";

    dataRepository::ViewKey timeFrequency = { "timeFrequency" };
    dataRepository::ViewKey cycleFrequency = { "cycleFrequency" };
    dataRepository::ViewKey targetExactTimestep = { "targetExactTimestep" };
    dataRepository::ViewKey functionName = { "function" };
    dataRepository::ViewKey functionInputObject = { "object" };
    dataRepository::ViewKey functionInputSetname = { "set" };
    dataRepository::ViewKey functionSetNames = { "setNames" };
    dataRepository::ViewKey functionStatOption = { "stat" };
    dataRepository::ViewKey eventThreshold = { "threshold" };
  } 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 geosx */

#endif /* GEOSX_MANAGERS_EVENTS_PERIODICEVENT_HPP_ */