Amesos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Attributes | List of all members
Amesos_Btf Class Reference

Amesos_Btf: Factors and solves a matrix after converting it to block triangular form. More...

#include <Amesos_BTF.h>

Inheritance diagram for Amesos_Btf:
Inheritance graph
[legend]

Private Attributes

bool UseTranspose_
 
const Epetra_LinearProblemProblem_
 
bool PrintTiming_
 
bool PrintStatus_
 
bool ComputeVectorNorms_
 
bool ComputeTrueResidual_
 
int verbose_
 
int debug_
 
double ConTime_
 
double SymTime_
 
double NumTime_
 
double SolTime_
 
double VecTime_
 
double MatTime_
 
int NumSymbolicFact_
 
int NumNumericFact_
 
int NumSolve_
 
Epetra_TimeTime_
 
 Amesos_Btf (const Epetra_LinearProblem &LinearProblem)
 Amesos_Btf Constructor. More...
 
 ~Amesos_Btf (void)
 Amesos_Btf Destructor. More...
 
int SymbolicFactorization ()
 Performs SymbolicFactorization on the matrix A. More...
 
int NumericFactorization ()
 Performs NumericFactorization on the matrix A. More...
 
int Solve ()
 Solves A X = B (or AT X = B) More...
 
const Epetra_LinearProblemGetProblem () const
 Get a pointer to the Problem. More...
 
bool MatrixShapeOK () const
 Returns true if BTF can handle this matrix shape. More...
 
int SetUseTranspose (bool UseTranspose)
 SetUseTranpose(true) causes Solve() To compute A^T X = B. More...
 
bool UseTranspose () const
 Returns the current UseTranspose setting. More...
 
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this matrix. More...
 
int SetParameters (Teuchos::ParameterList &ParameterList)
 Updates internal variables. More...
 
int NumSymbolicFact () const
 Returns the number of symbolic factorizations performed by this object. More...
 
int NumNumericFact () const
 Returns the number of numeric factorizations performed by this object. More...
 
int NumSolve () const
 Returns the number of solves performed by this object. More...
 
void PrintTiming ()
 Print timing information. More...
 
void PrintStatus ()
 Print information about the factorization and solution phases. More...
 

Additional Inherited Members

- Public Member Functions inherited from Amesos_BaseSolver
virtual ~Amesos_BaseSolver ()
 Destructor. More...
 
virtual void PrintStatus () const =0
 Prints status information about the current solver. More...
 
virtual void PrintTiming () const =0
 Prints timing information about the current solver. More...
 
virtual void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 Redefined from Teuchos::ParameterListAcceptor (Does Not Work) More...
 
virtual Teuchos::RCP
< Teuchos::ParameterList
getNonconstParameterList ()
 This is an empty stub. More...
 
virtual Teuchos::RCP
< Teuchos::ParameterList
unsetParameterList ()
 This is an empty stub. More...
 
virtual void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list. (Does Not Work) More...
 
- Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual RCP< const ParameterListgetParameterList () const
 
virtual RCP< const ParameterListgetValidParameters () const
 

Detailed Description

Amesos_Btf: Factors and solves a matrix after converting it to block triangular form.

Amesos_Btf:

Definition at line 62 of file Amesos_BTF.h.

Constructor & Destructor Documentation

Amesos_Btf::Amesos_Btf ( const Epetra_LinearProblem LinearProblem)

Amesos_Btf Constructor.

Creates an Amesos_Btf instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.

Note: The operator in LinearProblem must be an Epetra_RowMatrix.

Amesos_Btf::~Amesos_Btf ( void  )

Amesos_Btf Destructor.

Completely deletes an Amesos_Btf object.

Member Function Documentation

int Amesos_Btf::SymbolicFactorization ( )
virtual

Performs SymbolicFactorization on the matrix A.

  • Compute an ordering which reduces the matrix to block upper triangular form.
  • Determine a task partitioning (static load balancing)
  • Redistribute the data based on the owner computes rule
  • Instantiates an Amesos solver for each of the diagonal blocks
  • Calls SymbolicFactorization() on each of the diagonal blocks
\return Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

int Amesos_Btf::NumericFactorization ( )
virtual

Performs NumericFactorization on the matrix A.

 \return Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

