Tpetra Namespace Reference

Tpetra namespace More...

Classes

class  BlockMultiVector
 Block-entry specialization of Tpetra::MultiVector. More...
class  CrsGraph
 A class for constructing and using sparse compressed index graphs with row access. More...
class  CrsMatrix
 A class for constructing and using sparse compressed matrices with row access. More...
class  CrsMatrixMultiplyOp
 A class for wrapping a CrsMatrix multiply in a Operator. More...
class  CrsMatrixSolveOp
 A class for wrapping a Tpetra::CrsMatrix solve in a Tpetra::Operator. More...
class  DefaultPlatform
 Returns a default platform appropriate for the enviroment. More...
class  Directory
 A class used for efficienctly accessing global node/index information from a Map. More...
class  DistObject
 A base class for distributed objects that support import and export operations. More...
class  Distributor
 The Tpetra gather/scatter setup class. More...
class  Export
 This class builds an object containing information necesary for efficiently exporting entries off-processor. More...
class  HybridPlatform
 A platform class for hybrid nodes. More...
class  Import
 This class builds an object containing information necesary for efficiently importing off-processor entries. More...
class  Map
 A class for partitioning distributed objects. More...
class  MpiPlatform
 A implementation of the Platform class for MPI-based platforms. More...
class  MultiVector
 A class for constructing and using dense, distributors multivectors. More...
class  Operator
 Abstract interface for linear operators accepting Tpetra MultiVector objects. More...
class  RowGraph
 A pure virtual interface for row-partitioned graphs. More...
class  RowMatrix
 A pure virtual interface for row-partitioned matrices. More...
class  SerialPlatform
 A implementation of the Platform class for serial platforms. More...
class  VbrMatrix
 VbrMatrix: Variable block row matrix. More...
class  Vector
 A class for constructing and using dense, distributors vectors. More...

Typedefs

typedef Teuchos_Ordinal Array_size_type
 Size type for Teuchos Array objects.
typedef size_t global_size_t
 Global size_t object.

Enumerations

enum  LocalGlobal { LocallyReplicated, GloballyDistributed }
enum  LookupStatus { AllIDsPresent, IDNotPresent }
enum  ProfileType { StaticProfile, DynamicProfile }
enum  OptimizeOption { DoOptimizeStorage, DoNotOptimizeStorage }
enum  CombineMode { ADD, INSERT, REPLACE }
 

Tpetra::Combine Mode enumerable type.

More...

Functions

template<typename MapType , typename KeyArgType , typename ValueArgType >
MapType::iterator efficientAddOrUpdate (MapType &m, const KeyArgType &k, const ValueArgType &v)
template<class IT1 , class IT2 >
void sort2 (const IT1 &first1, const IT1 &last1, const IT2 &first2)
template<class IT1 , class IT2 , class IT3 >
void sort3 (const IT1 &first1, const IT1 &last1, const IT2 &first2, const IT3 &first3)

Detailed Description

Tpetra namespace


Typedef Documentation

typedef Teuchos_Ordinal Tpetra::Array_size_type

Size type for Teuchos Array objects.

Definition at line 78 of file Tpetra_ConfigDefs.hpp.

typedef size_t Tpetra::global_size_t

Global size_t object.

Set at configure time, this type is intended to support scenarios where the global memory allocation is larger than that of a single node.

Currently, it is typedefed to size_t.

Definition at line 114 of file Tpetra_ConfigDefs.hpp.


Enumeration Type Documentation

Local versus global allocation of Map elements

Enumerator:
LocallyReplicated 

Indicates that map elements are locally replicated across all nodes

GloballyDistributed 

Indicates that map elements are globally distributed across all nodes

Definition at line 117 of file Tpetra_ConfigDefs.hpp.

Return status of Map lookup

Enumerator:
AllIDsPresent 

Indicates that all queried IDs were present in the Map

IDNotPresent 

Indicates that at least one of the specified IDs was not present in the Map

Definition at line 123 of file Tpetra_ConfigDefs.hpp.

Allocation profile for matrix/graph entries

Enumerator:
StaticProfile 

Indicates a single, static allocation (strict and more efficient)

DynamicProfile 

Indicates multiple, dynamic allocations (flexibile, but less efficient)

Definition at line 129 of file Tpetra_ConfigDefs.hpp.

Optimize storage option

Enumerator:
DoOptimizeStorage 

Indicates that storage should be optimized

DoNotOptimizeStorage 

Indicates that storage should not be optimized

Definition at line 135 of file Tpetra_ConfigDefs.hpp.

Tpetra::Combine Mode enumerable type.

If set to Add, existing values will be summed with new values. If set to Insert, new values will be inserted that don't currently exist. If set to Replace, existing values will be replaced with new values.

NOTE: Add and Replace are intended for modifying values that already exist, but it will function correctly if those values don't already exist. (i.e. zero will be inserted, and then summed with or replaced by the new value.) However, performance may suffer. (The same goes for Insert.)

Enumerator:
ADD 

Existing values will be summed with new values.

INSERT 

Insert new values that don't currently exist.

REPLACE 

Existing values will be replaced with new values.

Definition at line 151 of file Tpetra_ConfigDefs.hpp.


Function Documentation

template<typename MapType , typename KeyArgType , typename ValueArgType >
MapType::iterator Tpetra::efficientAddOrUpdate ( MapType &  m,
const KeyArgType &  k,
const ValueArgType &  v 
) [inline]

efficientAddOrUpdate is taken from Scott Meyers' "Effective STL", Item 24. if m already contains an entry with key k, use operator []. if it doesn't, insert is used.

Definition at line 125 of file Tpetra_Util.hpp.

template<class IT1 , class IT2 >
void Tpetra::sort2 ( const IT1 &  first1,
const IT1 &  last1,
const IT2 &  first2 
) [inline]

sort function for two arrays The values in sortVals will be sorted in ascending order. The same permutation required to sort sortVals will be applied to otherVals.

Definition at line 147 of file Tpetra_Util.hpp.

template<class IT1 , class IT2 , class IT3 >
void Tpetra::sort3 ( const IT1 &  first1,
const IT1 &  last1,
const IT2 &  first2,
const IT3 &  first3 
) [inline]

sort function for three arrays The values in sortVals will be sorted in ascending order. The same permutation required to sort sortVals will be applied to otherVals.

Definition at line 177 of file Tpetra_Util.hpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:21:41 2011 for Tpetra Matrix/Vector Services by  doxygen 1.6.3