Amesos Package Browser (Single Doxygen Collection) Development
Private Member Functions | Private Attributes
Amesos_CSparse Class Reference

Amesos_CSparse: Interface to the CSparse package. More...

#include <Amesos_CSparse.h>

Inheritance diagram for Amesos_CSparse:
Inheritance graph
[legend]

List of all members.

Private Member Functions

int CheckError (const int error) const
const Epetra_MapMap () const
const Epetra_RowMatrixMatrix () const
Epetra_MapSerialMap ()
Epetra_RowMatrixSerialMatrix ()
Epetra_CrsMatrixSerialCrsMatrix ()
Epetra_ImportImporter ()
int ConvertToSerial ()
int ConvertToCSparse ()
int PerformSymbolicFactorization ()
int PerformNumericFactorization ()

Private Attributes

Teuchos::RCP< Epetra_MapSerialMap_
Teuchos::RCP< Epetra_CrsMatrixSerialCrsMatrix_
Teuchos::RCP< Epetra_RowMatrixSerialMatrix_
Teuchos::RCP< Epetra_ImportImporter_
Teuchos::RCP
< Amesos_StandardIndex
StdIndex_
Teuchos::RCP
< Amesos_StandardIndex
StdIndexRange_
Teuchos::RCP
< Amesos_StandardIndex
StdIndexDomain_
const Epetra_MapMap_
const Epetra_RowMatrixMatrix_
bool UseTranspose_
 If true, the transpose of A is used.
const Epetra_LinearProblemProblem_
 Pointer to the linear system problem.
int MtxConvTime_
 Quick access pointers to the internal timing data.
int MtxRedistTime_
int VecRedistTime_
int SymFactTime_
int NumFactTime_
int SolveTime_
cs csMatrix
cs * csTranMatrix
css * csSymbolic
csn * csNumeric
 Amesos_CSparse (const Epetra_LinearProblem &LinearProblem)
 Constructor.
 ~Amesos_CSparse ()
 Destructor.
int SymbolicFactorization ()
 Performs SymbolicFactorization on the matrix A.
int NumericFactorization ()
 Performs NumericFactorization on the matrix A.
int Solve ()
 Solves A X = B (or AT X = B)
const Epetra_LinearProblemGetProblem () const
 Get a pointer to the Problem.
bool MatrixShapeOK () const
 Returns true if CSparse can handle this matrix shape.
int SetUseTranspose (bool UseTranspose)
 SetUseTranpose()
bool UseTranspose () const
 Returns the current UseTranspose setting.
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this matrix.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Set parameters from the input parameters list, returns 0 if successful.
int NumSymbolicFact () const
 Returns the number of symbolic factorizations performed by this object.
int NumNumericFact () const
 Returns the number of numeric factorizations performed by this object.
int NumSolve () const
 Returns the number of solves performed by this object.
void PrintTiming () const
 Prints timing information.
void PrintStatus () const
 Prints information about the factorization and solution phases.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.

Detailed Description

Amesos_CSparse: Interface to the CSparse package.

Author:
Siva Rajamanickam
Date:
Mar 2012

Definition at line 62 of file Amesos_CSparse.h.


Constructor & Destructor Documentation

Amesos_CSparse::Amesos_CSparse ( const Epetra_LinearProblem LinearProblem)

Constructor.

Definition at line 40 of file Amesos_CSparse.cpp.

Amesos_CSparse::~Amesos_CSparse ( )

Destructor.

Definition at line 54 of file Amesos_CSparse.cpp.


Member Function Documentation

int Amesos_CSparse::SymbolicFactorization ( ) [virtual]

Performs SymbolicFactorization on the matrix A.

Implements Amesos_BaseSolver.

Definition at line 262 of file Amesos_CSparse.cpp.

int Amesos_CSparse::NumericFactorization ( ) [virtual]

Performs NumericFactorization on the matrix A.

Implements Amesos_BaseSolver.

Definition at line 304 of file Amesos_CSparse.cpp.

int Amesos_CSparse::Solve ( void  ) [virtual]

Solves A X = B (or AT X = B)

Implements Amesos_BaseSolver.

Definition at line 325 of file Amesos_CSparse.cpp.

const Epetra_LinearProblem* Amesos_CSparse::GetProblem ( ) const [inline, virtual]

Get a pointer to the Problem.

Implements Amesos_BaseSolver.

Definition at line 94 of file Amesos_CSparse.h.

bool Amesos_CSparse::MatrixShapeOK ( ) const [virtual]

Returns true if CSparse can handle this matrix shape.

Returns true if the matrix shape is one that CSparse can handle. CSparse only works with square matrices.

Implements Amesos_BaseSolver.

Definition at line 249 of file Amesos_CSparse.cpp.

int Amesos_CSparse::SetUseTranspose ( bool  UseTranspose) [inline, virtual]

SetUseTranpose()

If SetUseTranspose() is set to true, $A^T X = B$ is computed.

Implements Amesos_BaseSolver.

Definition at line 107 of file Amesos_CSparse.h.

bool Amesos_CSparse::UseTranspose ( ) const [inline, virtual]

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 110 of file Amesos_CSparse.h.

const Epetra_Comm& Amesos_CSparse::Comm ( ) const [inline, virtual]

Returns a pointer to the Epetra_Comm communicator associated with this matrix.

Implements Amesos_BaseSolver.

Definition at line 113 of file Amesos_CSparse.h.

int Amesos_CSparse::SetParameters ( Teuchos::ParameterList ParameterList) [virtual]

Set parameters from the input parameters list, returns 0 if successful.

Implements Amesos_BaseSolver.

Definition at line 187 of file Amesos_CSparse.cpp.

int Amesos_CSparse::NumSymbolicFact ( ) const [inline, virtual]

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 119 of file Amesos_CSparse.h.

int Amesos_CSparse::NumNumericFact ( ) const [inline, virtual]

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 122 of file Amesos_CSparse.h.

int Amesos_CSparse::NumSolve ( ) const [inline, virtual]

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 125 of file Amesos_CSparse.h.

void Amesos_CSparse::PrintTiming ( ) const [virtual]

Prints timing information.

Implements Amesos_BaseSolver.

Definition at line 445 of file Amesos_CSparse.cpp.

void Amesos_CSparse::PrintStatus ( ) const [virtual]

Prints information about the factorization and solution phases.

Implements Amesos_BaseSolver.

Definition at line 431 of file Amesos_CSparse.cpp.

void Amesos_CSparse::GetTiming ( Teuchos::ParameterList TimingParameterList) const [inline, virtual]

Extracts timing information from the current solver and places it in the parameter list.

Reimplemented from Amesos_BaseSolver.

Definition at line 134 of file Amesos_CSparse.h.

int Amesos_CSparse::CheckError ( const int  error) const [private]

Definition at line 494 of file Amesos_CSparse.cpp.

const Epetra_Map& Amesos_CSparse::Map ( ) const [inline, private]

Definition at line 142 of file Amesos_CSparse.h.

const Epetra_RowMatrix& Amesos_CSparse::Matrix ( ) const [inline, private]

Definition at line 147 of file Amesos_CSparse.h.

Epetra_Map& Amesos_CSparse::SerialMap ( ) [inline, private]

Definition at line 152 of file Amesos_CSparse.h.

Epetra_RowMatrix& Amesos_CSparse::SerialMatrix ( ) [inline, private]

Definition at line 157 of file Amesos_CSparse.h.

Epetra_CrsMatrix& Amesos_CSparse::SerialCrsMatrix ( ) [inline, private]

Definition at line 162 of file Amesos_CSparse.h.

Epetra_Import& Amesos_CSparse::Importer ( ) [inline, private]

Definition at line 167 of file Amesos_CSparse.h.

int Amesos_CSparse::ConvertToSerial ( ) [private]

Definition at line 64 of file Amesos_CSparse.cpp.

int Amesos_CSparse::ConvertToCSparse ( ) [private]

Definition at line 127 of file Amesos_CSparse.cpp.

int Amesos_CSparse::PerformSymbolicFactorization ( ) [private]

Definition at line 207 of file Amesos_CSparse.cpp.

int Amesos_CSparse::PerformNumericFactorization ( ) [private]

Definition at line 230 of file Amesos_CSparse.cpp.


Member Data Documentation

Definition at line 177 of file Amesos_CSparse.h.

Definition at line 178 of file Amesos_CSparse.h.

Definition at line 179 of file Amesos_CSparse.h.

Definition at line 180 of file Amesos_CSparse.h.

Definition at line 181 of file Amesos_CSparse.h.

Definition at line 182 of file Amesos_CSparse.h.

Definition at line 183 of file Amesos_CSparse.h.

const Epetra_Map* Amesos_CSparse::Map_ [private]

Definition at line 185 of file Amesos_CSparse.h.

Definition at line 186 of file Amesos_CSparse.h.

If true, the transpose of A is used.

Definition at line 189 of file Amesos_CSparse.h.

Pointer to the linear system problem.

Definition at line 191 of file Amesos_CSparse.h.

Quick access pointers to the internal timing data.

Definition at line 194 of file Amesos_CSparse.h.

Definition at line 194 of file Amesos_CSparse.h.

Definition at line 194 of file Amesos_CSparse.h.

Definition at line 195 of file Amesos_CSparse.h.

Definition at line 195 of file Amesos_CSparse.h.

Definition at line 195 of file Amesos_CSparse.h.

Definition at line 198 of file Amesos_CSparse.h.

Definition at line 199 of file Amesos_CSparse.h.

Definition at line 200 of file Amesos_CSparse.h.

csn* Amesos_CSparse::csNumeric [private]

Definition at line 201 of file Amesos_CSparse.h.


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