#include <arcane/mesh/NonBlockingParticleExchanger.h>

Inheritance diagram for Arcane::mesh::NonBlockingParticleExchanger:

Collaboration diagram for Arcane::mesh::NonBlockingParticleExchanger:

Public Member Functions
	NonBlockingParticleExchanger (const ServiceBuildInfo &sbi)
void	build () override
	Build-level construction of the service.
void	initialize (IItemFamily *item_family) override
	Initializes the exchanger for the item_family item_family.
void	beginNewExchange (Integer nb_particule) override
	Starts a new particle exchange.
IItemFamily *	itemFamily () override
	Associated family.
bool	exchangeItems (Integer nb_particle_finish_exchange, Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send, ItemGroup item_group, IFunctor *functor) override
	Exchanges particles between sub-domains.
bool	exchangeItems (Integer nb_particle_finish_exchange, Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send, Int32Array new_particle_local_ids, IFunctor functor) override
	Exchanges particles between sub-domains.
void	sendItems (Integer nb_particle_finish_exchange, Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send) override
bool	waitMessages (Integer nb_pending_particle, Int32Array new_particle_local_ids, IFunctor functor) override
void	addNewParticles (Integer nb_particle) override
	Adds nb_particle to the current exchange.
void	setVerboseLevel (Integer level) override
	Sets the verbosity level (0 for no messages).
Integer	verboseLevel () const override
	Verbosity level.
IAsyncParticleExchanger *	asyncParticleExchanger () override
	Asynchronism management (returns nullptr if functionality is not available).
void	reset ()
Public Member Functions inherited from Arcane::BasicService
	~BasicService () override
	Releases resources.
virtual ISubDomain *	subDomain ()
Public Member Functions inherited from Arcane::AbstractService
	~AbstractService () override
	Destructor.
IServiceInfo *	serviceInfo () const override
	Access to service information. See IServiceInfo for details.
IBase *	serviceParent () const override
	Access to the base interface of main Arcane objects.
IService *	serviceInterface () override
	Returns the low-level IService interface of the service.
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::IService
virtual	~IService ()
	Releases resources.
Public Member Functions inherited from Arcane::MeshAccessor
	MeshAccessor (ISubDomain *sd)
	MeshAccessor (IMesh *mesh)
	MeshAccessor (const MeshHandle &mesh_handle)
Integer	nbCell () const
	Returns the number of cells in the mesh.
Integer	nbFace () const
	Returns the number of faces in the mesh.
Integer	nbEdge () const
	Returns the number of edges in the mesh.
Integer	nbNode () const
	Returns the number of nodes in the mesh.
VariableNodeReal3 &	nodesCoordinates () const
	Returns the coordinates of the mesh nodes.
NodeGroup	allNodes () const
	Returns the group containing all nodes.
EdgeGroup	allEdges () const
	Returns the group containing all edges.
FaceGroup	allFaces () const
	Returns the group containing all faces.
CellGroup	allCells () const
	Returns the group containing all cells.
FaceGroup	outerFaces () const
	Returns the group containing all boundary faces.
NodeGroup	ownNodes () const
	Returns the group containing all nodes specific to this domain.
CellGroup	ownCells () const
	Returns the group containing all cells specific to this domain.
FaceGroup	ownFaces () const
	Group containing all faces specific to this domain.
EdgeGroup	ownEdges () const
	Group containing all edges specific to this domain.
IMesh *	mesh () const
const MeshHandle &	meshHandle () const
Public Member Functions inherited from Arcane::CommonVariables
	CommonVariables (IModule *c)
	Constructs the references of the common variables for the module c.
	CommonVariables (IVariableMng *variable_mng)
	Constructs the references of the common variables for the manager variable_mng.
	CommonVariables (ISubDomain *sd)
	Constructs the references of the common variables for the subdomain sd.
virtual	~CommonVariables ()
	Releases resources.
Int32	globalIteration () const
	Current iteration number.
Real	globalTime () const
	Current time.
Real	globalOldTime () const
	Previous current time.
Real	globalFinalTime () const
	Final time of the simulation.
Real	globalDeltaT () const
	Current Delta T.
Real	globalCPUTime () const
	CPU time used (in seconds).
Real	globalOldCPUTime () const
	Previous CPU time used (in seconds).
Real	globalElapsedTime () const
	Clock time (elapsed) used (in seconds).
Real	globalOldElapsedTime () const
	Previous clock time (elapsed) used (in seconds).
Public Member Functions inherited from Arcane::IParticleExchanger
virtual	~IParticleExchanger ()=default
	Releases resources.

Private Member Functions
void	_clearMessages ()
void	_serializeMessage (ISerializeMessage *msg, Int32ConstArrayView acc_ids, Int64Array &items_to_send_uid, Int64Array &items_to_send_cells_uid)
void	_deserializeMessage (ISerializeMessage msg, Int64Array &items_to_create_id, Int64Array &items_to_create_cell_id, ItemGroup item_group, Int32Array new_particle_local_ids)
void	_processFinishTrackingMessage ()
void	_addFinishExchangeParticle (Int64 nb_particle_finish_exchange)
void	_sendFinishExchangeParticle ()
void	_addItemsToSend (Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send, Int32ConstArrayView communicating_sub_domains, UniqueArray< SharedArray< Int32 > > &ids_to_send)
void	_sendPendingMessages ()
void	_checkNeedReceiveMessage ()
bool	_exchangeItems (Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send, ItemGroup item_group, Int32Array new_particle_local_ids, IFunctor functor)
void	_checkSendItems (Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send)
void	_generateSendItemsMessages (Int32ConstArrayView local_ids, Int32ConstArrayView sub_domains_to_send)
void	_checkInitialized ()
void	_processMessages (ItemGroup item_group, Int32Array new_particle_local_ids, bool wait_all, IFunctor functor)
bool	_waitMessages (Integer nb_pending_particle, ItemGroup group, Int32Array new_particle_local_ids, IFunctor functor)

Private Attributes
IItemFamily *	m_item_family
IParallelMng *	m_parallel_mng
UniqueArray< SerializeMessage * >	m_accumulate_infos
Int32	m_rank
Timer *	m_timer
	Timer.
Real	m_total_time_functor
Real	m_total_time_waiting
VariableList	m_variables_to_exchange
	List of variables to exchange.
UniqueArray< ISerializeMessage * >	m_pending_messages
	List of messages pending sending.
UniqueArray< ISerializeMessage * >	m_waiting_messages
	List of messages sent but currently being processed.
Ref< ISerializeMessageList >	m_message_list
Int64	m_nb_total_particle_finish_exchange
Int64	m_nb_total_particle
Integer	m_nb_original_blocking_size
Integer	m_nb_blocking_size
	Number of remaining particles before switching to blocking mode.
bool	m_exchange_finished
Int32	m_master_proc
bool	m_need_general_receive
bool	m_end_message_sended
bool	m_can_process_messages
bool	m_can_process_non_blocking
bool	m_want_process_non_blocking
bool	m_want_fast_send_particles
Integer	m_nb_receive_message
Int64	m_nb_particle_finished_exchange
Int32UniqueArray	m_waiting_local_ids
Int32UniqueArray	m_waiting_sub_domains_to_send
Integer	m_verbose_level
bool	m_is_debug

Static Private Attributes
static const Integer	MESSAGE_EXCHANGE = 1
static const Integer	MESSAGE_NB_FINISH_EXCHANGE = 2
static const Integer	MESSAGE_FINISH_EXCHANGE_STATUS = 3
static const Integer	MESSAGE_CHANGE_BLOCKING = 4

Additional Inherited Members
Public Attributes inherited from Arcane::CommonVariables
VariableScalarInt32	m_global_iteration
	Current iteration.
VariableScalarReal	m_global_time
	Current time.
VariableScalarReal	m_global_deltat
	Global Delta T.
VariableScalarReal	m_global_old_time
	Time previous to the current time.
VariableScalarReal	m_global_old_deltat
	Delta T at the time previous to the global time.
VariableScalarReal	m_global_final_time
	Final time of the case.
VariableScalarReal	m_global_old_cpu_time
	Previous CPU time used (in seconds).
VariableScalarReal	m_global_cpu_time
	CPU time used (in seconds).
VariableScalarReal	m_global_old_elapsed_time
	Previous clock time used (in seconds).
VariableScalarReal	m_global_elapsed_time
	Clock time used (in seconds).
Protected Member Functions inherited from Arcane::BasicService
	BasicService (const ServiceBuildInfo &)
Protected Member Functions inherited from Arcane::AbstractService
	AbstractService (const ServiceBuildInfo &)
	Constructor from a ServiceBuildInfo.
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const
Protected Member Functions inherited from Arcane::IService
	IService ()
	Constructor.

Detailed Description

Particle Exchanger.

Definition at line 46 of file NonBlockingParticleExchanger.h.

Constructor & Destructor Documentation

◆ NonBlockingParticleExchanger()

Arcane::mesh::NonBlockingParticleExchanger::NonBlockingParticleExchanger ( const ServiceBuildInfo & sbi )

explicit

Definition at line 46 of file NonBlockingParticleExchanger.cc.

◆ ~NonBlockingParticleExchanger()

Arcane::mesh::NonBlockingParticleExchanger::~NonBlockingParticleExchanger ( )

override

Definition at line 82 of file NonBlockingParticleExchanger.cc.

Member Function Documentation

◆ _addFinishExchangeParticle()

void Arcane::mesh::NonBlockingParticleExchanger::_addFinishExchangeParticle ( Int64 nb_particle_finish_exchange )

private

Definition at line 777 of file NonBlockingParticleExchanger.cc.

◆ _addItemsToSend()

void Arcane::mesh::NonBlockingParticleExchanger::_addItemsToSend	(	Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send,
		Int32ConstArrayView	communicating_sub_domains,
		UniqueArray< SharedArray< Int32 > > &	ids_to_send )

private

Definition at line 370 of file NonBlockingParticleExchanger.cc.

◆ _checkInitialized()

void Arcane::mesh::NonBlockingParticleExchanger::_checkInitialized ( )

private

Definition at line 827 of file NonBlockingParticleExchanger.cc.

◆ _checkNeedReceiveMessage()

void Arcane::mesh::NonBlockingParticleExchanger::_checkNeedReceiveMessage ( )

private

Definition at line 289 of file NonBlockingParticleExchanger.cc.

◆ _checkSendItems()

void Arcane::mesh::NonBlockingParticleExchanger::_checkSendItems	(	Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send )

private

Definition at line 209 of file NonBlockingParticleExchanger.cc.

◆ _clearMessages()

void Arcane::mesh::NonBlockingParticleExchanger::_clearMessages ( )

private

Definition at line 111 of file NonBlockingParticleExchanger.cc.

◆ _deserializeMessage()

void Arcane::mesh::NonBlockingParticleExchanger::_deserializeMessage	(	ISerializeMessage *	msg,
		Int64Array &	items_to_create_id,
		Int64Array &	items_to_create_cell_id,
		ItemGroup	item_group,
		Int32Array *	new_particle_local_ids )

private

Definition at line 577 of file NonBlockingParticleExchanger.cc.

◆ _exchangeItems()

bool Arcane::mesh::NonBlockingParticleExchanger::_exchangeItems	(	Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send,
		ItemGroup	item_group,
		Int32Array *	new_particle_local_ids,
		IFunctor *	functor )

private

Definition at line 233 of file NonBlockingParticleExchanger.cc.

◆ _generateSendItemsMessages()

void Arcane::mesh::NonBlockingParticleExchanger::_generateSendItemsMessages	(	Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send )

private

Definition at line 302 of file NonBlockingParticleExchanger.cc.

◆ _processFinishTrackingMessage()

void Arcane::mesh::NonBlockingParticleExchanger::_processFinishTrackingMessage ( )

private

Definition at line 713 of file NonBlockingParticleExchanger.cc.

◆ _processMessages()

void Arcane::mesh::NonBlockingParticleExchanger::_processMessages	(	ItemGroup	item_group,
		Int32Array *	new_particle_local_ids,
		bool	wait_all,
		IFunctor *	functor )

private

Definition at line 410 of file NonBlockingParticleExchanger.cc.

◆ _sendFinishExchangeParticle()

void Arcane::mesh::NonBlockingParticleExchanger::_sendFinishExchangeParticle ( )

private

Definition at line 750 of file NonBlockingParticleExchanger.cc.

◆ _sendPendingMessages()

void Arcane::mesh::NonBlockingParticleExchanger::_sendPendingMessages ( )

private

Definition at line 472 of file NonBlockingParticleExchanger.cc.

◆ _serializeMessage()

void Arcane::mesh::NonBlockingParticleExchanger::_serializeMessage	(	ISerializeMessage *	msg,
		Int32ConstArrayView	acc_ids,
		Int64Array &	items_to_send_uid,
		Int64Array &	items_to_send_cells_uid )

private

Definition at line 500 of file NonBlockingParticleExchanger.cc.

◆ _waitMessages()

bool Arcane::mesh::NonBlockingParticleExchanger::_waitMessages	(	Integer	nb_pending_particle,
		ItemGroup	group,
		Int32Array *	new_particle_local_ids,
		IFunctor *	functor )

private

Definition at line 259 of file NonBlockingParticleExchanger.cc.

◆ addNewParticles()

void Arcane::mesh::NonBlockingParticleExchanger::addNewParticles ( Integer nb_particle )

inlineoverridevirtual

Adds nb_particle to the current exchange.

This method allows indicating that new particles will participate in the exchange, for example following their creation.

Implements Arcane::IParticleExchanger.

Definition at line 86 of file NonBlockingParticleExchanger.h.

◆ asyncParticleExchanger()

IAsyncParticleExchanger * Arcane::mesh::NonBlockingParticleExchanger::asyncParticleExchanger ( )

inlineoverridevirtual

Asynchronism management (returns nullptr if functionality is not available).

Implements Arcane::IParticleExchanger.

Definition at line 93 of file NonBlockingParticleExchanger.h.

◆ beginNewExchange()

void Arcane::mesh::NonBlockingParticleExchanger::beginNewExchange ( Integer nb_particle )

overridevirtual

Starts a new particle exchange.

nb_particle is the number of particles in the sub-domain that will take part in a potential exchange.

This method is collective and must be called by all sub-domains.

Implements Arcane::IParticleExchanger.

Definition at line 124 of file NonBlockingParticleExchanger.cc.

References Arcane::platform::getCurrentDateTime(), Arcane::TraceAccessor::info(), m_nb_blocking_size, m_variables_to_exchange, Arcane::IParallelMng::reduce(), and Arcane::MessagePassing::ReduceSum.

Here is the call graph for this function:

◆ build()

void Arcane::mesh::NonBlockingParticleExchanger::build ( void )

inlineoverridevirtual

Build-level construction of the service.

This method is called right after the constructor.

Reimplemented from Arcane::AbstractService.

Definition at line 64 of file NonBlockingParticleExchanger.h.

◆ exchangeItems() [1/2]

bool Arcane::mesh::NonBlockingParticleExchanger::exchangeItems	(	Integer	nb_particle_finish_exchange,
		Int32ConstArrayView	local_ids,
		Int32ConstArrayView	ranks_to_send,
		Int32Array *	new_particle_local_ids,
		IFunctor *	wait_functor )

overridevirtual

Exchanges particles between sub-domains.

This operation sends the particles from the item_family item_family whose local indices are given by the list local_ids to the sub-domains specified by sub_domains_to_send, and receives from these same sub-domains those that this sub-domain owns. The sent particles are deleted from the item_family item_family and the received ones are added.

Variables associated with the item_family item_family are transferred at the same time as the particles.

This operation is collective and blocking.

If new_particle_local_ids is not null, it will contain in return the array of local indices of the new entities.

If wait_functor is not null, the functor is called during the sending and receiving of messages. It is then possible to perform operations. Operations must not use particles, nor variables on the particles of the exchanged family.

Return values

a true if all exchange phases are finished

Return values

a false otherwise

Todo: improve the documentation

Implements Arcane::IParticleExchanger.

Definition at line 172 of file NonBlockingParticleExchanger.cc.

◆ exchangeItems() [2/2]

bool Arcane::mesh::NonBlockingParticleExchanger::exchangeItems	(	Integer	nb_particle_finish_exchange,
		Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send,
		ItemGroup	item_group,
		IFunctor *	wait_functor )

overridevirtual

Exchanges particles between sub-domains.

This operation sends the particles from the item_family item_family whose local indices are given by the list local_ids to the sub-domains specified by sub_domains_to_send, and receives from these same sub-domains those that this sub-domain owns. The sent particles are deleted from the item_family item_family and the received ones are added.

Variables associated with the item_family item_family are transferred at the same time as the particles.

This operation is collective and blocking.

If item_group is not null, it will contain the list of new entities in return.

If wait_functor is not null, the functor is called during the sending and receiving of messages. It is then possible to perform operations. Operations must not use particles, nor variables on the particles of the exchanged family.

Return values

a true if all exchange phases are finished

Return values

a false otherwise

Todo: improve the documentation

Implements Arcane::IParticleExchanger.

Definition at line 158 of file NonBlockingParticleExchanger.cc.

◆ initialize()

void Arcane::mesh::NonBlockingParticleExchanger::initialize ( IItemFamily * item_family )

overridevirtual

Initializes the exchanger for the item_family item_family.

Implements Arcane::IParticleExchanger.

Definition at line 102 of file NonBlockingParticleExchanger.cc.

◆ itemFamily()

IItemFamily * Arcane::mesh::NonBlockingParticleExchanger::itemFamily ( )

inlineoverridevirtual

Associated family.

Implements Arcane::IParticleExchanger.

Definition at line 70 of file NonBlockingParticleExchanger.h.

◆ reset()

void Arcane::mesh::NonBlockingParticleExchanger::reset ( )

Definition at line 702 of file NonBlockingParticleExchanger.cc.

◆ sendItems()

void Arcane::mesh::NonBlockingParticleExchanger::sendItems	(	Integer	nb_particle_finish_exchange,
		Int32ConstArrayView	local_ids,
		Int32ConstArrayView	sub_domains_to_send )