Arcane::MeshBuildInfo Class Reference

Parameters necessary for building a mesh. More...

#include <arcane/core/MeshBuildInfo.h>

Public Member Functions
	MeshBuildInfo (const String &name)
	Constructs a default mesh with the name name.
MeshBuildInfo &	addFactoryName (const String &factory_name)
	Sets the factory name to create this mesh.
MeshBuildInfo &	addParallelMng (Ref< IParallelMng > pm)
	Sets the parallelism manager to create the mesh.
MeshBuildInfo &	addParentGroup (const ItemGroup &parent_group)
	Sets the cell group for a sub-mesh.
MeshBuildInfo &	addNeedPartitioning (bool v)
	Indicates whether the generator needs to call a partitioner.
MeshBuildInfo &	addMeshKind (const MeshKind &v)
	Sets the mesh characteristics.
const String &	name () const
	Name of the new mesh.
const String &	factoryName () const
	Factory name to create the mesh (via IMeshFactory).
Ref< IParallelMng >	parallelMngRef () const
	Parallelism manager in the case of a new mesh.
const ItemGroup &	parentGroup () const
	Parent group in the case of a sub-mesh, null otherwise.
bool	isNeedPartitioning () const
	Indicates if the reader/generator requires partitioning.
const MeshKind	meshKind () const
	Mesh characteristics.

Detailed Description

Parameters necessary for building a mesh.

Only the name (name()) is essential. The other parameters are optional depending on the desired creation type. If they are not defined and useful, a default value will be used.

There are two possibilities for creation:

• creation of a new mesh. In this case, it is necessary to specify the associated IParallelMng via addParallelMng().
• creation of a sub-mesh of an existing mesh. In this case, it is necessary to position the group via addItemGroup(). The associated IParallelMng must be that of the parent mesh. The created sub-mesh will include the cells of this group.

Definition at line 48 of file MeshBuildInfo.h.

Constructor & Destructor Documentation

MeshBuildInfo()

Arcane::MeshBuildInfo::MeshBuildInfo ( const String & name )

explicit

Constructs a default mesh with the name name.

Definition at line 25 of file MeshBuildInfo.cc.

References name().

Referenced by addFactoryName(), addMeshKind(), addNeedPartitioning(), addParallelMng(), and addParentGroup().

Member Function Documentation

addFactoryName()

MeshBuildInfo & Arcane::MeshBuildInfo::addFactoryName

(

const String &

factory_name

)

Sets the factory name to create this mesh.

Definition at line 36 of file MeshBuildInfo.cc.

References MeshBuildInfo().

addMeshKind()

MeshBuildInfo & Arcane::MeshBuildInfo::addMeshKind

(

const MeshKind &

v

)

Sets the mesh characteristics.

Definition at line 76 of file MeshBuildInfo.cc.

References MeshBuildInfo().

addNeedPartitioning()

MeshBuildInfo & Arcane::MeshBuildInfo::addNeedPartitioning

(

bool

v

)

Indicates whether the generator needs to call a partitioner.

This is the case, for example, if the reader can only generate sequential meshes.

Definition at line 66 of file MeshBuildInfo.cc.

References MeshBuildInfo().

addParallelMng()

MeshBuildInfo & Arcane::MeshBuildInfo::addParallelMng

(

Ref< IParallelMng >

pm

)

Sets the parallelism manager to create the mesh.

Definition at line 46 of file MeshBuildInfo.cc.

References MeshBuildInfo().

addParentGroup()

MeshBuildInfo & Arcane::MeshBuildInfo::addParentGroup

(

const ItemGroup &

parent_group

)

Sets the cell group for a sub-mesh.

Definition at line 56 of file MeshBuildInfo.cc.

References MeshBuildInfo().

factoryName()

const String & Arcane::MeshBuildInfo::factoryName ( ) const

inline

Factory name to create the mesh (via IMeshFactory).

Definition at line 78 of file MeshBuildInfo.h.

isNeedPartitioning()

bool Arcane::MeshBuildInfo::isNeedPartitioning ( ) const

inline

Indicates if the reader/generator requires partitioning.

Definition at line 84 of file MeshBuildInfo.h.

meshKind()

const MeshKind Arcane::MeshBuildInfo::meshKind ( ) const

inline

Mesh characteristics.

Definition at line 86 of file MeshBuildInfo.h.

name()

const String & Arcane::MeshBuildInfo::name ( ) const

inline

Name of the new mesh.

Definition at line 76 of file MeshBuildInfo.h.

Referenced by MeshBuildInfo().

parallelMngRef()

Ref< IParallelMng > Arcane::MeshBuildInfo::parallelMngRef ( ) const

inline

Parallelism manager in the case of a new mesh.

Definition at line 80 of file MeshBuildInfo.h.

parentGroup()

const ItemGroup & Arcane::MeshBuildInfo::parentGroup ( ) const

inline

Parent group in the case of a sub-mesh, null otherwise.

Definition at line 82 of file MeshBuildInfo.h.

---

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

• MeshBuildInfo.h
• MeshBuildInfo.cc