ExecutableGroup.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_DATAREPOSITORY_EXECUTABLEGROUP_HPP_
#define GEOS_DATAREPOSITORY_EXECUTABLEGROUP_HPP_
 
#include "common/format/EnumStrings.hpp"
#include "common/DataTypes.hpp"
#include "Group.hpp"
 
 
namespace geos
{
 
class DomainPartition;
 
class ExecutableGroup : public dataRepository::Group
{
public:
 
  using dataRepository::Group::Group;
 
  ExecutableGroup() = delete;
 
  ExecutableGroup( ExecutableGroup const & ) = delete;
 
  ExecutableGroup( ExecutableGroup && ) = default;
 
  ExecutableGroup & operator=( ExecutableGroup const & ) = delete;
 
  ExecutableGroup & operator=( ExecutableGroup && ) = delete;
 
  virtual ~ExecutableGroup() override = default;
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) = 0;
 
  virtual void signalToPrepareForExecution( real64 const time_n,
                                            real64 const dt,
                                            integer const cycle,
                                            DomainPartition & domain );
  virtual void cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain );
 
  virtual real64 getTimestepRequest( real64 const time )
  {
    GEOS_UNUSED_VAR( time );
    return 1e99;
  }
 
  enum class TimesteppingBehavior : integer
  {
    DeterminesTimeStepSize, 
    DoesNotDetermineTimeStepSize 
  };
 
  void setTimesteppingBehavior( TimesteppingBehavior const timesteppingBehavior ) { m_timesteppingBehavior = timesteppingBehavior; }
 
  TimesteppingBehavior getTimesteppingBehavior() const { return m_timesteppingBehavior; }
 
private:
 
  TimesteppingBehavior m_timesteppingBehavior = TimesteppingBehavior::DoesNotDetermineTimeStepSize;
};
 
ENUM_STRINGS( ExecutableGroup::TimesteppingBehavior,
              "DeterminesTimeStepSize",
              "DoesNotDetermineTimeStepSize" );
}
 
 
#endif /* GEOS_DATAREPOSITORY_EXECUTABLEGROUP_HPP_ */