EnclaveTasking.EnclaveTask.template.h

Go to the documentation of this file.

// This file is part of the ExaHyPE2 project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include "repositories/SolverRepository.h"
 
#include "tarch/multicore/Task.h"
 
#include "peano4/datamanagement/CellMarker.h"
 
#include "exahype2/EnclaveBookkeeping.h"
#include "exahype2/EnclaveTask.h"
 
{{SOLVER_INCLUDES}}
 
#include <vector>
#include <memory>
 
#ifdef UseSmartMPI
#include "smartmpi.h"
#endif
 
{% for item in NAMESPACE -%}
  namespace {{ item }} {
 
{%- endfor %}
  class {{CLASSNAME}};
 
{% for item in NAMESPACE -%}
  }
{%- endfor %}
 
class {{NAMESPACE | join("::")}}::{{CLASSNAME}}: public ::exahype2::EnclaveTask
#ifdef UseSmartMPI
, public smartmpi::Task
#endif
{
  private:
    static tarch::logging::Log  _log;
 
    #ifdef UseSmartMPI
    /*
     * This uniquely identifies an enclave task. Unlike _enclaveTaskTypeId it
     * differentiates between tasks within a task type, not between task types.
     *
     * Crucially, the value of this ID is not necessarily the same as that of
     * tarch::multicore::Task::_id . That is because _id is reset each time
     * we move a task to another rank and reconstitute it there (see the constructor
     * of tarch::multicore::Task). Instead, _remoteTaskId tracks the ID of
     * the original task object (i.e. the task originally spawned and
     * only then moved). In smartmpi we need to keep track of the task's
     * ID so that it can be bookmarked correctly after being moved around.
     *
     * As such moveTask(...), sends _id if the task has not yet been
     * moved and _remoteTaskId if it has already been moved. Similarly,
     * _remoteTaskId is always sent when forwarding task outcomes since the
     * task will already have been moved.
     */
    int          _remoteTaskId = -1;
    #endif
 
    static int                                _enclaveTaskTypeId;
 
  public:
    static int getEnclaveTaskTypeId();
 
    static double applyKernelToCell(
      const ::peano4::datamanagement::CellMarker& marker,
      double                                      t,
      double                                      dt,
      double* __restrict__                        reconstructedPatch,
      double* __restrict__                        targetPatch
    );
 
    {{CLASSNAME}}(
      const ::peano4::datamanagement::CellMarker& marker,
      double                                      t,
      double                                      dt,
      double* __restrict__                        reconstructedPatch,
      double* __restrict__                        output
    );
 
    #ifdef UseSmartMPI
    bool isSmartMPITask() const;
 
    virtual void runLocally() override;
    virtual void moveTask(int rank, int tag, MPI_Comm communicator) override;
    virtual void runLocallyAndSendTaskOutputToRank(int rank, int tag, MPI_Comm communicator) override;
    virtual void forwardTaskOutputToRank(int rank, int tag, MPI_Comm communicator) override;
 
    static smartmpi::Task* receiveTask(int rank, int tag, MPI_Comm communicator);
    static smartmpi::Task* receiveOutcome(int rank, int tag, MPI_Comm communicator, const bool intentionToForward);
    #endif
 
    {% if STATELESS_PDE_TERMS %}
    virtual void fuse(const std::vector<Task*>& otherTasks, int targetDevice = Host) override;
    virtual bool canFuse() const override;
    {% endif %}
};
 
{# Empty line here #}