Interface of the subdomain manager. More...

#include <arcane/core/ISubDomain.h>

Public Member Functions
virtual void	destroy ()=0
virtual IMainFactory *	mainFactory ()=0
	Main factory.
virtual ISession *	session () const =0
	Session.
virtual IApplication *	application ()=0
	Application.
virtual IVariableMng *	variableMng ()=0
	Returns the variable manager.
virtual IModuleMng *	moduleMng ()=0
	Returns the module manager.
virtual IEntryPointMng *	entryPointMng ()=0
	Returns the entry point manager.
virtual IParallelMng *	parallelMng ()=0
	Returns the parallelism manager.
virtual IParallelMng *	allReplicaParallelMng () const =0
	Returns the parallelism manager for all replicas.
virtual IThreadMng *	threadMng ()=0
	Returns the thread manager.
virtual ITimeHistoryMng *	timeHistoryMng ()=0
	Returns the history manager.
virtual ITimeLoopMng *	timeLoopMng ()=0
	Returns the time loop manager.
virtual IIOMng *	ioMng ()=0
	Returns the I/O manager.
virtual ICaseMng *	caseMng ()=0
	Returns the dataset manager.
virtual ITimerMng *	timerMng () const =0
	Returns the timer manager.
virtual ICheckpointMng *	checkpointMng () const =0
	Protection manager.
virtual IPropertyMng *	propertyMng () const =0
	Property manager.
virtual ITimeStats *	timeStats () const =0
	Execution time statistics.
virtual IMemoryInfo *	memoryInfo () const =0
	Memory information manager.
virtual IPhysicalUnitSystem *	physicalUnitSystem ()=0
	Subdomain unit system.
virtual ILoadBalanceMng *	loadBalanceMng ()=0
	Returns the load balancing manager.
virtual IMeshMng *	meshMng () const =0
	Returns the mesh manager.
virtual IModuleMaster *	moduleMaster () const =0
	Module master interface.
virtual const IConfiguration *	configuration () const =0
	Associated configuration.
virtual IConfiguration *	configuration ()=0
	Associated configuration.
virtual IAcceleratorMng *	acceleratorMng ()=0
	Associated accelerator manager.
virtual Int32	subDomainId () const =0
	Subdomain ID associated with this manager.
virtual Int32	nbSubDomain () const =0
	Total number of subdomains.
virtual void	readCaseMeshes ()=0
	Reads the mesh information from the dataset.
virtual void	setIsContinue ()=0
virtual bool	isContinue () const =0
	True if a restart is being performed, false otherwise.
virtual void	allocateMeshes ()=0
virtual void	readOrReloadMeshes ()=0
virtual void	initializeMeshVariablesFromCaseFile ()=0
virtual void	doInitMeshPartition ()=0
virtual void	addMesh (IMesh *mesh)=0
	Adds a mesh to the subdomain.
virtual ConstArrayView< IMesh * >	meshes () const =0
	List of meshes in the subdomain.
virtual ARCANE_DEPRECATED_2018 void	doInitModules ()=0
virtual void	doExitModules ()=0
	Executes exit modules.
virtual void	dumpInfo (std::ostream &)=0
	Displays information about the instance.
virtual IMesh *	defaultMesh ()=0
	Default mesh.
virtual const MeshHandle &	defaultMeshHandle ()=0
	Handle for the default mesh.
virtual ARCANE_DEPRECATED IMesh *	mesh ()=0
virtual IMesh *	findMesh (const String &name, bool throw_exception=true)=0
	Searches for the mesh named name.
virtual bool	isInitialized () const =0
	Indicates if the session has been initialized.
virtual void	setIsInitialized ()=0
virtual const ApplicationInfo &	applicationInfo () const =0
	Executable information.
virtual ICaseDocument *	caseDocument ()=0
	Case XML document.
virtual void	checkId (const String &where, const String &id)=0
	Checks if an identifier is valid.
virtual const String &	caseFullFileName () const =0
	Full file path of the dataset.
virtual const String &	caseName () const =0
	Case name.
virtual void	fillCaseBytes (ByteArray &bytes) const =0
	Fills bytes with the dataset content.
virtual void	setCaseName (const String &name)=0
	Sets the case name.
virtual void	setInitialPartitioner (IInitialPartitioner *partitioner)=0
	Sets the initial partitioner.
virtual const CaseOptionsMain *	caseOptionsMain () const =0
	General dataset options.
virtual const IDirectory &	exportDirectory () const =0
	Base directory for exports.
virtual void	setExportDirectory (const IDirectory &dir)=0
	Sets the output path for exports (protections and restarts).
virtual const IDirectory &	storageDirectory () const =0
	Base directory for exports requiring archiving.
virtual void	setStorageDirectory (const IDirectory &dir)=0
	Sets the output path for exports requiring archiving.
virtual const IDirectory &	listingDirectory () const =0
	Base directory for listings (logs, execution info).
virtual void	setListingDirectory (const IDirectory &dir)=0
	Sets the output path for listing info.
virtual const CommonVariables &	commonVariables () const =0
	Information on standard variables.
virtual void	dumpInternalInfos (XmlNode &elem)=0
	Dumps internal architecture information. The information is stored in an XML tree with root as the root element. This information is for internal use by Arcane.
virtual Integer ARCANE_DEPRECATED	meshDimension () const =0
	Mesh dimension (1D, 2D, or 3D).
virtual IObservable *	onDestroyObservable ()=0
	Notification before subdomain destruction.
virtual IDirectExecution *	directExecution () const =0
	Direct execution service (or null).
