ExecutableGroup.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_DATAREPOSITORY_EXECUTABLEGROUP_HPP_
#define GEOSX_DATAREPOSITORY_EXECUTABLEGROUP_HPP_

#include "common/DataTypes.hpp"
#include "Group.hpp"


namespace geosx
{

class ExecutableGroup : public dataRepository::Group
{
public:

  using dataRepository::Group::Group;

  virtual void Execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) = 0;

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

  virtual real64 GetTimestepRequest( real64 const time )
  {
    GEOSX_UNUSED_VAR( time );
    return 1e99;
  }


  void SetTimestepBehavior( integer const behavior ) { m_timestepType = behavior; }

  integer GetTimestepBehavior() { return m_timestepType; }


private:
  integer m_timestepType = 0;
};


}


#endif /* GEOSX_DATAREPOSITORY_EXECUTABLEGROUP_HPP_ */