ArcaneTypes.h

Aller à la documentation de ce fichier.

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ArcaneTypes.h                                               (C) 2000-2025 */
/*                                                                           */
/* Définition des types généraux de Arcane.                                  */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ARCANETYPES_H
#define ARCANE_CORE_ARCANETYPES_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/UtilsTypes.h"
#include "arcane/datatype/DataTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// GG: Ne devrait pas être ici. Il faudrait inclure "SerializeGlobal.h" à la
// place mais cela n'est pas possible tant que certains fichiers de
// 'arcane/utils' utilisent des fichiers d'en-tête de 'arcane/core'. C'est
// le cas par exemple des fichiers '*AMR*.h'.
 
namespace Arcane
{
class ISerializer;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IBase;
class ISession;
class IApplication;
class IRessourceMng;
class Real2;
class Real3;
class Real2x2;
class Real3x3;
class IData;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IArcaneMain;
class ApplicationInfo;
class IMainFactory;
class VersionInfo;
class ITimeStats;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IService;
class IServiceFactory;
class IServiceMng;
class IServiceInfo;
class IServiceInstance;
class ISingletonServiceInstance;
class IModule;
class ISubDomain;
class IServiceInstance;
class ModuleBuildInfo;
class ServiceBuildInfoBase;
class ServiceBuildInfo;
class ServiceProperty;
class ServiceInstanceRef;

typedef Ref<ISingletonServiceInstance> SingletonServiceInstanceRef;
namespace Internal
{
class IServiceFactory2;
class AbstractServiceFactory;
template<typename InterfaceType>
class IServiceFactory2T;
class ISingletonServiceFactory;
class ServiceInfo;
template<typename ServiceType>
class ServiceAllInterfaceRegisterer;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class CaseOptionsMain;
class CheckpointInfo;
class CheckpointReadInfo;
class CommonVariables;
class ConnectivityItemVector;
class FileContent;
class ICheckpointReader;
class ICheckpointWriter;
class IVariableMng;
class IMeshFactoryMng;
class IMeshMng;
class IMesh;
class IMeshArea;
class IMeshCompacter;
class IMeshExchanger;
class IMeshInternal;
class IMeshBase;
class IMeshPartitionConstraint;
class IUserDataList;
class IMeshBuilder;
class MeshHandle;
class MeshHandleOrMesh;
class MeshBuildInfo;
class MeshKind;
class IPrimaryMesh;
class IMeshInitialAllocator;
class ItemFamilyCompactInfos;
class ItemFamilyItemListChangedEventArgs;
class ItemPairEnumerator;
class ItemInfoListView;
class ItemGenericInfoListView;
class ItemPairGroupBuilder;
class IIndexedIncrementalItemConnectivityMng;
class IIndexedIncrementalItemConnectivity;
class IMeshInitialAllocator;
class UnstructuredMeshAllocateBuildInfo;
class CartesianMeshAllocateBuildInfo;
class IConfiguration;
class IIncrementalItemConnectivity;
class IIncrementalItemConnectivityInternal;
class IIncrementalItemTargetConnectivity;
class IIncrementalItemSourceConnectivity;
class VariableSynchronizerEventArgs;
class IVariableSynchronizerMng;
class IParallelMng;
class IParallelMngContainer;
class IParallelMngContainerFactory;
class IParallelReplication;
class IParallelNonBlockingCollective;
class IParallelMngUtilsFactory;
class IGetVariablesValuesParallelOperation;
class ITransferValuesParallelOperation;
class IVariableComputeFunction;
class IMemoryAccessTrace;
class IParallelExchanger;
class IVariableSynchronizer;
class IParallelTopology;
class IParallelMngInternal;
class IAsyncParticleExchanger;
class IIOMng;
class ITimerMng;
class IThreadMng;
class ItemUniqueId;
class IItemConnectivityInfo;
class IItemConnectivity;
class IItemConnectivitySynchronizer;
class IItemConnectivityGhostPolicy;
class IItemInternalSortFunction;
class IItemConnectivityMng;
class Properties;
class IItemFamilyTopologyModifier;
class IItemFamilyPolicyMng;
class IPhysicalUnit;
class IPhysicalUnitConverter;
class IPhysicalUnitSystem;
class IDataReader;
class IDataReader2;
class IDataWriter;
class IXmlDocumentHolder;
class VariableComparer;
class VariableComparerArgs;
class VariableComparerResults;
class SubDomainBuildInfo;
class XmlNode;
class TimeLoopEntryPointInfo;
class TimeLoopSingletonServiceInfo;
class Timer;
class VariableDependInfo;
class VariableMetaData;
enum class eVariableComparerCompareMode;
enum class eVariableComparerComputeDifferenceMethod;
enum class eMeshStructure;
enum class eMeshAMRKind;
using  TimeLoopEntryPointInfoCollection = Collection<TimeLoopEntryPointInfo>;
using TimeLoopSingletonServiceInfoCollection = Collection<TimeLoopSingletonServiceInfo>;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Les classes suivantes ne doivent pas être déclarées pour SWIG car ce
// fichier est inclus par SWIG et la déclaration modifie la manière dont
// certaines classes sont générées ce qui conduit à des erreurs
#ifndef SWIG
class ItemVectorView;
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

enum eItemKind
{
  IK_Node     = 0, 
  IK_Edge     = 1, 
  IK_Face     = 2, 
  IK_Cell     = 3, 
  IK_DoF      = 4, 
  IK_Particle = 5, 
  IK_Unknown  = 6  
};

static const Integer NB_ITEM_KIND = 6;

extern "C++" ARCANE_CORE_EXPORT const char*
itemKindName(eItemKind kind);

extern "C++" ARCANE_CORE_EXPORT std::ostream&
operator<< (std::ostream& ostr,eItemKind item_kind);

extern "C++" ARCANE_CORE_EXPORT std::istream&
operator>> (std::istream& istr,eItemKind& item_kind);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static const Integer NULL_ITEM_ID = static_cast<Integer>(-1);

static const Integer NULL_ITEM_LOCAL_ID = static_cast<Integer>(-1);

static const Int64 NULL_ITEM_UNIQUE_ID = static_cast<Int64>(-1);

static const Integer NULL_SUB_DOMAIN_ID = static_cast<Integer>(-1);

static const Int32 A_NULL_RANK = static_cast<Int32>(-1);

static const Int16 IT_NullType = 0;
static const Int16 IT_Vertex = 1;
static const Int16 IT_Line2 = 2;
static const Int16 IT_Triangle3 = 3;
static const Int16 IT_Quad4 = 4;
static const Int16 IT_Pentagon5 = 5;
static const Int16 IT_Hexagon6 = 6;
static const Int16 IT_Tetraedron4 = 7;
static const Int16 IT_Pyramid5 = 8;
static const Int16 IT_Pentaedron6 = 9;
static const Int16 IT_Hexaedron8 = 10;
static const Int16 IT_Heptaedron10 = 11;
static const Int16 IT_Octaedron12 = 12;
static const Int16 IT_HemiHexa7 = 13;
static const Int16 IT_HemiHexa6 = 14;
static const Int16 IT_HemiHexa5 = 15;
static const Int16 IT_AntiWedgeLeft6 = 16;
static const Int16 IT_AntiWedgeRight6 = 17;
static const Int16 IT_DiTetra5 = 18;
static const Int16 IT_DualNode = 19;
static const Int16 IT_DualEdge = 20;
static const Int16 IT_DualFace = 21;
static const Int16 IT_DualCell = 22;
static const Int16 IT_Link = 23;
static const Int16 IT_FaceVertex = 24;
static const Int16 IT_CellLine2 = 25;
static const Int16 IT_DualParticle = 26;

static const Int16 IT_Enneedron14 = 27;
static const Int16 IT_Decaedron16 = 28;

static const Int16 IT_Heptagon7 = 29;

static const Int16 IT_Octogon8 = 30;



static const Int16 IT_Line3 = 31;
static const Int16 IT_Triangle6 = 32;
static const Int16 IT_Quad8 = 33;
static const Int16 IT_Tetraedron10 = 34;
static const Int16 IT_Hexaedron20 = 35;


static const Int16 IT_Cell3D_Line2 = 36;
static const Int16 IT_Cell3D_Triangle3 = 37;
static const Int16 IT_Cell3D_Quad4 = 38;

static const Integer NB_BASIC_ITEM_TYPE = 39;
 
extern "C++" ARCANE_CORE_EXPORT eItemKind
dualItemKind(Integer type);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
enum eTimePhase
{
  TP_Computation = 0,
  TP_Communication,
  TP_InputOutput
};
static const Integer NB_TIME_PHASE = 3;

extern "C++" ARCANE_CORE_EXPORT std::ostream&
operator<< (std::ostream& ostr,eTimePhase time_phase);

extern "C++" ARCANE_CORE_EXPORT std::istream&
operator>> (std::istream& istr,eTimePhase& time_phase);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

enum eMeshDirection
{
  MD_DirX = 0,
  MD_DirY = 1,
  MD_DirZ = 2,
  MD_DirInvalid = (-1)
};

extern "C++" ARCANE_CORE_EXPORT std::ostream&
operator<<(std::ostream& o,eMeshDirection md);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ISubDomain;
 
template<typename T> class SimplePropertyT;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template<typename DataType>
class IScalarDataT;
template<typename DataType>
class IArrayDataT;
template<typename DataType>
class IArray2DataT;
template<typename DataType>
class IMultiArray2DataT;
 
template<typename DataType>
class VariableScalarT;
template<typename DataType>
class VariableArrayT;
template<typename DataType>
class Array2VariableT;
 
template<typename DataType>
class VariableRefScalarT;
template<typename DataType>
class VariableRefArrayT;
template<typename DataType>
class VariableRefArray2T;
// TODO: Ce type n'est plus utilisé. A supprimer fin 2025
template<typename DataType>
class MultiArray2VariableRefT;
 
template<typename DataType>
class ItemVariableScalarRefT;
template<typename ItemType,class DataType>
class MeshVariableScalarRefT;
template<typename ItemType,class DataType>
class MeshVariableArrayRefT;
template<typename DataType>
class ItemPartialVariableScalarRefT;
template<typename ItemType,class DataType>
class MeshPartialVariableScalarRefT;
template<typename ItemTypeT, typename DataTypeT>
class SharedMeshVariableScalarRefT;
template<typename DataTypeT>
class SharedItemVariableScalarRefT;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template <typename DataType>
class DataViewSetter;
template <typename DataType>
class DataViewGetter;
template <typename DataType>
class DataViewGetterSetter;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template <typename ItemType, typename DataType, typename Extents>
class MeshMDVariableRefBaseT;
template <typename ItemType, typename DataType, typename Extents>
class MeshMDVariableRefT;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class CollectionBase;
class IItemFamily;
class IItemFamilyInternal;
class IItemFamilyCompactPolicy;
class IItemFamilyExchanger;
class IItemFamilySerializer;
class IItemFamilySerializeStepFactory;
class ItemFamilySerializeArgs;
class ILoadBalanceMng;
class IMesh;
class IMeshPartitioner;
class IMeshPartitionerBase;
class IModule;
class IService;
class IServiceFactoryInfo;
class IModuleFactoryInfo;
class IServiceInstance;
class IEntryPoint;
class ITimeLoop;
class ITimeLoopService;
class IVariable;
class IVariableInternal;
class VariableRef;
class Item;
class CaseOptionBuildInfo;
class CaseOptionEnum;
class CaseOptionExtended;
class CaseOptionMultiSimple;
class CaseOptionServiceImpl;
class CaseOptionSimple;
class CaseOptionMultiEnum;
class CaseOptionMultiExtended;
class CaseOptionMultiServiceImpl;
class ICaseOptions;
class ICaseFunction;
class ICaseDocument;
class ICaseDocumentFragment;
class ICaseMng;
class ICaseOptionList;
class IPhysicalUnitSystem;
class ItemGroup;
class ITiedInterface;
class VariableCollection;
typedef VariableCollection VariableList;

typedef Collection<IModule*> ModuleCollection;
typedef Collection<IService*> ServiceCollection;
typedef Collection<ServiceInstanceRef> ServiceInstanceCollection;
typedef Collection<SingletonServiceInstanceRef> SingletonServiceInstanceCollection;
typedef Collection<Internal::IServiceFactory2*> ServiceFactory2Collection;
typedef Collection<IServiceFactoryInfo*> ServiceFactoryInfoCollection;
typedef Collection<IModuleFactoryInfo*> ModuleFactoryInfoCollection;
typedef Collection<IEntryPoint*> EntryPointCollection;
typedef Collection<ITimeLoop*> TimeLoopCollection;
typedef Collection<VariableRef*> VariableRefCollection;
typedef Collection<ItemGroup> ItemGroupCollection;
typedef Collection<ISubDomain*> SubDomainCollection;
typedef Collection<ISession*> SessionCollection;
typedef Collection<ICaseOptions*> CaseOptionsCollection;
typedef Collection<IItemFamily*> IItemFamilyCollection;
typedef Collection<IItemFamily*> ItemFamilyCollection;
typedef Collection<IMesh*> IMeshCollection;
typedef Collection<IMesh*> MeshCollection;
typedef Collection<ITiedInterface*> TiedInterfaceCollection;

typedef List<IModule*> ModuleList;
typedef List<IService*> ServiceList;
typedef List<IEntryPoint*> EntryPointList;
typedef List<ITimeLoop*> TimeLoopList;
typedef List<VariableRef*> VariableRefList;
typedef List<ItemGroup> ItemGroupList;
typedef List<ISubDomain*> SubDomainList;
typedef List<ISession*> SessionList;
typedef List<ICaseOptions*> CaseOptionsList;
typedef List<ITiedInterface*> TiedInterfaceList;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IDataVisitor;
class IScalarDataVisitor;
class IArrayDataVisitor;
class IArray2DataVisitor;
class IMultiArray2DataVisitor;
class IDataOperation;
class ISerializedData;
class IHashAlgorithm;
class DataAllocationInfo;
class DataStorageTypeInfo;
class ISerializedData;
class IDataFactoryMng;
class IDataStorageFactory;
class DataStorageBuildInfo;
class CaseDatasetSource;
class IDataInternal;
template<typename DataType> class IArrayDataInternalT;
template<typename DataType> class IArray2DataInternalT;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IVariableRef;
class IVariableFactory;
class VariableTypeInfo;
class VariableRef;
class VariableBuildInfo;
class NullVariableBuildInfo;
class VariableFactoryRegisterer;
class VariableInfo;
typedef VariableRef* (*VariableFactoryVariableRefCreateFunc)(const VariableBuildInfo& vb);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Accelerator
{
class IAcceleratorMng;
class AcceleratorRuntimeInitialisationInfo;
}
using Accelerator::IAcceleratorMng;
using Accelerator::AcceleratorRuntimeInitialisationInfo;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
// Déclarations de types utilisés pour les classes 'friend'.
namespace mesh
{
class DynamicMesh;
class ItemFamily;
class ItemSharedInfoWithType;
class DynamicMeshKindInfos;
class ItemDataList;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::IData)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::ISerializedData)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::ICaseFunction)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::ICaseOptions)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::ICaseMng)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::ICaseOptionList)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::IIncrementalItemSourceConnectivity)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::IIncrementalItemTargetConnectivity)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::IParallelMng)
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::IParallelMngContainer)
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
typedef Collection<Ref<ICaseFunction>> CaseFunctionCollection;
typedef List<Ref<ICaseFunction>> CaseFunctionList;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif