CommonVariables.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* CommonVariables.h                                           (C) 2000-2025 */
/*                                                                           */
/* Common variables describing a case.                                       */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_COMMONVARIABLES_H
#define ARCANE_CORE_COMMONVARIABLES_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
 
#include "arcane/core/VariableTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ModuleMaster;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CommonVariables
{
 public:
 
  friend class ModuleMaster;
 
 public:

  CommonVariables(IModule* c);
  CommonVariables(IVariableMng* variable_mng);
  // TODO: make deprecated
  CommonVariables(ISubDomain* sd);
  virtual ~CommonVariables() {} 
 
 public:

  Int32 globalIteration() const;
  Real globalTime() const;
  Real globalOldTime() const;
  Real globalFinalTime() const;
  Real globalDeltaT() const;
  Real globalCPUTime() const;
  Real globalOldCPUTime() const;
  Real globalElapsedTime() const;
  Real globalOldElapsedTime() const;
 
 private:
 public:
 
  VariableScalarInt32 m_global_iteration; 
  VariableScalarReal m_global_time; 
  VariableScalarReal m_global_deltat; 
  VariableScalarReal m_global_old_time; 
  VariableScalarReal m_global_old_deltat; 
  VariableScalarReal m_global_final_time; 
  VariableScalarReal m_global_old_cpu_time; 
  VariableScalarReal m_global_cpu_time; 
  VariableScalarReal m_global_old_elapsed_time; 
  VariableScalarReal m_global_elapsed_time; 
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif