OutputChecker.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* OutputChecker.h                                             (C) 2000-2025 */
/*                                                                           */
/* Outputs based on time (physical or CPU) or a number of iterations.        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_OUTPUTCHECKER_H
#define ARCANE_CORE_OUTPUTCHECKER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
 
#include "arcane/core/VariableTypes.h"
#include "arcane/core/CaseOptions.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \brief Manages outputs based on physical time, CPU time, or
 * a number of iterations.
 *
 * CPU time is expressed in minutes.
 */
class ARCANE_CORE_EXPORT OutputChecker
{
 public:
 
  //! Output type
  enum eOutType
  {
    OutTypeNone, //!< No outputs
    OutTypeGlobalTime, //!< Output based on physical time
    OutTypeCPUTime, //!< Output based on consumed CPU time
    OutTypeIteration //!< Output based on number of iterations
  };
 
 public:
 
  OutputChecker(ISubDomain* sd, const String& name);
 
 public:
 
  void initialize();
  void initialize(bool recompute_next_value);
  bool hasOutput() const { return m_out_type != OutTypeNone; }
  bool check(Real old_time, Real current_time, Integer current_iteration,
             Integer current_cpu_time, const String& from_function = String());
  void assignGlobalTime(VariableScalarReal* variable, const CaseOptionReal* option);
  void assignCPUTime(VariableScalarInteger* variable, const CaseOptionInteger* option);
  void assignIteration(VariableScalarInteger* variable, const CaseOptionInteger* option);
  Real nextGlobalTime() const;
  Integer nextIteration() const;
  Integer nextCPUTime() const;
 
 private:
 
  ISubDomain* m_sub_domain = nullptr;
  String m_name;
  eOutType m_out_type = OutTypeNone;
  VariableScalarInteger* m_next_iteration = nullptr; //!< Next save iteration
  VariableScalarReal* m_next_global_time = nullptr; //!< Physical time of the next save
  VariableScalarInteger* m_next_cpu_time = nullptr; //!< CPU time of the next save
  const CaseOptionInteger* m_step_iteration = nullptr;
  const CaseOptionReal* m_step_global_time = nullptr;
  const CaseOptionInteger* m_step_cpu_time = nullptr;
 
 private:
 
  void _recomputeTypeGlobalTime();
  void _recomputeTypeCPUTime();
  void _recomputeTypeIteration();
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif