Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Related Functions
Teuchos::SerialComm< Ordinal > Class Template Reference

Concrete serial communicator subclass. More...

#include <Teuchos_DefaultSerialComm.hpp>

Inheritance diagram for Teuchos::SerialComm< Ordinal >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

int getTag () const
 The current tag.

Related Functions

(Note that these are not member functions.)

template<typename Ordinal >
RCP< SerialComm< Ordinal > > createSerialComm ()
 Nonmember constructor.

Constructors

 SerialComm ()
 
 SerialComm (const SerialComm< Ordinal > &other)
 Default copy constructor.

Overridden from Comm

virtual int getRank () const
 
virtual int getSize () const
 
virtual void barrier () const
 
virtual void broadcast (const int rootRank, const Ordinal bytes, char buffer[]) const
 
virtual void gather (const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvBytes, char recvBuffer[], const int root) const
 Gather values from all processes to the root process.
virtual void gatherAll (const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvBytes, char recvBuffer[]) const
 
virtual void reduceAll (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal bytes, const char sendBuffer[], char globalReducts[]) const
 
virtual void reduceAllAndScatter (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvCounts[], char myGlobalReducts[]) const
 
virtual void scan (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal bytes, const char sendBuffer[], char scanReducts[]) const
 
virtual void send (const Ordinal bytes, const char sendBuffer[], const int destRank) const
 
virtual void send (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 
virtual void ssend (const Ordinal bytes, const char sendBuffer[], const int destRank) const
 
virtual void ssend (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 
virtual int receive (const int sourceRank, const Ordinal bytes, char recvBuffer[]) const
 
virtual void readySend (const ArrayView< const char > &sendBuffer, const int destRank) const
 
virtual void readySend (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 
virtual RCP< CommRequest
< Ordinal > > 
isend (const ArrayView< const char > &sendBuffer, const int destRank) const
 
virtual RCP< CommRequest
< Ordinal > > 
isend (const ArrayView< const char > &sendBuffer, const int destRank, const int tag) const
 Variant of isend() that takes a tag.
virtual RCP< CommRequest
< Ordinal > > 
ireceive (const ArrayView< char > &Buffer, const int sourceRank) const
 
virtual RCP< CommRequest
< Ordinal > > 
ireceive (const ArrayView< char > &Buffer, const int sourceRank, const int tag) const
 
virtual void waitAll (const ArrayView< RCP< CommRequest< Ordinal > > > &requests) const
 
virtual void waitAll (const ArrayView< RCP< CommRequest< Ordinal > > > &requests, const ArrayView< RCP< CommStatus< Ordinal > > > &statuses) const
 
virtual RCP< CommStatus
< Ordinal > > 
wait (const Ptr< RCP< CommRequest< Ordinal > > > &request) const
 
virtual RCP< Comm< Ordinal > > duplicate () const
 
virtual RCP< Comm< Ordinal > > split (const int color, const int key) const
 
virtual RCP< Comm< Ordinal > > createSubcommunicator (const ArrayView< const int > &ranks) const

Overridden from Describable

std::string description () const
 

Detailed Description

template<typename Ordinal>
class Teuchos::SerialComm< Ordinal >

Concrete serial communicator subclass.

ToDo: Finish documentation!

Definition at line 76 of file Teuchos_DefaultSerialComm.hpp.


Constructor & Destructor Documentation

template<typename Ordinal >
Teuchos::SerialComm< Ordinal >::SerialComm ( )

Definition at line 241 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
Teuchos::SerialComm< Ordinal >::SerialComm ( const SerialComm< Ordinal > &  other)

Default copy constructor.

Definition at line 245 of file Teuchos_DefaultSerialComm.hpp.


Member Function Documentation

template<typename Ordinal>
int Teuchos::SerialComm< Ordinal >::getTag ( ) const [inline, virtual]

The current tag.

Warning:
This method is ONLY for use by Teuchos developers. Users should not depend on the interface of this method. It may change or disappear at any time without warning.

Implements Teuchos::Comm< Ordinal >.

Definition at line 83 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
int Teuchos::SerialComm< Ordinal >::getRank ( ) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 253 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
int Teuchos::SerialComm< Ordinal >::getSize ( ) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 260 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::barrier ( ) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 267 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::broadcast ( const int  rootRank,
const Ordinal  bytes,
char  buffer[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 274 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::gather ( const Ordinal  sendBytes,
const char  sendBuffer[],
const Ordinal  recvBytes,
char  recvBuffer[],
const int  root 
) const [virtual]

Gather values from all processes to the root process.

Implements Teuchos::Comm< Ordinal >.

Definition at line 301 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::gatherAll ( const Ordinal  sendBytes,
const char  sendBuffer[],
const Ordinal  recvBytes,
char  recvBuffer[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 283 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::reduceAll ( const ValueTypeReductionOp< Ordinal, char > &  reductOp,
const Ordinal  bytes,
const char  sendBuffer[],
char  globalReducts[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 320 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::reduceAllAndScatter ( const ValueTypeReductionOp< Ordinal, char > &  reductOp,
const Ordinal  sendBytes,
const char  sendBuffer[],
const Ordinal  recvCounts[],
char  myGlobalReducts[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 331 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::scan ( const ValueTypeReductionOp< Ordinal, char > &  reductOp,
const Ordinal  bytes,
const char  sendBuffer[],
char  scanReducts[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 352 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::send ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 363 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::send ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 376 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::ssend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 389 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::ssend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 402 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
int Teuchos::SerialComm< Ordinal >::receive ( const int  sourceRank,
const Ordinal  bytes,
char  recvBuffer[] 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 415 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::readySend ( const ArrayView< const char > &  sendBuffer,
const int  destRank 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 428 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::readySend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 442 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< CommRequest< Ordinal > > Teuchos::SerialComm< Ordinal >::isend ( const ArrayView< const char > &  sendBuffer,
const int  destRank 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 460 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< CommRequest< Ordinal > > Teuchos::SerialComm< Ordinal >::isend ( const ArrayView< const char > &  sendBuffer,
const int  destRank,
const int  tag 
) const [virtual]

Variant of isend() that takes a tag.

Implements Teuchos::Comm< Ordinal >.

Definition at line 472 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< CommRequest< Ordinal > > Teuchos::SerialComm< Ordinal >::ireceive ( const ArrayView< char > &  Buffer,
const int  sourceRank 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 481 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< CommRequest< Ordinal > > Teuchos::SerialComm< Ordinal >::ireceive ( const ArrayView< char > &  Buffer,
const int  sourceRank,
const int  tag 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 493 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::waitAll ( const ArrayView< RCP< CommRequest< Ordinal > > > &  requests) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 502 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
void Teuchos::SerialComm< Ordinal >::waitAll ( const ArrayView< RCP< CommRequest< Ordinal > > > &  requests,
const ArrayView< RCP< CommStatus< Ordinal > > > &  statuses 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 512 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< CommStatus< Ordinal > > Teuchos::SerialComm< Ordinal >::wait ( const Ptr< RCP< CommRequest< Ordinal > > > &  request) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 529 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< Comm< Ordinal > > Teuchos::SerialComm< Ordinal >::duplicate ( ) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 544 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< Comm< Ordinal > > Teuchos::SerialComm< Ordinal >::split ( const int  color,
const int  key 
) const [virtual]

Implements Teuchos::Comm< Ordinal >.

Definition at line 551 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
RCP< Comm< Ordinal > > Teuchos::SerialComm< Ordinal >::createSubcommunicator ( const ArrayView< const int > &  ranks) const [virtual]

brief .

Implements Teuchos::Comm< Ordinal >.

Definition at line 562 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal >
std::string Teuchos::SerialComm< Ordinal >::description ( ) const [virtual]

Reimplemented from Teuchos::Describable.

Definition at line 575 of file Teuchos_DefaultSerialComm.hpp.


Friends And Related Function Documentation

template<typename Ordinal >
RCP< SerialComm< Ordinal > > createSerialComm ( ) [related]

Nonmember constructor.

Definition at line 227 of file Teuchos_DefaultSerialComm.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines