IVariableMng.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IVariableMng.h                                              (C) 2000-2023 */
/*                                                                           */
/* Variable manager interface.                                               */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IVARIABLEMNG_H
#define ARCANE_CORE_IVARIABLEMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IVariable;
class IVariableFilter;
class VariableInfo;
class MeshVariable;
class IModule;
class IParallelMng;
class IDataReader;
class IDataWriter;
class IObservable;
class ICheckpointReader;
class CheckpointReadInfo;
class ICheckpointWriter;
class IPostProcessorWriter;
class VariableRef;
class IMesh;
class IVariableUtilities;
class VariableStatusChangedEventArgs;
class IVariableMngInternal;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class IVariableMng
{
 public:
 
  virtual ~IVariableMng() = default; 
 
 public:

  ARCCORE_DEPRECATED_2020("Do not use this method. Try to get 'ISubDomain' from another way")
  virtual ISubDomain* subDomain() = 0;

  virtual IParallelMng* parallelMng() const = 0;

  virtual ITraceMng* traceMng() = 0;

  virtual IVariable* checkVariable(const VariableInfo& infos) = 0;
  virtual String generateTemporaryVariableName() = 0;

  virtual void dumpList(std::ostream&, IModule*) = 0;

  virtual void dumpList(std::ostream&) = 0;

  virtual Real exportSize(const VariableCollection& vars) = 0;

  virtual IObservable* writeObservable() = 0;

  virtual IObservable* readObservable() = 0;

  virtual void writeVariables(IDataWriter* writer, IVariableFilter* filter = 0) = 0;

  virtual void writeVariables(IDataWriter* writer, const VariableCollection& vars) = 0;

  virtual void writeCheckpoint(ICheckpointWriter* writer) = 0;

  virtual void writePostProcessing(IPostProcessorWriter* writer) = 0;

  virtual void readVariables(IDataReader* reader, IVariableFilter* filter = 0) = 0;

  virtual void readCheckpoint(ICheckpointReader* reader) = 0;

  virtual void readCheckpoint(const CheckpointReadInfo& infos) = 0;

  virtual void variables(VariableRefCollection v, IModule* i) = 0;

  virtual VariableCollection variables() = 0;

  virtual VariableCollection usedVariables() = 0;

  virtual void notifyUsedVariableChanged() = 0;

  virtual IVariable* findVariable(const String& name) = 0;

  virtual IVariable* findMeshVariable(IMesh* mesh, const String& name) = 0;

  virtual IVariable* findVariableFullyQualified(const String& name) = 0;

  virtual void dumpStats(std::ostream& ostr, bool is_verbose) = 0;

  virtual void dumpStatsJSON(JSONWriter& writer) = 0;

  virtual IVariableUtilities* utilities() const = 0;

  virtual IVariableSynchronizerMng* synchronizerMng() const = 0;
 
 public:



  virtual EventObservable<const VariableStatusChangedEventArgs&>& onVariableAdded() = 0;

  virtual EventObservable<const VariableStatusChangedEventArgs&>& onVariableRemoved() = 0;
 
 public:

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void build() = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void initialize() = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void removeAllVariables() = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void detachMeshVariables(IMesh* mesh) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void addVariableRef(VariableRef* var) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void removeVariableRef(VariableRef* var) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void addVariable(IVariable* var) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void removeVariable(IVariable* var) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual void initializeVariables(bool is_continue) = 0;
 
 public:

  ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
  virtual ISubDomain* _internalSubDomain() const = 0;
 
 public:

  virtual IVariableMngInternal* _internalApi() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif