PyTrilinos::Epetra::DistObject Class Reference

Inheritance diagram for PyTrilinos::Epetra::DistObject:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Epetra::DistObject:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def Import
def Export
def Map
def Comm
def DistributedGlobal
def __init__
def Import
def Export
def Map
def Comm
def DistributedGlobal


Detailed Description

Epetra_DistObject: A class for constructing and using dense multi-
vectors, vectors and matrices in parallel.

The Epetra_DistObject is a base class for all Epetra distributed
global objects. It provides the basic mechanisms and interface
specifications for importing and exporting operations using
Epetra_Import and Epetra_Export objects.

Distributed Global vs. Replicated Local.

Distributed Global objects - In most instances, a distributed object
will be partitioned across multiple memory images associated with
multiple processors. In this case, there is a unique copy of each
element and elements are spread across all processors specified by the
Epetra_Comm communicator.

Replicated Local Objects - Some algorithms use objects that are too
small to be distributed across all processors, the Hessenberg matrix
in a GMRES computation. In other cases, such as with block iterative
methods, block dot product functions produce small dense matrices that
are required by all processors. Replicated local objectss handle these
types of situation.

C++ includes: Epetra_DistObject.h 

Member Function Documentation

def PyTrilinos::Epetra::DistObject::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Epetra_DistObject::Comm() const

Returns the address of the Epetra_Comm for this multi-vector. 

Reimplemented in PyTrilinos::Epetra::CrsGraph, PyTrilinos::Epetra::CrsMatrix, PyTrilinos::Epetra::VbrMatrix, PyTrilinos::Epetra::CrsGraph, PyTrilinos::Epetra::CrsMatrix, and PyTrilinos::Epetra::VbrMatrix.

def PyTrilinos::Epetra::DistObject::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Epetra_DistObject::Comm() const

Returns the address of the Epetra_Comm for this multi-vector. 

Reimplemented in PyTrilinos::Epetra::CrsGraph, PyTrilinos::Epetra::CrsMatrix, PyTrilinos::Epetra::VbrMatrix, PyTrilinos::Epetra::CrsGraph, PyTrilinos::Epetra::CrsMatrix, and PyTrilinos::Epetra::VbrMatrix.

def PyTrilinos::Epetra::DistObject::DistributedGlobal (   self,
  args 
)

DistributedGlobal(self) -> bool

bool
Epetra_DistObject::DistributedGlobal() const

Returns true if this multi-vector is distributed global, i.e., not
local replicated. 

def PyTrilinos::Epetra::DistObject::DistributedGlobal (   self,
  args 
)

DistributedGlobal(self) -> bool

bool
Epetra_DistObject::DistributedGlobal() const

Returns true if this multi-vector is distributed global, i.e., not
local replicated. 

def PyTrilinos::Epetra::DistObject::Export (   self,
  args 
)

Export(self, SrcDistObject A, Import Importer, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int
Export(self, SrcDistObject A, Export Exporter, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int

int
Epetra_DistObject::Export(const Epetra_SrcDistObject &A, const
Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const
Epetra_OffsetIndex *Indexor=0)

Exports an Epetra_DistObject using the Epetra_Export object.

Parameters:
-----------

In:  Source - Distributed object that will be exported to the "\\e
this" multivector.

In:  Exporter - A Epetra_Export object specifying the communication
required.

In:  CombineMode - A Epetra_CombineMode enumerated type specifying how
results should be combined on the receiving processor.

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::DistObject::Export (   self,
  args 
)

Export(self, SrcDistObject A, Import Importer, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int
Export(self, SrcDistObject A, Export Exporter, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int

int
Epetra_DistObject::Export(const Epetra_SrcDistObject &A, const
Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const
Epetra_OffsetIndex *Indexor=0)

Exports an Epetra_DistObject using the Epetra_Export object.

Parameters:
-----------

In:  Source - Distributed object that will be exported to the "\\e
this" multivector.

In:  Exporter - A Epetra_Export object specifying the communication
required.

In:  CombineMode - A Epetra_CombineMode enumerated type specifying how
results should be combined on the receiving processor.

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::DistObject::Import (   self,
  args 
)

Import(self, SrcDistObject A, Import Importer, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int
Import(self, SrcDistObject A, Export Exporter, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int

int
Epetra_DistObject::Import(const Epetra_SrcDistObject &A, const
Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const
Epetra_OffsetIndex *Indexor=0)

Imports an Epetra_DistObject using the Epetra_Export object.

Parameters:
-----------

In:  Source - Distributed object that will be imported into the
"\\e this" object.

In:  Exporter - A Epetra_Export object specifying the communication
required.

In:  CombineMode - A Epetra_CombineMode enumerated type specifying how
results should be combined on the receiving processor.

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::DistObject::Import (   self,
  args 
)

Import(self, SrcDistObject A, Import Importer, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int
Import(self, SrcDistObject A, Export Exporter, Epetra_CombineMode CombineMode, 
    OffsetIndex Indexor = None) -> int

int
Epetra_DistObject::Import(const Epetra_SrcDistObject &A, const
Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const
Epetra_OffsetIndex *Indexor=0)

Imports an Epetra_DistObject using the Epetra_Export object.

Parameters:
-----------

In:  Source - Distributed object that will be imported into the
"\\e this" object.

In:  Exporter - A Epetra_Export object specifying the communication
required.

In:  CombineMode - A Epetra_CombineMode enumerated type specifying how
results should be combined on the receiving processor.

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::DistObject::Map (   self,
  args 
)

Map(self) -> BlockMap

const Epetra_BlockMap&
Epetra_DistObject::Map() const

Returns the address of the Epetra_BlockMap for this multi-vector. 

Reimplemented from PyTrilinos::Epetra::SrcDistObject.

def PyTrilinos::Epetra::DistObject::Map (   self,
  args 
)

Map(self) -> BlockMap

const Epetra_BlockMap&
Epetra_DistObject::Map() const

Returns the address of the Epetra_BlockMap for this multi-vector. 

Reimplemented from PyTrilinos::Epetra::SrcDistObject.


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

Generated on Thu Dec 17 11:00:20 2009 for PyTrilinos by  doxygen 1.5.9