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

Interface of a mesh environment. More...

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

Public Member Functions

virtual ConstArrayView< IMeshMaterial * > materials ()=0
 List of materials in this environment.
virtual Integer nbMaterial () const =0
 Number of materials in the environment.
virtual IUserMeshEnvironmentuserEnvironment () const =0
 Environment identifier. It is also the index (starting from 0) of this environment in the list of environments.
virtual void setUserEnvironment (IUserMeshEnvironment *umm)=0
 Sets the associated user environment.
virtual EnvCell findEnvCell (AllEnvCell c) const =0
 Cell of this environment for cell c.
virtual EnvItemVectorView envView () const =0
 View associated with this environment.
virtual EnvPurePartItemVectorView pureEnvItems () const =0
 View of the list of pure entities (associated with the global cell) in the environment.
virtual EnvImpurePartItemVectorView impureEnvItems () const =0
 View of the list of impure (partial) entities in the environment.
virtual EnvPartItemVectorView partEnvItems (eMatPart part) const =0
 View of the pure or impure part of the environment entities.
Public Member Functions inherited from Arcane::Materials::IMeshComponent
virtual IMeshMaterialMngmaterialMng ()=0
 Associated manager.
virtual ITraceMngtraceMng ()=0
 Associated trace manager.
virtual String name () const =0
 Component name.
virtual CellGroup cells () const =0
 Group of cells for this material.
virtual Int32 id () const =0
 Component identifier.
virtual ComponentCell findComponentCell (AllEnvCell c) const =0
 Cell of this component for cell c.
virtual ComponentItemVectorView view () const =0
 View associated with this component.
virtual void checkValid ()=0
 Checks that the component is valid.
virtual bool isMaterial () const =0
 True if the component is a material.
virtual bool isEnvironment () const =0
 True if the component is an environment.
virtual bool hasSpace (MatVarSpace space) const =0
 Indicates if the component is defined for space space.
virtual ComponentPurePartItemVectorView pureItems () const =0
 View on the list of pure entities (associated with the global cell) of the component.
virtual ComponentImpurePartItemVectorView impureItems () const =0
 View on the list of impure (partial) entities of the component.
virtual ComponentPartItemVectorView partItems (eMatPart part) const =0
 View on the pure or impure part of the component's entities.
virtual IMeshMaterialasMaterial ()=0
 Returns the component in the form of an IMeshMaterial.
virtual IMeshEnvironmentasEnvironment ()=0
 Returns the component in the form of an IMeshMaterial.
virtual void setSpecificExecutionPolicy (Accelerator::eExecutionPolicy policy)=0
 Sets an execution policy for this constituent.
virtual Accelerator::eExecutionPolicy specificExecutionPolicy () const =0
 Specific execution policy.
virtual IMeshComponentInternal * _internalApi ()=0
 Internal API.

Detailed Description

Interface of a mesh environment.

Environments are created via IMeshEnvironmentMng::createEnvironment().

Environments cannot be destroyed, and all environments and their materials must be created during initialization.

An environment may optionally be empty.

Definition at line 53 of file core/materials/IMeshEnvironment.h.

Constructor & Destructor Documentation

◆ ~IMeshEnvironment()

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

Definition at line 58 of file core/materials/IMeshEnvironment.h.

Member Function Documentation

◆ findEnvCell()

virtual EnvCell Arcane::Materials::IMeshEnvironment::findEnvCell ( AllEnvCell c) const
pure virtual

Cell of this environment for cell c.

If this environment is not present in the cell, a null environment cell is returned.

The cost of this function is proportional to the number of materials present in the cell.

◆ userEnvironment()

virtual IUserMeshEnvironment * Arcane::Materials::IMeshEnvironment::userEnvironment ( ) const
pure virtual

Environment identifier. It is also the index (starting from 0) of this environment in the list of environments.

Associated user environment


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