ISubDomain.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ISubDomain.h                                                (C) 2000-2025 */
/*                                                                           */
/* Interface of a subdomain.                                                 */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ISUBDOMAIN_H
#define ARCANE_CORE_ISUBDOMAIN_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
#include "arcane/core/IBase.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IVariableMng;
class IModuleMng;
class IServiceMng;
class IEntryPointMng;
class IModule;
class IMeshIOService;
class IMesh;
class IMeshMng;
class ApplicationInfo;
class IIOMng;
class ITimeLoopMng;
class CaseOptionsMain;
class IParallelMng;
class IThreadMng;
class IDirectory;
class ITimeHistoryMng;
class ICaseMng;
class IInterfaceMng;
class ITimerMng;
class ITimeStats;
class IRessourceMng;
class CommonVariables;
class IMainFactory;
class ICaseDocument;
class XmlNode;
class IMemoryInfo;
class IObservable;
class IInitialPartitioner;
class IDirectExecution;
class IPhysicalUnitSystem;
class ILoadBalanceMng;
class IModuleMaster;
class ICheckpointMng;
class IPropertyMng;
class IConfiguration;
class MeshHandle;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ISubDomain
: public IBase
{
 protected:
 
  virtual ~ISubDomain() {} 
 
 public:
 
  virtual void destroy() = 0;
 
 public:

  virtual IMainFactory* mainFactory() = 0;

  virtual ISession* session() const = 0;

  virtual IApplication* application() = 0;

  virtual IVariableMng* variableMng() = 0;

  virtual IModuleMng* moduleMng() = 0;

  virtual IEntryPointMng* entryPointMng() = 0;

  virtual IParallelMng* parallelMng() = 0;

  virtual IParallelMng* allReplicaParallelMng() const = 0;

  virtual IThreadMng* threadMng() = 0;

  virtual ITimeHistoryMng* timeHistoryMng() = 0;

  virtual ITimeLoopMng* timeLoopMng() = 0;

  virtual IIOMng* ioMng() = 0;

  virtual ICaseMng* caseMng() = 0;

  virtual ITimerMng* timerMng() const = 0;

  virtual ICheckpointMng* checkpointMng() const = 0;

  virtual IPropertyMng* propertyMng() const = 0;

  virtual ITimeStats* timeStats() const = 0;

  virtual IMemoryInfo* memoryInfo() const = 0;

  virtual IPhysicalUnitSystem* physicalUnitSystem() = 0;

  virtual ILoadBalanceMng* loadBalanceMng() = 0;

  virtual IMeshMng* meshMng() const = 0;

  virtual IModuleMaster* moduleMaster() const = 0;

  virtual const IConfiguration* configuration() const = 0;

  virtual IConfiguration* configuration() = 0;

  virtual IAcceleratorMng* acceleratorMng() = 0;
 
 public:

  virtual Int32 subDomainId() const = 0;

  virtual Int32 nbSubDomain() const = 0;

  virtual void readCaseMeshes() = 0;

  virtual void setIsContinue() = 0;

  virtual bool isContinue() const = 0;

  virtual void allocateMeshes() = 0;

  virtual void readOrReloadMeshes() = 0;

  virtual void initializeMeshVariablesFromCaseFile() = 0;

  virtual void doInitMeshPartition() = 0;

  ARCCORE_DEPRECATED_2020("Use meshMng()->meshFactoryMng() to create and add mesh")
  virtual void addMesh(IMesh* mesh) = 0;

  virtual ConstArrayView<IMesh*> meshes() const = 0;

  virtual ARCANE_DEPRECATED_2018 void doInitModules() = 0;

  virtual void doExitModules() = 0;

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

  virtual IMesh* defaultMesh() = 0;

  virtual const MeshHandle& defaultMeshHandle() = 0;
 
  virtual ARCANE_DEPRECATED IMesh* mesh() = 0;

  ARCCORE_DEPRECATED_2019("Use meshMng()->findMeshHandle() instead")
  virtual IMesh* findMesh(const String& name, bool throw_exception = true) = 0;

  virtual bool isInitialized() const = 0;

  virtual void setIsInitialized() = 0;

  virtual const ApplicationInfo& applicationInfo() const = 0;

  virtual ICaseDocument* caseDocument() = 0;

  virtual void checkId(const String& where, const String& id) = 0;

  virtual const String& caseFullFileName() const = 0;

  virtual const String& caseName() const = 0;

  virtual void fillCaseBytes(ByteArray& bytes) const = 0;

  virtual void setCaseName(const String& name) = 0;

  virtual void setInitialPartitioner(IInitialPartitioner* partitioner) = 0;

  virtual const CaseOptionsMain* caseOptionsMain() const = 0;

  virtual const IDirectory& exportDirectory() const = 0;

  virtual void setExportDirectory(const IDirectory& dir) = 0;

  virtual const IDirectory& storageDirectory() const = 0;

  virtual void setStorageDirectory(const IDirectory& dir) = 0;

  virtual const IDirectory& listingDirectory() const = 0;

  virtual void setListingDirectory(const IDirectory& dir) = 0;

  virtual const CommonVariables& commonVariables() const = 0;

  virtual void dumpInternalInfos(XmlNode& elem) = 0;

  virtual Integer ARCANE_DEPRECATED meshDimension() const = 0;

  virtual IObservable* onDestroyObservable() = 0;

  virtual IDirectExecution* directExecution() const = 0;

  virtual void setDirectExecution(IDirectExecution* v) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif