#include <SendBuffer.h>

Inheritance diagram for SendBuffer< Object, Context >:

Public Member Functions
	SendBuffer (const libMesh::Parallel::Communicator &comm, const Context *const context, const processor_id_type pid, const ParallelStudyMethod &method, const unsigned int min_buffer_size, const unsigned int max_buffer_size, const Real buffer_growth_multiplier, const Real buffer_shrink_multiplier, const Parallel::MessageTag object_buffer_tag)

	~SendBuffer () override
	Destructor: ensures that all send requests have completed. More...

unsigned long int	objectsSent () const
	Get the number of objects sent from this buffer. More...

unsigned long int	buffersSent () const
	Get the number of buffers sent from this buffer. More...

unsigned long int	bufferPoolCreated () const
	Get the number of buffers created in the buffer pool. More...

bool	currentlySending () const
	Whether or not messages are currently being sent. More...

bool	currentlyBuffered () const
	Whether or not objects are currently waiting to be sent. More...

void	moveObject (std::shared_ptr< Object > &object)
	Move an object to the buffer. More...

void	forceSend (const bool shrink_current_buffer_size=true)
	Forces a Send for all currently buffered objects. More...

void	waitAll ()
	Wait for all requests to finish. More...

void	clear ()
	Clear all existing data. More...

void	cleanupRequests ()
	Checks to see if any Requests can be finished. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Protected Attributes
const Parallel::Communicator &	_communicator

Private Attributes
const Context *const	_context
	The context. More...

const processor_id_type	_pid
	The processor ID this buffer will send to. More...

const ParallelStudyMethod &	_method

const unsigned int	_min_buffer_size
	Minimum size of the buffer (in objects) More...

const unsigned int	_max_buffer_size
	Maximum size of the buffer (in objects) More...

const Real	_buffer_growth_multiplier
	Multiplier for the buffer size for growing the buffer. More...

const Real	_buffer_shrink_multiplier
	Multiplier for the buffer size for shrinking the buffer. More...

const Parallel::MessageTag	_object_buffer_tag
	MessageTag for sending objects. More...

unsigned int	_current_buffer_size
	Current size of the buffer (in objects) More...

Real	_current_buffer_size_real
	Running buffer size. More...

std::vector< std::shared_ptr< Object > >	_buffer
	The buffer. More...

std::size_t	_buffer_size_bytes
	The size of the objects in the buffer in bytes. More...

std::list< std::shared_ptr< Parallel::Request > >	_requests
	List of Requests. More...

MooseUtils::SharedPool< std::vector< typename Parallel::Packing< std::shared_ptr< Object > >::buffer_type > >	_buffer_pool
	Shared pool of buffers. More...

unsigned long int	_objects_sent
	Counter for objects sent. More...

unsigned long int	_buffers_sent
	Counter for buffers sent. More...

Detailed Description

template<typename Object, typename Context>
class SendBuffer< Object, Context >

Definition at line 26 of file SendBuffer.h.

Constructor & Destructor Documentation

◆ SendBuffer()

template<typename Object , typename Context >

SendBuffer< Object, Context >::SendBuffer	(	const libMesh::Parallel::Communicator &	comm,
		const Context *const	context,
		const processor_id_type	pid,
		const ParallelStudyMethod &	method,
		const unsigned int	min_buffer_size,
		const unsigned int	max_buffer_size,
		const Real	buffer_growth_multiplier,
		const Real	buffer_shrink_multiplier,
		const Parallel::MessageTag	object_buffer_tag
	)

Definition at line 139 of file SendBuffer.h.

   : ParallelObject(comm),
     _context(context),
     _pid(pid),
     _method(method),
     _min_buffer_size(min_buffer_size),
     _max_buffer_size(max_buffer_size),
     _buffer_growth_multiplier(buffer_growth_multiplier),
     _buffer_shrink_multiplier(buffer_shrink_multiplier),
     _object_buffer_tag(object_buffer_tag),
     _current_buffer_size(_min_buffer_size),
     _current_buffer_size_real(_min_buffer_size),
     _buffer_size_bytes(0),
     _objects_sent(0),
     _buffers_sent(0)
 {
   _buffer.reserve(max_buffer_size);
 }

◆ ~SendBuffer()

template<typename Object , typename Context >

SendBuffer< Object, Context >::~SendBuffer ( )

override

Destructor: ensures that all send requests have completed.

Definition at line 167 of file SendBuffer.h.

 {
   waitAll();
   cleanupRequests();
 }

Member Function Documentation

◆ bufferPoolCreated()

template<typename Object , typename Context >

unsigned long int SendBuffer< Object, Context >::bufferPoolCreated ( ) const

inline

Get the number of buffers created in the buffer pool.

Definition at line 55 of file SendBuffer.h.

55 { return _buffer_pool.num_created(); }

MooseUtils::SharedPool::num_created

size_t num_created() const

SendBuffer::_buffer_pool

MooseUtils::SharedPool< std::vector< typename Parallel::Packing< std::shared_ptr< Object > >::buffer_type > > _buffer_pool

Shared pool of buffers.

Definition: SendBuffer.h:130

◆ buffersSent()

template<typename Object , typename Context >

unsigned long int SendBuffer< Object, Context >::buffersSent ( ) const

inline

Get the number of buffers sent from this buffer.

Definition at line 51 of file SendBuffer.h.

51 { return _buffers_sent; }

SendBuffer::_buffers_sent

unsigned long int _buffers_sent

Counter for buffers sent.

Definition: SendBuffer.h:135

◆ cleanupRequests()

template<typename Object , typename Context >

void SendBuffer< Object, Context >::cleanupRequests ( )

Checks to see if any Requests can be finished.

Definition at line 246 of file SendBuffer.h.

 {
   _requests.remove_if(
       [](std::shared_ptr<Parallel::Request> & req)
       {
         if (req->test())
         {
           req->wait(); // MUST call wait() to do post_wait_work
           return true;
         }
         else
           return false;
       });
 }

◆ clear()

template<typename Object , typename Context >

void SendBuffer< Object, Context >::clear ( )

Clear all existing data.

Definition at line 235 of file SendBuffer.h.

 {
   _buffer.clear();
   _requests.clear();
 
   _objects_sent = 0;
   _buffers_sent = 0;
 }

◆ currentlyBuffered()

template<typename Object , typename Context >

bool SendBuffer< Object, Context >::currentlyBuffered ( ) const

inline

Whether or not objects are currently waiting to be sent.

Definition at line 64 of file SendBuffer.h.

64 { return _buffer.size(); }

SendBuffer::_buffer

std::vector< std::shared_ptr< Object > > _buffer

The buffer.

Definition: SendBuffer.h:120

◆ currentlySending()

template<typename Object , typename Context >

bool SendBuffer< Object, Context >::currentlySending ( ) const

inline

Whether or not messages are currently being sent.

Definition at line 60 of file SendBuffer.h.

60 { return _requests.size(); }

SendBuffer::_requests

std::list< std::shared_ptr< Parallel::Request > > _requests

List of Requests.

Definition: SendBuffer.h:125

◆ forceSend()

template<typename Object , typename Context >

void SendBuffer< Object, Context >::forceSend ( const bool shrink_current_buffer_size = true )

Forces a Send for all currently buffered objects.

Definition at line 199 of file SendBuffer.h.

 {
   if (!_buffer.empty())
   {
     auto req = std::make_shared<Parallel::Request>();
 
     _requests.push_back(req);
 
     _buffer_size_bytes = 0;
     _objects_sent += _buffer.size();
     _buffers_sent++;
 
     std::shared_ptr<std::vector<typename Parallel::Packing<std::shared_ptr<Object>>::buffer_type>>
         buffer = _buffer_pool.acquire();
 
     comm().nonblocking_send_packed_range(
         _pid, _context, _buffer.begin(), _buffer.end(), *req, buffer, _object_buffer_tag);
 
     _buffer.clear();
     _buffer.reserve(_max_buffer_size);
 
     if (_method == ParallelStudyMethod::SMART && shrink_current_buffer_size)
     {
       _current_buffer_size_real =
           std::max((Real)_min_buffer_size, _current_buffer_size_real * _buffer_shrink_multiplier);
 
       if (_current_buffer_size != (unsigned int)_current_buffer_size_real)
         _current_buffer_size = _current_buffer_size_real;
     }
   }
 
   cleanupRequests();
 }

◆ moveObject()

template<typename Object , typename Context >

void SendBuffer< Object, Context >::moveObject ( std::shared_ptr< Object > & object )

Move an object to the buffer.

May cause the buffer to be communicated.

This DOES call std::move on the object

Definition at line 175 of file SendBuffer.h.

 {
   _buffer_size_bytes +=
       Parallel::Packing<std::shared_ptr<Object>>::packable_size(object, _context) *
       sizeof(typename Parallel::Packing<std::shared_ptr<Object>>::buffer_type);
   _buffer.emplace_back(std::move(object));
 
   // Force a send with SMART if we find it appropriate
   if ((_method == ParallelStudyMethod::SMART &&
        (_buffer.size() >= _current_buffer_size || _buffer.size() == _max_buffer_size)) ||
       (_buffer_size_bytes > 1048576)) // 1 MB
   {
     _current_buffer_size_real =
         std::min(_buffer_growth_multiplier * _current_buffer_size_real, (Real)_max_buffer_size);
 
     if (_current_buffer_size != (unsigned int)_current_buffer_size_real)
       _current_buffer_size = _current_buffer_size_real;
 
     forceSend(false);
   }
 }

◆ objectsSent()

template<typename Object , typename Context >

unsigned long int SendBuffer< Object, Context >::objectsSent ( ) const

inline

Get the number of objects sent from this buffer.

Definition at line 47 of file SendBuffer.h.

47 { return _objects_sent; }

SendBuffer::_objects_sent

unsigned long int _objects_sent

Counter for objects sent.

Definition: SendBuffer.h:133

◆ waitAll()

template<typename Object , typename Context >

void SendBuffer< Object, Context >::waitAll ( )

Wait for all requests to finish.

Definition at line 263 of file SendBuffer.h.

 {
   std::for_each(_requests.begin(), _requests.end(), [](auto & request) { request->wait(); });
 }

Member Data Documentation

◆ _buffer

template<typename Object , typename Context >

std::vector<std::shared_ptr<Object> > SendBuffer< Object, Context >::_buffer

private

The buffer.

Definition at line 120 of file SendBuffer.h.

Referenced by SendBuffer< Object, Context >::currentlyBuffered(), and SendBuffer< Object, Context >::SendBuffer().

◆ _buffer_growth_multiplier

template<typename Object , typename Context >

const Real SendBuffer< Object, Context >::_buffer_growth_multiplier

private

Multiplier for the buffer size for growing the buffer.

Definition at line 107 of file SendBuffer.h.

◆ _buffer_pool

template<typename Object , typename Context >

MooseUtils::SharedPool< std::vector<typename Parallel::Packing<std::shared_ptr<Object> >::buffer_type> > SendBuffer< Object, Context >::_buffer_pool

private

Shared pool of buffers.

Definition at line 130 of file SendBuffer.h.

Referenced by SendBuffer< Object, Context >::bufferPoolCreated().

◆ _buffer_shrink_multiplier

template<typename Object , typename Context >

const Real SendBuffer< Object, Context >::_buffer_shrink_multiplier

private

Multiplier for the buffer size for shrinking the buffer.

Definition at line 109 of file SendBuffer.h.

◆ _buffer_size_bytes

template<typename Object , typename Context >

std::size_t SendBuffer< Object, Context >::_buffer_size_bytes

private

The size of the objects in the buffer in bytes.

Definition at line 122 of file SendBuffer.h.

◆ _buffers_sent

template<typename Object , typename Context >

unsigned long int SendBuffer< Object, Context >::_buffers_sent

private

Counter for buffers sent.

Definition at line 135 of file SendBuffer.h.

Referenced by SendBuffer< Object, Context >::buffersSent().

◆ _context

template<typename Object , typename Context >

const Context* const SendBuffer< Object, Context >::_context

private

The context.

Definition at line 95 of file SendBuffer.h.

◆ _current_buffer_size

template<typename Object , typename Context >

unsigned int SendBuffer< Object, Context >::_current_buffer_size

private

Current size of the buffer (in objects)

Definition at line 115 of file SendBuffer.h.

◆ _current_buffer_size_real

template<typename Object , typename Context >

Real SendBuffer< Object, Context >::_current_buffer_size_real

private

Running buffer size.

Definition at line 117 of file SendBuffer.h.

◆ _max_buffer_size

template<typename Object , typename Context >

const unsigned int SendBuffer< Object, Context >::_max_buffer_size

private

Maximum size of the buffer (in objects)

Definition at line 104 of file SendBuffer.h.

◆ _method

template<typename Object , typename Context >

const ParallelStudyMethod& SendBuffer< Object, Context >::_method

private

Definition at line 99 of file SendBuffer.h.

◆ _min_buffer_size

template<typename Object , typename Context >

const unsigned int SendBuffer< Object, Context >::_min_buffer_size

private

Minimum size of the buffer (in objects)

Definition at line 102 of file SendBuffer.h.

◆ _object_buffer_tag

template<typename Object , typename Context >

const Parallel::MessageTag SendBuffer< Object, Context >::_object_buffer_tag

private

MessageTag for sending objects.

Definition at line 112 of file SendBuffer.h.

◆ _objects_sent

template<typename Object , typename Context >

unsigned long int SendBuffer< Object, Context >::_objects_sent

private

Counter for objects sent.

Definition at line 133 of file SendBuffer.h.

Referenced by SendBuffer< Object, Context >::objectsSent().

◆ _pid

template<typename Object , typename Context >

const processor_id_type SendBuffer< Object, Context >::_pid

private

The processor ID this buffer will send to.

Definition at line 97 of file SendBuffer.h.

◆ _requests

template<typename Object , typename Context >

std::list<std::shared_ptr<Parallel::Request> > SendBuffer< Object, Context >::_requests

private

List of Requests.

Definition at line 125 of file SendBuffer.h.

Referenced by SendBuffer< Object, Context >::currentlySending().

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

ray_tracing/include/utils/SendBuffer.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename Object, typename Context> class SendBuffer< Object, Context >

Constructor & Destructor Documentation

◆ SendBuffer()

◆ ~SendBuffer()

Member Function Documentation

◆ bufferPoolCreated()

◆ buffersSent()

◆ cleanupRequests()

◆ clear()

◆ currentlyBuffered()

◆ currentlySending()

◆ forceSend()

◆ moveObject()

◆ objectsSent()

◆ waitAll()

Member Data Documentation

◆ _buffer

◆ _buffer_growth_multiplier

◆ _buffer_pool

◆ _buffer_shrink_multiplier

◆ _buffer_size_bytes

◆ _buffers_sent

◆ _context

◆ _current_buffer_size

◆ _current_buffer_size_real

◆ _max_buffer_size

◆ _method

◆ _min_buffer_size

◆ _object_buffer_tag

◆ _objects_sent

◆ _pid

◆ _requests

template<typename Object, typename Context>
class SendBuffer< Object, Context >