TaskBase.hpp

Go to the documentation of this file.

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

#ifndef TASKBASE_HPP_
#define TASKBASE_HPP_

#include <string>
#include <limits>

#include "dataRepository/ExecutableGroup.hpp"
#include "common/DataTypes.hpp"
namespace geosx
{

class TaskBase : public ExecutableGroup
{
public:
  explicit TaskBase( std::string const & name,
                     Group * const parent );
  virtual ~TaskBase( ) override;

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

  using CatalogInterface = dataRepository::CatalogInterface< TaskBase, std::string const &, Group * const >;
  static CatalogInterface::CatalogType & GetCatalog();

  virtual void Execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override
  {
    GEOSX_UNUSED_VAR( time_n );
    GEOSX_UNUSED_VAR( dt );
    GEOSX_UNUSED_VAR( cycleNumber );
    GEOSX_UNUSED_VAR( eventCounter );
    GEOSX_UNUSED_VAR( eventProgress );
    GEOSX_UNUSED_VAR( domain );
    GEOSX_ERROR( "NOT IMPLEMENTED" );
  }

  void PostProcessInput() override;
};

} /* namespace */

#endif /* TASKBASE_HPP_ */