ITimeLoopMng.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ITimeLoopMng.h                                              (C) 2000-2025 */
/*                                                                           */
/* Time loop manager interface.                                              */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITIMELOOPMNG_H
#define ARCANE_CORE_ITIMELOOPMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class IBackwardMng;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
enum class eTimeLoopEventType
{
  BeginEntryPoint,
  EndEntryPoint,
  BeginIteration,
  EndIteration
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

enum class eTimeLoopStopReason
{
  NoStop = 0,
  NoReason = 1,
  Error = 2,
  FinalTimeReached = 3,
  MaxIterationReached = 4
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ITimeLoopMng
{
 public:
 
  virtual ~ITimeLoopMng() {} 
 
 public:
 
  virtual void build() = 0;
 
  //virtual void initialize() =0;
 
 public:

  virtual ISubDomain* subDomain() const = 0;

  virtual void execExitEntryPoints() = 0;

  virtual void execBuildEntryPoints() = 0;

  virtual void execInitEntryPoints(bool is_continue) = 0;

  //virtual void execLoadBalanceEntryPoints() =0;

  virtual void execOnMeshChangedEntryPoints() = 0;

  virtual void execOnMeshRefinementEntryPoints() = 0;

  virtual void stopComputeLoop(bool is_final_time, bool has_error = false) = 0;

  virtual bool finalTimeReached() const = 0;

  virtual Real cpuTimeUsed() const = 0;

  virtual EntryPointCollection loopEntryPoints() = 0;

  virtual EntryPointCollection usedTimeLoopEntryPoints() = 0;

  virtual void doExecNextEntryPoint(bool& is_last) = 0;

  virtual IEntryPoint* nextEntryPoint() = 0;

  virtual IEntryPoint* currentEntryPoint() = 0;

  virtual int doOneIteration() = 0;

  virtual int doComputeLoop(Integer max_loop = 0) = 0;


  virtual void registerTimeLoop(ITimeLoop* time_loop) = 0;

  virtual void setUsedTimeLoop(const String& name) = 0;

  virtual ITimeLoop* usedTimeLoop() const = 0;
 
  virtual void setBackwardMng(IBackwardMng* backward_mng) = 0;
 
  virtual IBackwardMng* getBackwardMng() const = 0;

  virtual void goBackward() = 0;

  virtual bool isDoingBackward() = 0;

  virtual void registerActionMeshPartition(IMeshPartitionerBase* mesh_partitioner) = 0;

  virtual void setBackwardSavePeriod(Integer n) = 0;

  virtual void setVerificationActive(bool is_active) = 0;

  virtual void doVerification(const String& name) = 0;

  virtual void timeLoopsName(StringCollection& names) const = 0;

  virtual void timeLoops(TimeLoopCollection& time_loops) const = 0;

  virtual ITimeLoop* createTimeLoop(const String& name) = 0;

  virtual Integer nbLoop() const = 0;

  virtual IObservable* observable(eTimeLoopEventType type) = 0;

  virtual void setStopReason(eTimeLoopStopReason reason) = 0;

  virtual eTimeLoopStopReason stopReason() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif