Arcane::Materials::IMeshComponent Class Reference

Interface of a component (material or environment) of a mesh. More...

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

Public Member Functions
virtual IMeshMaterialMng *	materialMng ()=0
	Associated manager.
virtual ITraceMng *	traceMng ()=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 IMeshMaterial *	asMaterial ()=0
	Returns the component in the form of an IMeshMaterial.
virtual IMeshEnvironment *	asEnvironment ()=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 component (material or environment) of a mesh.

Definition at line 36 of file core/materials/IMeshComponent.h.

Member Function Documentation

asEnvironment()

virtual IMeshEnvironment * Arcane::Materials::IMeshComponent::asEnvironment ( )

pure virtual

Returns the component in the form of an IMeshMaterial.

If isEnvironment()==false, returns nullptr

asMaterial()

virtual IMeshMaterial * Arcane::Materials::IMeshComponent::asMaterial ( )

pure virtual

Returns the component in the form of an IMeshMaterial.

If isMaterial()==false, returns nullptr

cells()

virtual CellGroup Arcane::Materials::IMeshComponent::cells ( ) const

pure virtual

Group of cells for this material.

Warning

This group must not be modified. To change the number of elements of a material, you must go through the materialMng().

Referenced by Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::fillToArray(), and Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::fillToArray().

findComponentCell()

virtual ComponentCell Arcane::Materials::IMeshComponent::findComponentCell ( AllEnvCell c ) const

pure virtual

Cell of this component for cell c.

If the component is not present in the cell, the null cell is returned.

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

id()

virtual Int32 Arcane::Materials::IMeshComponent::id ( ) const

pure virtual

Component identifier.

It is also the index (starting from 0) of this component in the list of components of this type. There is a specific list for materials and environments and therefore a component representing a material can have the same ID as a component representing an environment.

Referenced by Arcane::Materials::MeshMaterialVariable::modifiedTime(), Arcane::Materials::MeshMaterialVariable::setUpToDate(), and Arcane::Materials::MeshMaterialVariable::update().

setSpecificExecutionPolicy()

virtual void Arcane::Materials::IMeshComponent::setSpecificExecutionPolicy ( Accelerator::eExecutionPolicy policy )

pure virtual

Sets an execution policy for this constituent.

Warning

This method is experimental. Do not use outside of Arcane.

The selected execution policy will be used for creation or modification operations of EnvCellVector, MatCellVector or ComponentItemVector.

If policy equals Accelerator::eExecutionPolicy::None (the default), the policy of the associated IMeshMaterialMng is used. If it equals Accelerator::eExecutionPolicy::Sequential or Accelerator::eExecutionPolicy::Thread, then execution will take place on the host sequentially or multi-threaded. Other values are invalid.

Note

The change in execution policy applies to any subsequent modification, even for already created instances of ComponentItemVector.

specificExecutionPolicy()

virtual Accelerator::eExecutionPolicy Arcane::Materials::IMeshComponent::specificExecutionPolicy ( ) const

pure virtual

Specific execution policy.

See also

setSpecificExecutionPolicy().

---

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

• core/materials/IMeshComponent.h