int Amesos_Btf::Solve ( )
virtual

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

Foreach block i:
   For each block j
     Compute x_i -= A_{i,j} x_j 
   Call Solve(x_i,b_i) 
   Broadcast x_i
 \return Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

const Epetra_LinearProblem* Amesos_Btf::GetProblem ( ) const
inlinevirtual

Get a pointer to the Problem.

Implements Amesos_BaseSolver.

Definition at line 130 of file Amesos_BTF.h.

bool Amesos_Btf::MatrixShapeOK ( ) const
virtual

Returns true if BTF can handle this matrix shape.

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

Implements Amesos_BaseSolver.

int Amesos_Btf::SetUseTranspose ( bool  UseTranspose)
inlinevirtual

SetUseTranpose(true) causes Solve() To compute A^T X = B.

Implements Amesos_BaseSolver.

Definition at line 151 of file Amesos_BTF.h.

bool Amesos_Btf::UseTranspose ( ) const
inlinevirtual

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 154 of file Amesos_BTF.h.

const Epetra_Comm& Amesos_Btf::Comm ( ) const
inlinevirtual

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

Implements Amesos_BaseSolver.

Definition at line 157 of file Amesos_BTF.h.

int Amesos_Btf::SetParameters ( Teuchos::ParameterList ParameterList)
virtual

Updates internal variables.

  <br \>Preconditions:<ul>
  <li>None.</li>
  </ul>

  <br \>Postconditions:<ul> 
  <li>Internal variables controlling the factorization and solve will
  be updated and take effect on all subsequent calls to NumericFactorization() 
  and Solve().</li>
  <li>All parameters whose value are to differ from the default values must 

be included in ParameterList. Parameters not specified in ParameterList revert to their default values.

Returns
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

int Amesos_Btf::NumSymbolicFact ( ) const
inlinevirtual

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 179 of file Amesos_BTF.h.

int Amesos_Btf::NumNumericFact ( ) const
inlinevirtual

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 182 of file Amesos_BTF.h.

int Amesos_Btf::NumSolve ( ) const
inlinevirtual

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 185 of file Amesos_BTF.h.

void Amesos_Btf::PrintTiming ( )

Print timing information.

void Amesos_Btf::PrintStatus ( )

Print information about the factorization and solution phases.

Member Data Documentation

bool Amesos_Btf::UseTranspose_
private

Definition at line 196 of file Amesos_BTF.h.

const Epetra_LinearProblem* Amesos_Btf::Problem_
private

Definition at line 197 of file Amesos_BTF.h.

bool Amesos_Btf::PrintTiming_
private

Definition at line 199 of file Amesos_BTF.h.

bool Amesos_Btf::PrintStatus_
private

Definition at line 200 of file Amesos_BTF.h.

bool Amesos_Btf::ComputeVectorNorms_
private

Definition at line 201 of file Amesos_BTF.h.

bool Amesos_Btf::ComputeTrueResidual_
private

Definition at line 202 of file Amesos_BTF.h.

int Amesos_Btf::verbose_
private

Definition at line 204 of file Amesos_BTF.h.

int Amesos_Btf::debug_
private

Definition at line 205 of file Amesos_BTF.h.

double Amesos_Btf::ConTime_
private

Definition at line 208 of file Amesos_BTF.h.

double Amesos_Btf::SymTime_
private

Definition at line 209 of file Amesos_BTF.h.

double Amesos_Btf::NumTime_
private

Definition at line 210 of file Amesos_BTF.h.

double Amesos_Btf::SolTime_
private

Definition at line 211 of file Amesos_BTF.h.

double Amesos_Btf::VecTime_
private

Definition at line 212 of file Amesos_BTF.h.

double Amesos_Btf::MatTime_
private

Definition at line 213 of file Amesos_BTF.h.

int Amesos_Btf::NumSymbolicFact_
private

Definition at line 215 of file Amesos_BTF.h.

int Amesos_Btf::NumNumericFact_
private

Definition at line 216 of file Amesos_BTF.h.

int Amesos_Btf::NumSolve_
private

Definition at line 217 of file Amesos_BTF.h.

Epetra_Time* Amesos_Btf::Time_
private

Definition at line 219 of file Amesos_BTF.h.


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