virtual void	setDirectExecution (IDirectExecution *v)=0
	Sets the direct execution service.
Public Member Functions inherited from Arcane::IBase
virtual	~IBase ()=default
	Frees resources.
virtual void	build ()=0
	Constructs the instance members. The instance is not usable until this method has been called. This method must be called before initialize().
virtual void	initialize ()=0
	Initializes the instance. The instance is not usable until this method has been called.
virtual IBase *	objectParent () const =0
	Parent of this object.
virtual String	objectNamespaceURI () const =0
	Namespace of the object.
virtual String	objectLocalName () const =0
	Local name of the object.
virtual VersionInfo	objectVersion () const =0
	Service version number.
virtual ITraceMng *	traceMng () const =0
	Trace manager.
virtual IRessourceMng *	ressourceMng () const =0
	Resource manager.
virtual IServiceMng *	serviceMng () const =0
	Service manager.

Protected Member Functions
virtual	~ISubDomain ()
	Frees resources.

Detailed Description

Interface of the subdomain manager.

Definition at line 73 of file ISubDomain.h.

Constructor & Destructor Documentation

◆ ~ISubDomain()

virtual Arcane::ISubDomain::~ISubDomain ( )

inlineprotectedvirtual

Frees resources.

Definition at line 78 of file ISubDomain.h.

Member Function Documentation

◆ allReplicaParallelMng()

virtual IParallelMng * Arcane::ISubDomain::allReplicaParallelMng ( ) const

pure virtual

Returns the parallelism manager for all replicas.

Generally, parallelMng() must be used. This manager is essentially used to perform operations on all subdomains and their replicas. If there is no replication, this manager is the same as parallelMng().

Referenced by Arcane::ModuleMaster::timeLoopBegin().

◆ checkId()

virtual void Arcane::ISubDomain::checkId	(	const String &	where,
		const String &	id )

pure virtual

Checks if an identifier is valid.

Exceptions

ExceptionBadName if id is not a valid identifier.

References checkId().

Referenced by checkId(), and Arcane::ModuleFactory::createModule().

◆ defaultMesh()

virtual IMesh * Arcane::ISubDomain::defaultMesh ( )

pure virtual

Default mesh.

The default mesh does not exist until the dataset has been read. It is generally preferable to use defautMeshHandle() instead.

References defaultMesh().

Referenced by defaultMesh().

◆ defaultMeshHandle()

virtual const MeshHandle & Arcane::ISubDomain::defaultMeshHandle ( )

pure virtual

Handle for the default mesh.

This handle always exists even if the associated mesh has not yet been created.

References defaultMeshHandle().

Referenced by defaultMeshHandle().

◆ findMesh()

virtual IMesh * Arcane::ISubDomain::findMesh	(	const String &	name,
		bool	throw_exception = true )

pure virtual

Searches for the mesh named name.

If the mesh is not found, the method throws an exception if throw_exception is true or returns 0 if throw_exception is false.

References findMesh().

Referenced by findMesh().

◆ meshDimension()

virtual Integer ARCANE_DEPRECATED Arcane::ISubDomain::meshDimension ( ) const

pure virtual

Mesh dimension (1D, 2D, or 3D).

Deprecated: Use mesh()->dimension() instead.

References meshDimension().

Referenced by meshDimension().

◆ setCaseName()

virtual void Arcane::ISubDomain::setCaseName ( const String & name )

pure virtual

Sets the case name.

This method must be called before initialization.

References setCaseName().

Referenced by setCaseName().

◆ setDirectExecution()

virtual void Arcane::ISubDomain::setDirectExecution ( IDirectExecution * v )

pure virtual

Sets the direct execution service.

This service must be set during service creation when reading the dataset.

References setDirectExecution().

Referenced by setDirectExecution().

◆ setExportDirectory()

virtual void Arcane::ISubDomain::setExportDirectory ( const IDirectory & dir )

pure virtual

Sets the output path for exports (protections and restarts).

The directory corresponding to dir must exist.

This method must be called before initialization.

References setExportDirectory().

Referenced by setExportDirectory().

◆ setInitialPartitioner()

virtual void Arcane::ISubDomain::setInitialPartitioner ( IInitialPartitioner * partitioner )

pure virtual

Sets the initial partitioner.

If this method is not called, the default partitioner is used.

This method must be called before module initialization, for example in construction entry points.

The instance takes ownership of partitioner and will destroy it by delete at the end of the calculation.

References setInitialPartitioner().

Referenced by setInitialPartitioner().

◆ setListingDirectory()

virtual void Arcane::ISubDomain::setListingDirectory ( const IDirectory & dir )

pure virtual

Sets the output path for listing info.

The directory corresponding to dirname must exist.

This method must be called before initialization.

References setListingDirectory().

Referenced by setListingDirectory().

◆ setStorageDirectory()

virtual void Arcane::ISubDomain::setStorageDirectory ( const IDirectory & dir )

pure virtual

Sets the output path for exports requiring archiving.

This directory allows specifying a directory that can be automatically archived. If it is null, exportDirectory() is used.

This method must be called before initialization.

References setStorageDirectory().

Referenced by setStorageDirectory().

The documentation for this class was generated from the following file:

ISubDomain.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ISubDomain()

Member Function Documentation

◆ allReplicaParallelMng()

◆ checkId()

◆ defaultMesh()

◆ defaultMeshHandle()

◆ findMesh()

◆ meshDimension()

◆ setCaseName()

◆ setDirectExecution()

◆ setExportDirectory()

◆ setInitialPartitioner()

◆ setListingDirectory()

◆ setStorageDirectory()