Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Related Functions | List of all members
Teuchos::SerialComm< Ordinal > Class Template Reference

Concrete serial communicator subclass. More...

#include <Teuchos_DefaultSerialComm.hpp>

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

Public Member Functions

int getTag () const
 The current tag. More...
 
- Public Member Functions inherited from Teuchos::Comm< Ordinal >
virtual ~Comm ()
 Destructor, declared virtual for safety of derived classes. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 

Related Functions

(Note that these are not member functions.)

template<typename Ordinal >
RCP< SerialComm< Ordinal > > createSerialComm ()
 Nonmember constructor. More...
 
 Predefined reduction operations that Teuchos::Comm understands. More...

Constructors

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

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. More...
 
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 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. More...
 
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
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

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 235 of file Teuchos_DefaultSerialComm.hpp.

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

Default copy constructor.

Definition at line 239 of file Teuchos_DefaultSerialComm.hpp.

Member Function Documentation

template<typename Ordinal>
int Teuchos::SerialComm< Ordinal >::getTag ( ) const
inlinevirtual

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 247 of file Teuchos_DefaultSerialComm.hpp.

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

Implements Teuchos::Comm< Ordinal >.

Definition at line 254 of file Teuchos_DefaultSerialComm.hpp.

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

Implements Teuchos::Comm< Ordinal >.

Definition at line 261 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 268 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 295 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 277 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 314 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 325 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 336 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 349 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 362 of file Teuchos_DefaultSerialComm.hpp.

template<typename Ordinal>
virtual void Teuchos::SerialComm< Ordinal >::ssend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const
virtual
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 388 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 401 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 415 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 433 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 445 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 454 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 466 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 475 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 485 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 502 of file Teuchos_DefaultSerialComm.hpp.

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

Implements Teuchos::Comm< Ordinal >.

Definition at line 517 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 524 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 535 of file Teuchos_DefaultSerialComm.hpp.

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

Reimplemented from Teuchos::Describable.

Definition at line 548 of file Teuchos_DefaultSerialComm.hpp.

Friends And Related Function Documentation

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

Nonmember constructor.

Definition at line 221 of file Teuchos_DefaultSerialComm.hpp.


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