Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IMeshCompactMng Class Referenceabstract

Interface for managing the compaction of mesh families. More...

#include <arcane/core/IMeshCompactMng.h>

Inheritance diagram for Arcane::IMeshCompactMng:
Collaboration diagram for Arcane::IMeshCompactMng:

Public Member Functions

virtual IMeshmesh () const =0
 Associated mesh.
virtual IMeshCompacterbeginCompact ()=0
 Starts a compaction on all families of the mesh.
virtual IMeshCompacterbeginCompact (IItemFamily *family)=0
 Starts a compaction for the entity family family.
virtual void endCompact ()=0
 Signals that the compaction is finished.
virtual IMeshCompactercompacter ()=0
 Current active compacter.

Detailed Description

Interface for managing the compaction of mesh families.

While a compaction is in progress, it is forbidden to perform certain operations on the mesh, such as creating a new family or adding groups.

The start of a compaction is done by calling beginCompact(). Once the compaction is finished, you must call endCompact() to destroy the IMeshCompacter instance.

For more information on compaction, refer to the documentation of IMeshCompacter.

Definition at line 47 of file IMeshCompactMng.h.

Constructor & Destructor Documentation

◆ ~IMeshCompactMng()

virtual Arcane::IMeshCompactMng::~IMeshCompactMng ( )
inlinevirtual

Definition at line 51 of file IMeshCompactMng.h.

Member Function Documentation

◆ beginCompact() [1/2]

virtual IMeshCompacter * Arcane::IMeshCompactMng::beginCompact ( )
pure virtual

Starts a compaction on all families of the mesh.

Precondition
compacter()==nullptr.

Implemented in Arcane::mesh::MeshCompactMng.

Referenced by Arcane::mesh::ItemFamily::_compactItems().

Here is the caller graph for this function:

◆ beginCompact() [2/2]

virtual IMeshCompacter * Arcane::IMeshCompactMng::beginCompact ( IItemFamily * family)
pure virtual

Starts a compaction for the entity family family.

Precondition
compacter()==nullptr.

Implemented in Arcane::mesh::MeshCompactMng.

◆ compacter()

virtual IMeshCompacter * Arcane::IMeshCompactMng::compacter ( )
pure virtual

Current active compacter.

The compacter is non-null only if we are between a beginCompact() and an endCompact()

Implemented in Arcane::mesh::MeshCompactMng.

◆ endCompact()

virtual void Arcane::IMeshCompactMng::endCompact ( )
pure virtual

Signals that the compaction is finished.

This allows the deallocation of structures associated with the compaction.

Postcondition
exchanger()==nullptr.

Implemented in Arcane::mesh::MeshCompactMng.

Referenced by Arcane::mesh::ItemFamily::_compactItems().

Here is the caller graph for this function:

◆ mesh()

virtual IMesh * Arcane::IMeshCompactMng::mesh ( ) const
pure virtual

Associated mesh.

Implemented in Arcane::mesh::MeshCompactMng.


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