SoloEvent.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_SOLOEVENT_HPP_
#define GEOS_EVENTS_SOLOEVENT_HPP_
 
#include "events/EventBase.hpp"
 
namespace geos
{
 
class SoloEvent : public EventBase
{
public:
 
  SoloEvent( const 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,
                                    DomainPartition & domain ) override;
 
  virtual real64 getEventTypeDtRequest( real64 const time ) override;
 
  struct viewKeyStruct
  {
    static constexpr char const * targetTimeString() { return "targetTime"; }
    static constexpr char const * targetCycleString() { return "targetCycle"; }
    static constexpr char const * targetExactTimestepString() { return "targetExactTimestep"; }
 
    dataRepository::ViewKey targetTime = { targetTimeString() };
    dataRepository::ViewKey targetCycle = { targetCycleString() };
    dataRepository::ViewKey targetExactTimestep = { targetExactTimestepString() };
  } SoloEventViewKeys;
 
  real64 m_targetTime;
  integer m_targetCycle;
  integer m_targetExactTimestep;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_EVENTS_SOLOEVENT_HPP_ */