IVariable.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IVariable.h                                                 (C) 2000-2025 */
/*                                                                           */
/* Interface de la classe Variable.                                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IVARIABLE_H
#define ARCANE_CORE_IVARIABLE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/serialize/SerializeGlobal.h"
 
#include "arcane/utils/Ref.h"
#include "arcane/core/ItemTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IModule;
class IVariableMng;
class VariableRef;
class IDataReader;
class IDataWriter;
class VariableMng;
class Module;
class IVariableComputeFunction;
class IObservable;
class IDataOperation;
class IMemoryAccessTrace;
class IData;
class VariableDependInfo;
class VariableMetaData;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT IVariable
{
 public:

  enum eDependType
  {
    DPT_PreviousTime,
    DPT_CurrentTime
  };
 
 public:

  enum
  {
    PNoDump = (1 << 0),
    
    PNoNeedSync = (1 << 1),

    PHasTrace = (1 << 2),

    PSubDomainDepend = (1 << 3),

    PSubDomainPrivate = (1 << 4),

    PExecutionDepend = (1 << 5),

    PPrivate = (1 << 6),

    PTemporary = (1 << 7),

    PNoRestore= (1 << 8),

    PNoExchange= (1 << 9),

    PPersistant = (1 << 10),

    PNoReplicaSync = (1 << 11)
  };
 
 public:
 
  friend class VariableMng;
 
 public:
 
  virtual ~IVariable() = default; 
 
 public:

  virtual ISubDomain* subDomain() =0;
 
 public:

  virtual IVariableMng* variableMng() const =0;

  virtual Real allocatedMemory() const =0;

  virtual String name() const =0;

  virtual String fullName() const =0;

  virtual eDataType dataType() const =0;

  virtual eItemKind itemKind() const =0;
 
  virtual Integer dimension() const =0;

  virtual Integer multiTag() const =0;

  virtual Integer nbElement() const =0;

  virtual int property() const =0;

  virtual void notifyReferencePropertyChanged() =0;

  virtual void addVariableRef(VariableRef* var_ref) =0;

  virtual void removeVariableRef(VariableRef* var_ref) =0;

  virtual VariableRef* firstReference() const =0 ;

  virtual Integer nbReference() const =0;
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2021: This method is a noop")
  virtual void setTraceInfo(Integer id,eTraceType tt)=0;
 
 public:

  virtual void resize(Integer new_size) =0;

  virtual void resizeFromGroup() =0;

  virtual void shrinkMemory() =0;

  virtual void setAllocationInfo(const DataAllocationInfo& v) = 0;

  virtual DataAllocationInfo allocationInfo() const = 0;
 
 public:

  virtual bool initialize(const ItemGroup& group,const String& value) =0;
 



  virtual Integer checkIfSync(Integer max_print=0) =0;

  virtual Integer checkIfSame(IDataReader* reader,Integer max_print,bool compare_ghost) =0;

  virtual Integer checkIfSameOnAllReplica(Integer max_print=0) =0;

  virtual void synchronize() =0;
 
  // TODO: à rendre virtuelle pure (décembre 2024)
  virtual void synchronize(Int32ConstArrayView local_ids);
  
  ARCCORE_DEPRECATED_2020("Use meshHandle() instead")
  virtual IMesh* mesh() const =0;
  
  virtual MeshHandle meshHandle() const =0;

  virtual ItemGroup itemGroup() const =0;

  virtual String itemGroupName() const =0;

  virtual IItemFamily* itemFamily() const =0;

  virtual String itemFamilyName() const =0;

  virtual String meshName() const =0;

  ARCANE_DEPRECATED_REASON("Y2024: Use createMetaDataRef() instead")
  virtual VariableMetaData* createMetaData() const =0;

  virtual Ref<VariableMetaData> createMetaDataRef() const = 0;

  virtual void syncReferences() =0;
 
 public:
  
  virtual void setUsed(bool v) =0;

  virtual bool isUsed() const =0;
 

  virtual bool isPartial() const =0;
  
 public:

  virtual void copyItemsValues(Int32ConstArrayView source,Int32ConstArrayView destination) =0;

  virtual void copyItemsMeanValues(Int32ConstArrayView first_source,
                                   Int32ConstArrayView second_source,
                                   Int32ConstArrayView destination) = 0;

  virtual void compact(Int32ConstArrayView new_to_old_ids) =0;

  virtual void changeGroupIds(Int32ConstArrayView old_to_new_ids) = 0;
 
 public:

  virtual IData* data() =0;

  virtual const IData* data() const =0;

  virtual IDataFactoryMng* dataFactoryMng() const =0;



  virtual void serialize(ISerializer* sbuffer,IDataOperation* operation=0) =0;

  virtual void serialize(ISerializer* sbuffer,Int32ConstArrayView ids,IDataOperation* operation=0) =0;

  virtual ARCANE_DEPRECATED_2018 void write(IDataWriter* writer) =0;

  virtual ARCANE_DEPRECATED_2018 void read(IDataReader* reader) =0;

  virtual void notifyEndRead() =0;

  virtual void notifyBeginWrite() =0;

  virtual IObservable* writeObservable() =0;

  virtual IObservable* readObservable() =0;

  virtual IObservable* onSizeChangedObservable() =0;
  

  virtual void addTag(const String& tagname,const String& tagvalue) =0;  
  virtual void removeTag(const String& tagname) =0;
  virtual bool hasTag(const String& tagname) =0;
  virtual String tagValue(const String& tagname) =0;
 
 public:
 
  virtual void print(std::ostream& o) const =0;
 
 public:
  


  virtual void update() =0;
 
  virtual void update(Real wanted_time) =0;

  virtual void setUpToDate() =0;

  virtual Int64 modifiedTime() =0;

  virtual void addDepend(IVariable* var,eDependType dt) =0;

  virtual void addDepend(IVariable* var,eDependType dt,const TraceInfo& tinfo) =0;

  virtual void removeDepend(IVariable* var) =0;

  virtual void setComputeFunction(IVariableComputeFunction* v) =0;

  virtual IVariableComputeFunction* computeFunction() =0;

  virtual void dependInfos(Array<VariableDependInfo>& infos) =0;
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2021: This method is a noop")
  virtual IMemoryAccessTrace* memoryAccessTrace() const =0;

  virtual void setIsSynchronized() =0;

  virtual void setIsSynchronized(const ItemGroup& item_group) =0;
 
 public:

  static Int64 incrementModifiedTime();
 
 public:

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