Communication Policy to add values of a vector. More...

#include <communication_policies.h>

Inheritance diagram for ug::ComPol_VecAdd< TVector >:

Public Member Functions
virtual bool	collect (ug::BinaryBuffer &buff, const Interface &interface)
	writes the interface values into a buffer that will be sent More...

	ComPol_VecAdd ()
	Default constructor. More...

	ComPol_VecAdd (TVector *pVec)
	Constructor setting the values. More...

	ComPol_VecAdd (TVector pVecDest, const TVector pVecSrc)
	Constructor setting the values. More...

virtual bool	extract (ug::BinaryBuffer &buff, const Interface &interface)
	adds values of a buffer to the interface values More...

virtual int	get_required_buffer_size (const Interface &interface)
	returns the buffer size More...

void	set_vector (TVector *pVec)
	sets the vector used in communication More...

void	set_vector (TVector pVecDest, const TVector pVecSrc)
	sets the vector used in communication More...

Public Member Functions inherited from pcl::ICommunicationPolicy< IndexLayout >
virtual bool	begin_layout_collection (const Layout *pLayout)
	signals the beginning of a layout collection. More...

virtual bool	begin_layout_extraction (const Layout *pLayout)
	signals the beginning of a layout extraction. More...

virtual void	begin_level_extraction (int level)
	signals that a new layout-level will now be processed. More...

virtual bool	end_layout_collection (const Layout *pLayout)
	signals the end of a layout collection More...

virtual bool	end_layout_extraction (const Layout *pLayout)
	signals the end of a layout extraction More...

virtual	~ICommunicationPolicy ()

Private Attributes
TVector *	m_pVecDest

const TVector *	m_pVecSrc

Additional Inherited Members
Public Types inherited from pcl::ICommunicationPolicy< IndexLayout >
typedef Layout::Interface	Interface

typedef IndexLayout	Layout

Detailed Description

template<class TVector>
class ug::ComPol_VecAdd< TVector >

Communication Policy to add values of a vector.

This class is used as a policy to add values on the interfaces of a parallel vector. The collecting interfaces pack the values on the interface into a stream. The extracting interfaces receive the stream and adds the values of the vector.

Template Parameters

TVector Vector type

Constructor & Destructor Documentation

◆ ComPol_VecAdd() [1/3]

template<class TVector >

ug::ComPol_VecAdd< TVector >::ComPol_VecAdd ( )

inline

Default constructor.

◆ ComPol_VecAdd() [2/3]

template<class TVector >

ug::ComPol_VecAdd< TVector >::ComPol_VecAdd ( TVector * pVec )

inline

Constructor setting the values.

◆ ComPol_VecAdd() [3/3]

template<class TVector >

ug::ComPol_VecAdd< TVector >::ComPol_VecAdd	(	TVector *	pVecDest,
		const TVector *	pVecSrc
	)

inline

Constructor setting the values.

Member Function Documentation

◆ collect()

template<class TVector >

virtual bool ug::ComPol_VecAdd< TVector >::collect	(	ug::BinaryBuffer &	buff,
		const Interface &	interface
	)

inlinevirtual

writes the interface values into a buffer that will be sent

This function collects all entries of the vector into a buffer that are part of the interface.

Parameters

[out]	buff	Buffer
[in]	interface	Interface that will communicate

Implements pcl::ICommunicationPolicy< IndexLayout >.

References pcl::OrderedInterface< TType, TContainer, TAlloc >::begin(), pcl::OrderedInterface< TType, TContainer, TAlloc >::end(), pcl::OrderedInterface< TType, TContainer, TAlloc >::get_element(), ug::ComPol_VecAdd< TVector >::m_pVecSrc, PROFILE_BEGIN_GROUP, and ug::Serialize().

◆ extract()

template<class TVector >

virtual bool ug::ComPol_VecAdd< TVector >::extract	(	ug::BinaryBuffer &	buff,
		const Interface &	interface
	)

inlinevirtual

adds values of a buffer to the interface values

This function adds the buffer values to the vector values.

Parameters

[out]	buff	Buffer
[in]	interface	Interface that communicates

Implements pcl::ICommunicationPolicy< IndexLayout >.

References pcl::OrderedInterface< TType, TContainer, TAlloc >::begin(), ug::Deserialize(), pcl::OrderedInterface< TType, TContainer, TAlloc >::end(), pcl::OrderedInterface< TType, TContainer, TAlloc >::get_element(), ug::ComPol_VecAdd< TVector >::m_pVecDest, and PROFILE_BEGIN_GROUP.

◆ get_required_buffer_size()

template<class TVector >

virtual int ug::ComPol_VecAdd< TVector >::get_required_buffer_size ( const Interface & interface )

inlinevirtual

returns the buffer size

This function returns the size of the buffer needed for the communication of passed interface. If the vector has fixed size entries this is just the number of interface entries times the size of the entry. In case of a variable size entry type a negative value is returned to indicate that no buffer size can be determined in advanced.

Parameters

[in] interface Interface that will communicate

Reimplemented from pcl::ICommunicationPolicy< IndexLayout >.

References pcl::OrderedInterface< TType, TContainer, TAlloc >::size().

◆ set_vector() [1/2]

template<class TVector >

void ug::ComPol_VecAdd< TVector >::set_vector ( TVector * pVec )

inline

sets the vector used in communication

References ug::ComPol_VecAdd< TVector >::m_pVecDest, and ug::ComPol_VecAdd< TVector >::m_pVecSrc.

◆ set_vector() [2/2]

template<class TVector >

void ug::ComPol_VecAdd< TVector >::set_vector	(	TVector *	pVecDest,
		const TVector *	pVecSrc
	)

inline

sets the vector used in communication

References ug::ComPol_VecAdd< TVector >::m_pVecDest, and ug::ComPol_VecAdd< TVector >::m_pVecSrc.

Member Data Documentation

◆ m_pVecDest

template<class TVector >

TVector* ug::ComPol_VecAdd< TVector >::m_pVecDest

private

Referenced by ug::ComPol_VecAdd< TVector >::extract(), and ug::ComPol_VecAdd< TVector >::set_vector().

◆ m_pVecSrc

template<class TVector >

const TVector* ug::ComPol_VecAdd< TVector >::m_pVecSrc

private

Referenced by ug::ComPol_VecAdd< TVector >::collect(), and ug::ComPol_VecAdd< TVector >::set_vector().

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

ugbase/lib_algebra/parallelization/communication_policies.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class TVector> class ug::ComPol_VecAdd< TVector >

Constructor & Destructor Documentation

◆ ComPol_VecAdd() [1/3]

◆ ComPol_VecAdd() [2/3]

◆ ComPol_VecAdd() [3/3]

Member Function Documentation

◆ collect()

◆ extract()

◆ get_required_buffer_size()

◆ set_vector() [1/2]

◆ set_vector() [2/2]

Member Data Documentation

◆ m_pVecDest

◆ m_pVecSrc

template<class TVector>
class ug::ComPol_VecAdd< TVector >