Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::Materials::IMeshBlock Class Referenceabstract

Interface of a mesh block. More...

#include <arcane/core/materials/IMeshBlock.h>

Public Member Functions

virtual IMeshMaterialMngmaterialMng ()=0
 Associated manager.
virtual const Stringname () const =0
 Block name.
virtual const CellGroupcells () const =0
 Cell group of this block.
virtual ConstArrayView< IMeshEnvironment * > environments ()=0
 List of environments in this block.
virtual Integer nbEnvironment () const =0
 Number of environments in the block.
virtual Int32 id () const =0
 Block identifier. It is also the index (starting from 0) of this block in the list of blocks.
virtual AllEnvCellVectorView view ()=0
 View of the environments cells corresponding to this block.

Detailed Description

Interface of a mesh block.

Blocks are created via IMeshMaterialMng::createBlock().

Blocks cannot be destroyed and must be created during initialization.

The concept of a block is optional and it is not necessary to have blocks to use environments and materials.

A block is characterized by a name (name()), a cell group (cells()), and a list of environments (environments()).

Note that theoretically the cell group (cells()) is independent of the list of environments, but for reasons of consistency, it is preferable that this group corresponds to the union of the block's environments. However, no verification of this consistency is performed.

It is possible to use an instance of this class as an argument to ENUMERATE_ENV or to ENUMERATE_ALLENVCELL.

Definition at line 52 of file core/materials/IMeshBlock.h.

Constructor & Destructor Documentation

◆ ~IMeshBlock()

virtual Arcane::Materials::IMeshBlock::~IMeshBlock ( )
inlinevirtual

Definition at line 56 of file core/materials/IMeshBlock.h.

Member Function Documentation

◆ cells()

virtual const CellGroup & Arcane::Materials::IMeshBlock::cells ( ) const
pure virtual

Cell group of this block.

Implemented in Arcane::Materials::MeshBlock.

◆ environments()

virtual ConstArrayView< IMeshEnvironment * > Arcane::Materials::IMeshBlock::environments ( )
pure virtual

List of environments in this block.

Implemented in Arcane::Materials::MeshBlock.

◆ id()

virtual Int32 Arcane::Materials::IMeshBlock::id ( ) const
pure virtual

Block identifier. It is also the index (starting from 0) of this block in the list of blocks.

Implemented in Arcane::Materials::MeshBlock.

◆ materialMng()

virtual IMeshMaterialMng * Arcane::Materials::IMeshBlock::materialMng ( )
pure virtual

Associated manager.

Implemented in Arcane::Materials::MeshBlock.

◆ name()

virtual const String & Arcane::Materials::IMeshBlock::name ( ) const
pure virtual

Block name.

Implemented in Arcane::Materials::MeshBlock.

◆ nbEnvironment()

virtual Integer Arcane::Materials::IMeshBlock::nbEnvironment ( ) const
pure virtual

Number of environments in the block.

Implemented in Arcane::Materials::MeshBlock.

◆ view()

virtual AllEnvCellVectorView Arcane::Materials::IMeshBlock::view ( )
pure virtual

View of the environments cells corresponding to this block.

Implemented in Arcane::Materials::MeshBlock.


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