Namespaces | Classes | Typedefs | Enumerations | Functions
Xpetra Namespace Reference

Xpetra namespace More...

Namespaces

namespace  useTpetra
namespace  Exceptions

Classes

class  BlockMap
 Block-entry counterpart to Xpetra::Map. More...
class  EpetraBlockMap
 Block-entry counterpart to Xpetra::Map. More...
class  TpetraBlockMap
class  TpetraVbrMatrix
class  VbrMatrix
 VbrMatrix: Variable block row matrix. More...
struct  RowInfo
class  CrsGraph
class  CrsGraphFactory
class  CrsGraphFactory< int, int >
class  EpetraCrsGraph
class  TpetraCrsGraph
class  CrsMatrix
class  CrsMatrixFactory
class  CrsMatrixFactory< double, int, int >
class  EpetraCrsMatrix
class  TpetraCrsMatrix
class  DistObject
class  EpetraExport
class  Export
class  ExportFactory
class  ExportFactory< int, int >
class  TpetraExport
class  firstArg
class  secondArg
class  EpetraImport
class  Import
class  ImportFactory
class  ImportFactory< int, int >
class  TpetraImport
class  EpetraMap
class  Map
class  MapFactory
class  MapFactory< int, int >
class  TpetraMap
class  EpetraMultiVector
class  MultiVector
class  MultiVectorFactory
class  MultiVectorFactory< double, int, int >
class  TpetraMultiVector
class  DefaultPlatform
 Returns a default platform appropriate for the enviroment. More...
class  MpiPlatform
 A implementation of the Platform class for MPI-based platforms. More...
class  SerialPlatform
 A implementation of the Platform class for serial platforms. More...
class  RowGraph
class  RowMatrix
class  TpetraRowMatrix
class  Parameters
class  EpetraIntVector
class  EpetraVector
class  TpetraVector
class  Vector
class  VectorFactory
class  VectorFactory< double, int, int >
class  VectorFactory< int, int, int >
class  BlockedCrsOperator
class  EpetraMapExtractor
class  MapExtractor
class  MapExtractorFactory
class  MapExtractorFactory< double, int, int >
class  TpetraMapExtractor
class  CrsOperator
 Concrete implementation of Xpetra::Operator. More...
class  Operator
class  OperatorFactory
class  OperatorView
class  StridedEpetraMap
class  StridedMap
 Class that stores a strided map. More...
class  StridedMapFactory
class  StridedMapFactory< int, int >
class  StridedTpetraMap

Typedefs

typedef Teuchos_Ordinal Array_size_type
 Size type for Teuchos Array objects.
typedef size_t global_size_t
 Global size_t object.
typedef std::string viewLabel_t

Enumerations

enum  ELocalGlobal { LocalIndices, GlobalIndices }
enum  LocalGlobal { LocallyReplicated, GloballyDistributed }
enum  LookupStatus { AllIDsPresent, IDNotPresent }
enum  ProfileType { StaticProfile, DynamicProfile }
enum  OptimizeOption { DoOptimizeStorage, DoNotOptimizeStorage }
enum  CombineMode { ADD, INSERT, ABSMAX }
 Xpetra::Combine Mode enumerable type. More...
enum  UnderlyingLib { UseEpetra, UseTpetra, NotSpecified }

Functions

const Epetra_CrsGraph & toEpetra (const RCP< const CrsGraph< int, int > > &graph)
RCP< const CrsGraph< int, int > > toXpetra (const Epetra_CrsGraph &g)
template<class LocalOrdinal , class GlobalOrdinal , class Node , class LocalMatOps >
RCP< const CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node, LocalMatOps > > 
toXpetra (RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > >)
template<class LocalOrdinal , class GlobalOrdinal , class Node , class LocalMatOps >
RCP< const Tpetra::CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node, LocalMatOps > > 
toTpetra (const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > > &graph)
RCP< const Export< int, int > > toXpetra (const Epetra_Export *import)
const Epetra_Export & toEpetra (const Export< int, int > &)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Export
< LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (const Export< LocalOrdinal, GlobalOrdinal, Node > &)
RCP< const Import< int, int > > toXpetra (const Epetra_Import *import)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Import
< LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (const Import< LocalOrdinal, GlobalOrdinal, Node > &)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
toXpetra (const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &)
const Epetra_Map & toEpetra (const Map< int, int > &map)
const Epetra_Map & toEpetra (const RCP< const Map< int, int > > &map)
const RCP< const Map< int, int > > toXpetra (const Epetra_BlockMap &map)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > & 
toTpetra (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &)
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
toXpetra (const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &)
const Epetra_MultiVector & toEpetra (const MultiVector< double, int, int > &x)
Epetra_MultiVector & toEpetra (MultiVector< double, int, int > &x)
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::MultiVector
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > & 
toTpetra (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &)
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::MultiVector< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &)
const RCP< const Epetra_Comm > toEpetra (const RCP< const Teuchos::Comm< int > > &comm)
 Convert a Teuchos_Comm to an Epetra_Comm.
const RCP< const Teuchos::Comm
< int > > 
toXpetra (const Epetra_Comm &comm)
 Convert an Epetra_Comm.to a Teuchos_Comm.
bool toEpetra (Teuchos::ETransp)
 Convert a Teuchos::ETransp to an Epetra boolean.
std::string toString (UnderlyingLib lib)
 Convert a Xpetra::UnderlyingLib to a std::string.
Xpetra::LookupStatus toXpetra (Tpetra::LookupStatus)
 Convert a Tpetra::LookupStatus to a Xpetra::LookupStatus.
Tpetra::ProfileType toTpetra (Xpetra::ProfileType)
 Convert a Xpetra::OptimizeOption to a Tpetra::OptimizeOption.
Tpetra::OptimizeOption toTpetra (Xpetra::OptimizeOption)
 Convert a Xpetra::OptimizeOption to a Tpetra::OptimizeOption.
Tpetra::CombineMode toTpetra (Xpetra::CombineMode CM)
 Convert a Xpetra::CombineMode to a Tpetra::CombineMode.
Tpetra::LocalGlobal toTpetra (LocalGlobal lg)
 Convert a Xpetra::LocalGlobal to a Tpetra::LocalGlobal.
Xpetra::LookupStatus toXpetra (int)
 Convert a Epetra return value to a Xpetra::LookupStatus.
bool toEpetra (Xpetra::ProfileType)
 Convert a Xpetra::ProfileType to an Epetra StaticProfil boolean.
bool toEpetra (Xpetra::OptimizeOption)
 Convert a Xpetra::OptimizeOption to an Epetra OptimizeDataStorage boolean.
Epetra_CombineMode toEpetra (Xpetra::CombineMode CM)
 Convert a Xpetra::CombineMode to an Epetra_CombineMode.
Epetra_Vector & toEpetra (Vector< double, int, int > &x)
const Epetra_Vector & toEpetra (const Vector< double, int, int > &x)
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::Vector< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &)
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Vector< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > & 
toTpetra (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &)

Detailed Description

Xpetra namespace

Conversion between Epetra and Teuchos objects.

Namespace for Xpetra classes and methods.


Typedef Documentation

typedef Teuchos_Ordinal Xpetra::Array_size_type

Size type for Teuchos Array objects.

Definition at line 95 of file Xpetra_ConfigDefs.hpp.

typedef size_t Xpetra::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 161 of file Xpetra_ConfigDefs.hpp.

typedef std::string Xpetra::viewLabel_t

Definition at line 87 of file Xpetra_BlockedCrsOperator.hpp.


Enumeration Type Documentation

Enumerator:
LocalIndices 
GlobalIndices 

Definition at line 78 of file Xpetra_CrsGraph.hpp.

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 164 of file Xpetra_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 170 of file Xpetra_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 176 of file Xpetra_ConfigDefs.hpp.

Optimize storage option

Enumerator:
DoOptimizeStorage 

Indicates that storage should be optimized

DoNotOptimizeStorage 

Indicates that storage should not be optimized

Definition at line 182 of file Xpetra_ConfigDefs.hpp.

Xpetra::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 

TODO

INSERT 

TODO

ABSMAX 

TODO: don't exist for Tpetra

Definition at line 205 of file Xpetra_ConfigDefs.hpp.

Enumerator:
UseEpetra 
UseTpetra 
NotSpecified 

Definition at line 57 of file Xpetra_Map.hpp.


Function Documentation

const Epetra_CrsGraph & Xpetra::toEpetra ( const RCP< const CrsGraph< int, int > > &  graph)

Definition at line 56 of file Xpetra_EpetraCrsGraph.cpp.

RCP< const CrsGraph< int, int > > Xpetra::toXpetra ( const Epetra_CrsGraph &  g)

Definition at line 144 of file Xpetra_EpetraCrsGraph.cpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node , class LocalMatOps >
RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > > Xpetra::toXpetra ( RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > >  graph)

Definition at line 329 of file Xpetra_TpetraCrsGraph.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node , class LocalMatOps >
RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > > Xpetra::toTpetra ( const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps > > &  graph)

Definition at line 338 of file Xpetra_TpetraCrsGraph.hpp.

RCP< const Export<int, int > > Xpetra::toXpetra ( const Epetra_Export *  import)

Definition at line 55 of file Xpetra_EpetraExport.cpp.

const Epetra_Export& Xpetra::toEpetra ( const Export< int, int > &  )
template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  exp)

Definition at line 162 of file Xpetra_TpetraExport.hpp.

RCP< const Import< int, int > > Xpetra::toXpetra ( const Epetra_Import *  import)

Definition at line 67 of file Xpetra_EpetraImport.cpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import)

Definition at line 163 of file Xpetra_TpetraImport.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::toXpetra ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &  import)

Definition at line 170 of file Xpetra_TpetraImport.hpp.

const Epetra_Map & Xpetra::toEpetra ( const Map< int, int > &  map)

Definition at line 336 of file Xpetra_EpetraMap.cpp.

const Epetra_Map & Xpetra::toEpetra ( const RCP< const Map< int, int > > &  map)

Definition at line 342 of file Xpetra_EpetraMap.cpp.

const RCP< const Map< int, int > > Xpetra::toXpetra ( const Epetra_BlockMap &  map)

Definition at line 351 of file Xpetra_EpetraMap.cpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &  map)

Definition at line 214 of file Xpetra_TpetraMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & Xpetra::toTpetra ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  map)

Definition at line 221 of file Xpetra_TpetraMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::toXpetra ( const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &  map)

Definition at line 228 of file Xpetra_TpetraMap.hpp.

const Epetra_MultiVector & Xpetra::toEpetra ( const MultiVector< double, int, int > &  x)

Definition at line 188 of file Xpetra_EpetraMultiVector.cpp.

Epetra_MultiVector & Xpetra::toEpetra ( MultiVector< double, int, int > &  x)

Definition at line 193 of file Xpetra_EpetraMultiVector.cpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)

Definition at line 313 of file Xpetra_TpetraMultiVector.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)

Definition at line 320 of file Xpetra_TpetraMultiVector.hpp.

const RCP< const Epetra_Comm > Xpetra::toEpetra ( const RCP< const Teuchos::Comm< int > > &  comm)

Convert a Teuchos_Comm to an Epetra_Comm.

Definition at line 71 of file Xpetra_EpetraUtils.cpp.

const RCP< const Teuchos::Comm< int > > Xpetra::toXpetra ( const Epetra_Comm &  comm)

Convert an Epetra_Comm.to a Teuchos_Comm.

Definition at line 84 of file Xpetra_EpetraUtils.cpp.

bool Xpetra::toEpetra ( Teuchos::ETransp  trans)

Convert a Teuchos::ETransp to an Epetra boolean.

Definition at line 100 of file Xpetra_EpetraUtils.cpp.

Convert a Xpetra::UnderlyingLib to a std::string.

Definition at line 51 of file Xpetra_Utils.cpp.

Xpetra::LookupStatus Xpetra::toXpetra ( Tpetra::LookupStatus  ls)

Convert a Tpetra::LookupStatus to a Xpetra::LookupStatus.

Definition at line 63 of file Xpetra_Utils.cpp.

Tpetra::ProfileType Xpetra::toTpetra ( Xpetra::ProfileType  pt)

Convert a Xpetra::OptimizeOption to a Tpetra::OptimizeOption.

Definition at line 74 of file Xpetra_Utils.cpp.

Tpetra::OptimizeOption Xpetra::toTpetra ( Xpetra::OptimizeOption  os)

Convert a Xpetra::OptimizeOption to a Tpetra::OptimizeOption.

Definition at line 85 of file Xpetra_Utils.cpp.

Tpetra::CombineMode Xpetra::toTpetra ( Xpetra::CombineMode  cm)

Convert a Xpetra::CombineMode to a Tpetra::CombineMode.

Definition at line 96 of file Xpetra_Utils.cpp.

Tpetra::LocalGlobal Xpetra::toTpetra ( LocalGlobal  lg)

Convert a Xpetra::LocalGlobal to a Tpetra::LocalGlobal.

Definition at line 111 of file Xpetra_Utils.cpp.

Convert a Epetra return value to a Xpetra::LookupStatus.

Definition at line 126 of file Xpetra_Utils.cpp.

Convert a Xpetra::ProfileType to an Epetra StaticProfil boolean.

Definition at line 138 of file Xpetra_Utils.cpp.

Convert a Xpetra::OptimizeOption to an Epetra OptimizeDataStorage boolean.

Definition at line 148 of file Xpetra_Utils.cpp.

Epetra_CombineMode Xpetra::toEpetra ( Xpetra::CombineMode  cm)

Convert a Xpetra::CombineMode to an Epetra_CombineMode.

Definition at line 159 of file Xpetra_Utils.cpp.

Epetra_Vector & Xpetra::toEpetra ( Vector< double, int, int > &  x)

Definition at line 165 of file Xpetra_EpetraVector.cpp.

const Epetra_Vector & Xpetra::toEpetra ( const Vector< double, int, int > &  x)

Definition at line 170 of file Xpetra_EpetraVector.cpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)

Definition at line 174 of file Xpetra_TpetraVector.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::toTpetra ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)

Definition at line 181 of file Xpetra_TpetraVector.hpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines