SoloEvent.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_SOLOEVENT_HPP_
#define GEOSX_MANAGERS_EVENTS_SOLOEVENT_HPP_

#include "managers/Events/EventBase.hpp"

namespace geosx
{

class SoloEvent : public EventBase
{
public:

  SoloEvent( const std::string & name,
             Group * const parent );

  virtual ~SoloEvent() override;

  static string CatalogName() { return "SoloEvent"; }

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

  virtual real64 GetEventTypeDtRequest( real64 const time ) override;

  struct viewKeyStruct
  {
    static constexpr auto targetTimeString = "targetTime";
    static constexpr auto targetCycleString = "targetCycle";
    static constexpr auto targetExactTimestepString = "targetExactTimestep";

    dataRepository::ViewKey targetTime = { "targetTime" };
    dataRepository::ViewKey targetCycle = { "targetCycle" };
    dataRepository::ViewKey targetExactTimestep = { "targetExactTimestep" };
  } SoloEventViewKeys;

  real64 m_targetTime;
  integer m_targetCycle;
  integer m_targetExactTimestep;

};

} /* namespace geosx */

#endif /* GEOSX_MANAGERS_EVENTS_SOLOEVENT_HPP_ */