libMesh::Parallel::BinSorter< KeyType, IdxType > Class Template Reference

Perform a parallel sort using a bin-sort method. More...

#include <parallel_bin_sorter.h>

Inheritance diagram for libMesh::Parallel::BinSorter< KeyType, IdxType >:

Public Member Functions
	BinSorter (const Parallel::Communicator &comm, const std::vector< KeyType > &d)
void	binsort (const IdxType nbins, KeyType max, KeyType min)
	The actual function which sorts the data into nbins. More...
IdxType	sizeof_bin (const IdxType bin) const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Attributes
const Parallel::Communicator &	_communicator

Private Types
typedef std::vector< KeyType >::const_iterator	IterType

Private Attributes
const std::vector< KeyType > &	data
std::vector< IterType >	bin_iters

Detailed Description

template<typename KeyType, typename IdxType = unsigned int>
class libMesh::Parallel::BinSorter< KeyType, IdxType >

Perform a parallel sort using a bin-sort method.

Author

Benjamin S. Kirk

John W. Peterson

Date

2007 Parallel bin sorting object.

Definition at line 49 of file parallel_bin_sorter.h.

Member Typedef Documentation

IterType

template<typename KeyType , typename IdxType = unsigned int>

typedef std::vector<KeyType>::const_iterator libMesh::Parallel::BinSorter< KeyType, IdxType >::IterType

private

Definition at line 52 of file parallel_bin_sorter.h.

Constructor & Destructor Documentation

BinSorter()

template<typename KeyType , typename IdxType = unsigned int>

libMesh::Parallel::BinSorter< KeyType, IdxType >::BinSorter ( const Parallel::Communicator &  comm, const std::vector< KeyType > &  d  )

explicit

Member Function Documentation

binsort()

template<typename KeyType , typename IdxType = unsigned int>

void libMesh::Parallel::BinSorter< KeyType, IdxType >::binsort	(	const IdxType	nbins,
		KeyType	max,
		KeyType	min
	)

The actual function which sorts the data into nbins.

Currently based on the global min and max which you must provide e.g. by using MPI.

comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inherited

Returns

A reference to the Parallel::Communicator object used by this mesh.

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id(), and libMesh::Parallel::sync_node_data_by_element_id_once().

  { return _communicator; }

n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns

The number of processors in the group.

Definition at line 95 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

  { return cast_int<processor_id_type>(_communicator.size()); }

processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns

The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

Referenced by libMesh::DofMap::end_dof(), libMesh::DofMap::end_old_dof(), libMesh::DofMap::first_dof(), libMesh::DofMap::first_old_dof(), libMesh::DofMap::last_dof(), libMesh::MeshBase::n_active_local_elem(), libMesh::DofMap::n_local_dofs(), libMesh::MeshBase::n_local_elem(), libMesh::MeshBase::n_local_nodes(), and libMesh::MeshTools::weight().

  { return cast_int<processor_id_type>(_communicator.rank()); }

sizeof_bin()

template<typename KeyType , typename IdxType >

IdxType libMesh::Parallel::BinSorter< KeyType, IdxType >::sizeof_bin

(

const IdxType

bin

)

const

Returns

The size of bin b as an unsigned int.

Definition at line 88 of file parallel_bin_sorter.h.

{
  libmesh_assert_less ((bin+1), bin_iters.size());

  // The size of the bin is defined by the distance between
  // its bounding iterators
  return cast_int<IdxType>
    (std::distance (bin_iters[bin], bin_iters[bin+1]));
}

Member Data Documentation

_communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 107 of file parallel_object.h.

Referenced by libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

bin_iters

template<typename KeyType , typename IdxType = unsigned int>

std::vector<IterType> libMesh::Parallel::BinSorter< KeyType, IdxType >::bin_iters

private

Definition at line 79 of file parallel_bin_sorter.h.

data

template<typename KeyType , typename IdxType = unsigned int>

const std::vector<KeyType>& libMesh::Parallel::BinSorter< KeyType, IdxType >::data

private

Definition at line 78 of file parallel_bin_sorter.h.

---

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

• include/parallel/parallel_bin_sorter.h