Interface of the service managing the reading of a mesh. More...

#include <arcane/core/IMeshReader.h>

Inheritance diagram for Arcane::IMeshReader:

Collaboration diagram for Arcane::IMeshReader:

Public Types
enum	eReturnType { RTOk , RTError , RTIrrelevant }
	Types of return codes for a read or write operation. More...

Public Member Functions
virtual	~IMeshReader ()=default
	Frees resources.
virtual bool	allowExtension (const String &str)=0
	Checks if the service supports files with the extension str.
virtual eReturnType	readMeshFromFile (IPrimaryMesh *mesh, const XmlNode &mesh_element, const String &file_name, const String &dir_name, bool use_internal_partition)=0
	Reads a mesh from a file.

Detailed Description

Interface of the service managing the reading of a mesh.

Definition at line 32 of file IMeshReader.h.

Member Enumeration Documentation

◆ eReturnType

enum Arcane::IMeshReader::eReturnType

Types of return codes for a read or write operation.

Enumerator
RTOk	Operation successfully performed.
RTError	Error during the operation.
RTIrrelevant	Not relevant to the operation. This means that the file format does not match this reader or that the service does not support this operation.

Definition at line 37 of file IMeshReader.h.

Member Function Documentation

◆ allowExtension()

virtual bool Arcane::IMeshReader::allowExtension ( const String & str )

pure virtual

Checks if the service supports files with the extension str.

Implemented in Arcane::LimaMeshReaderService, Arcane::MEDMeshReaderService, Arcane::MeshGeneratorService, Arcane::MshMeshReaderService, Arcane::VoronoiMeshIOService, Arcane::VtkMeshReader, Arcane::VtuMeshReader, and Arcane::XmfMeshReader.

Referenced by Arcane::LegacyMeshBuilder::_readMesh(), and Arcane::MeshReaderMng::readMesh().

Here is the caller graph for this function:

◆ readMeshFromFile()

virtual eReturnType Arcane::IMeshReader::readMeshFromFile	(	IPrimaryMesh *	mesh,
		const XmlNode &	mesh_element,
		const String &	file_name,
		const String &	dir_name,
		bool	use_internal_partition )

pure virtual

Reads a mesh from a file.

Reads the geometry of a mesh from the file file_name as well as the corresponding partitioning information and constructs the corresponding mesh in mesh.

If use_internal_partition is true, it means that the partitioning has not yet been done and will be done by Arcane. In this case, only one processor can read the mesh. However, the others must still create all possible groups. This argument is only useful in parallel.

If dir_name is not null, this path serves as the base for reading meshes and partitioning information.