AztecOO  Development
Macros | Functions
AZOO_iterate.h File Reference

AZOO_iterate: A function built around AztecOO that mimics the Aztec funciton AZ_iterate. More...

#include "Epetra_Comm.h"
#include "Epetra_Map.h"
#include "Epetra_Vector.h"
#include "Epetra_VbrMatrix.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_LinearProblem.h"
#include "AztecOO.h"
#include "Aztec2Petra.h"
Include dependency graph for AZOO_iterate.h:

Functions

void AZOO_iterate (double *xsolve, double *b, int *options, double *params, double *status, int *proc_config, AZ_MATRIX *Amat, AZ_PRECOND *precond, struct AZ_SCALING *scaling)
 Provides essentially equivalent functionality as the AZ_iterate function in Aztec 2.1.
 

Detailed Description

AZOO_iterate: A function built around AztecOO that mimics the Aztec funciton AZ_iterate.

AZOO_iterate is intended to facilitate the smooth transition from Aztec to Trilinos/AztecOO.
The AZOO_iterate interface is essentially identical to the AZ_iterate interface and should be,
for most uses a simple replacement in functionality.  

However, because AztecOO uses Petra for
distributed matrix and vector services (instead of AZ_MATRIX as defined by Aztec), there will 
be some differences.  Some known differences are:

<ol>
<li> AZOO_iterate does not support Aztec's matrix-free version of AZ_MATRIX at this time.  
     Note that AztecOO has its own version of matrix-free implementation via the pure virtual
 class Epetra_RowMatrix.
<li> Scaling is performed independently in AztecOO.  All of the Aztec scaling options 
     (options[AZ_scaling]) are recognized, but block Jacobi scaling is implemented as point
 Jacobi scaling.
<li> Block entry preconditioners are not supported in AztecOO.  This functionality will be
     provided by IFPACK in a future release.

</ol>
Warning
{This function is intended as a temporary bridge for users migrating from Aztec to Trilinos/AztecOO. As such, it is not optimal in terms of memory use. Further flexibility can be had by copying AZOO_iterate() and customizing it to your own needs. Ultimately, users will be best served by making a complete transition to the Trilinos/AztecOO framework, building problems using Petra classes. }
AztecOO_StatusTestMaxIters::CheckStatus
AztecOO_StatusType CheckStatus(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Check convergence status: Unconverged, Converged, Failed.
Definition: AztecOO_StatusTestMaxIters.cpp:55
AztecOOConditionNumber::CG_
CG for symmetric matrices.
Definition: AztecOO_ConditionNumber.h:63
AztecOO_StatusTestResNorm::ResetTolerance
int ResetTolerance(double Tolerance)
Reset the value of the tolerance.
Definition: AztecOO_StatusTestResNorm.h:174
Unchecked
Definition: AztecOO_StatusType.h:58
AztecOO::GetAllAztecOptions
const int * GetAllAztecOptions() const
AztecOO option setting function.
Definition: AztecOO.h:475
AztecOO_StatusTestResNorm::GetMaxNumExtraIterations
int GetMaxNumExtraIterations()
Definition: AztecOO_StatusTestResNorm.h:189
AztecOO_StatusTestCombo::SeqOp
void SeqOp(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Use this for checkStatus when this is a sequential AND type combo. Updates status.
Definition: AztecOO_StatusTestCombo.cpp:197
AZ_CONVERGE_STRUCT
Definition: az_aztec.h:293
AztecOO_StatusTest::GetStatus
virtual AztecOO_StatusType GetStatus() const =0
Return the result of the most recent checkStatus call.
AztecOO::GetAztecOption
int GetAztecOption(int option)
AztecOO option getting function.
Definition: AztecOO.h:460
AztecOO::SetUserMatrix
int SetUserMatrix(Epetra_RowMatrix *UserMatrix, bool call_SetPrecMatrix=false)
AztecOO User Matrix Set.
Definition: AztecOO.cpp:474
AztecOO_StatusTestResNorm
AztecOO_StatusTestResNorm: An implementation of AztecOO_StatusTest using a family of residual norms.
Definition: AztecOO_StatusTestResNorm.h:76
Epetra_MsrMatrix::NumGlobalRows64
long long NumGlobalRows64() const
Returns the number of global matrix rows.
Definition: Epetra_MsrMatrix.h:260
Epetra_MsrMatrix::Amat
AZ_MATRIX * Amat() const
Returns a pointer to the Aztec Msr matrix used to create this object.
Definition: Epetra_MsrMatrix.h:224
AztecOO::SetAztecDefaults
int SetAztecDefaults()
AztecOO function to restore default options/parameter settings.
Definition: AztecOO.cpp:351
aztec_choices
Definition: az_aztec.h:326
AztecOO::SetOutputStream
void SetOutputStream(std::ostream &ostrm)
Set std::ostream for Aztec's screen output.
Definition: AztecOO.cpp:510
AztecOO::GetPrecMatrix
Epetra_RowMatrix * GetPrecMatrix() const
Get a pointer to the matrix used to construct the preconditioner.
Definition: AztecOO.h:369
Epetra_MsrMatrix::Label
const char * Label() const
Returns a character std::string describing the operator.
Definition: Epetra_MsrMatrix.h:314
AztecOO_Operator::NormInf
double NormInf() const
Returns the infinity norm of the global matrix.
Definition: AztecOO_Operator.h:128
AztecOO::SolveTime
double SolveTime() const
Returns the solve time.
Definition: AztecOO.h:587
AztecOO::SetLabel
void SetLabel(const char *const Label)
Set Label this AztecOO object.
Definition: AztecOO.cpp:1418
Epetra_MsrMatrix::Multiply
int Multiply(bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_MsrMatrix multiplied by a Epetra_MultiVector X in Y.
Definition: Epetra_MsrMatrix.cpp:159
AztecOO_StatusTest::Print
virtual std::ostream & Print(std::ostream &stream, int indent=0) const =0
Output formatted description of stopping test to output stream.
inlist
Definition: az_c_reorder.c:146
Aztec2Petra
int Aztec2Petra(int *proc_config, AZ_MATRIX *Amat, double *az_x, double *az_b, Epetra_Comm *&comm, Epetra_BlockMap *&map, Epetra_RowMatrix *&A, Epetra_Vector *&x, Epetra_Vector *&b, int **global_indices)
Converts from an Aztec linear problem to a Petra linear problem.
Definition: Aztec2Petra.cpp:48
context
Definition: az_aztec.h:330
AztecOOConditionNumber::freeMemory
void freeMemory()
Frees all memory allocated with new by this object.
Definition: AztecOO_ConditionNumber.cpp:127
AztecOO_StatusTestMaxIters::GetStatus
AztecOO_StatusType GetStatus() const
Return the result of the most recent checkStatus call.
Definition: AztecOO_StatusTestMaxIters.h:95
Epetra_MsrMatrix::InvColSums
int InvColSums(Epetra_Vector &x) const
Computes the sum of absolute values of the columns of the Epetra_MsrMatrix, results returned in x.
Definition: Epetra_MsrMatrix.cpp:261
Epetra_MsrMatrix::LowerTriangular
bool LowerTriangular() const
If matrix is lower triangular, this query returns true, otherwise it returns false.
Definition: Epetra_MsrMatrix.h:213
AztecOOConditionNumber::initialize
void initialize(const Epetra_Operator &op, SolverType solverType=GMRES_, int krylovSubspaceSize=100, bool printSolve=false)
Initialization.
Definition: AztecOO_ConditionNumber.cpp:71
Epetra_MsrMatrix::RightScale
int RightScale(const Epetra_Vector &x)
Scales the Epetra_MsrMatrix on the right with a Epetra_Vector x.
Definition: Epetra_MsrMatrix.cpp:340
Epetra_MsrMatrix::~Epetra_MsrMatrix
virtual ~Epetra_MsrMatrix()
Epetra_MsrMatrix Destructor.
Definition: Epetra_MsrMatrix.cpp:122
AztecOO_Operator::ApplyInverse
int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a AztecOO_Operator inverse applied to an Epetra_MultiVector X in Y.
Definition: AztecOO_Operator.cpp:61
Epetra_MsrMatrix::Print
virtual void Print(std::ostream &os) const
Print method.
Definition: Epetra_MsrMatrix.cpp:430
AztecOO::AdaptiveIterate
int AdaptiveIterate(int MaxIters, int MaxSolveAttempts, double Tolerance)
Attempts to solve the given linear problem using an adaptive strategy.
Definition: AztecOO.cpp:1051
az_ostream_out
Definition: AZOO_printf.cpp:56
AztecOO_StatusTestResNorm::GetStatus
AztecOO_StatusType GetStatus() const
Return the result of the most recent checkStatus call.
Definition: AztecOO_StatusTestResNorm.h:222
AztecOO_StatusTestCombo::ComboType
ComboType
The test can be either the AND of all the component tests, or the OR of all the component tests,...
Definition: AztecOO_StatusTestCombo.h:93
doublecomplex
Definition: az_c_reorder.c:67
AztecOO_StatusTestCombo::Print
std::ostream & Print(std::ostream &stream, int indent=0) const
Output formatted description of stopping test to output stream.
Definition: AztecOO_StatusTestCombo.cpp:222
Namelist
Definition: az_c_reorder.c:200
Epetra_MsrMatrix::UpperTriangular
bool UpperTriangular() const
If matrix is upper triangular, this query returns true, otherwise it returns false.
Definition: Epetra_MsrMatrix.h:216
AztecOO::~AztecOO
virtual ~AztecOO(void)
AztecOO Destructor.
Definition: AztecOO.cpp:179
submat_struct
Definition: az_matrix_util.c:1246
AztecOO_StatusTestResNorm::NormOfRHS
Definition: AztecOO_StatusTestResNorm.h:101
AztecOO_StatusTestResNorm::GetTolerance
double GetTolerance() const
Returns the value of the tolerance, , set in the constructor.
Definition: AztecOO_StatusTestResNorm.h:236
Epetra_MsrMatrix::Solve
int Solve(bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_MsrMatrix multiplied by a Epetra_MultiVector X in Y.
Definition: Epetra_MsrMatrix.cpp:190
AztecOO_Operator::HasNormInf
bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Definition: AztecOO_Operator.h:149
cilist
Definition: az_c_reorder.c:101
AztecOO::SetAllAztecParams
int SetAllAztecParams(const double *params)
AztecOO param setting function.
Definition: AztecOO.h:493
AztecOO::SetPrecOperator
int SetPrecOperator(Epetra_Operator *PrecOperator)
AztecOO External Preconditioner Set.
Definition: AztecOO.cpp:565
AztecOO_StatusTestResNorm::NormType
NormType
Select the norm type, where is the norm argument and is an optionally defined weighting vector.
Definition: AztecOO_StatusTestResNorm.h:94
Epetra_MsrMatrix::OperatorRangeMap
const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this operator (same as domain).
Definition: Epetra_MsrMatrix.h:284
AztecOO::SetStatusTest
int SetStatusTest(AztecOO_StatusTest *StatusTest)
AztecOO External Convergence/Status Test Set.
Definition: AztecOO.cpp:597
AztecOO_StatusTestCombo::IsSafe
bool IsSafe(AztecOO_StatusTest &a)
Definition: AztecOO_StatusTestCombo.cpp:84
Epetra_MsrMatrix::NumMyRowEntries
int NumMyRowEntries(int MyRow, int &NumEntries) const
Return the current number of values stored for the specified local row.
Definition: Epetra_MsrMatrix.cpp:142
AztecOO::NumIters
int NumIters() const
Returns the total number of iterations performed on this problem.
Definition: AztecOO.h:575
AztecOO_StatusTestMaxIters::AztecOO_StatusTestMaxIters
AztecOO_StatusTestMaxIters(int MaxIters)
Constructor.
Definition: AztecOO_StatusTestMaxIters.cpp:45
AZ_MATRIX_STRUCT
Definition: az_aztec.h:115
AztecOO_StatusTestResNorm::GetResNormValue
double GetResNormValue() const
Returns the residual norm value, , computed in most recent call to CheckStatus.
Definition: AztecOO_StatusTestResNorm.h:242
AztecOO_StatusTestResNorm::OneNorm
Definition: AztecOO_StatusTestResNorm.h:94
Epetra_MsrMatrix::LeftScale
int LeftScale(const Epetra_Vector &x)
Scales the Epetra_MsrMatrix on the left with a Epetra_Vector x.
Definition: Epetra_MsrMatrix.cpp:311
AztecOO_StatusTestCombo::AztecOO_StatusTestCombo
AztecOO_StatusTestCombo(ComboType t)
Constructor.
Definition: AztecOO_StatusTestCombo.cpp:45
AztecOOConditionNumber::conditionNumber_
double conditionNumber_
Condition number calculated in computeConditionNumber.
Definition: AztecOO_ConditionNumber.h:94
AztecOOConditionNumber::computeConditionNumber
int computeConditionNumber(int maxIters, double tol)
Estimates the condition number.
Definition: AztecOO_ConditionNumber.cpp:111
AztecOO::ConstructPreconditioner
int ConstructPreconditioner(double &condest)
Forces explicit construction and retention of an AztecOO native preconditioner.
Definition: AztecOO.cpp:753
AztecOO_StatusTestResNorm::Explicit
Definition: AztecOO_StatusTestResNorm.h:85
AztecOO_StatusType.h
AztecOO StatusType: Used to return convergence status information for AztecOO_StatusTest objects.
AztecOO_StatusTestCombo::~AztecOO_StatusTestCombo
virtual ~AztecOO_StatusTestCombo()
Destructor.
Definition: AztecOO_StatusTestCombo.h:114
AztecOO::SetAztecOption
int SetAztecOption(int option, int value)
AztecOO option setting function.
Definition: AztecOO.h:451
Epetra_MsrMatrix::UseTranspose
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: Epetra_MsrMatrix.h:366
AztecOO_StatusTestResNorm::SetMaxNumExtraIterations
int SetMaxNumExtraIterations(int maxNumExtraIterations)
Set the maximum number of extra iterations that will be performed in case the implicit residual succe...
Definition: AztecOO_StatusTestResNorm.h:184
AztecOO_StatusTestCombo::ResidualVectorRequired
bool ResidualVectorRequired() const
Indicates if residual vector is required by this convergence test.
Definition: AztecOO_StatusTestCombo.cpp:104
AztecOOConditionNumber::GMRES_
GMRES for nonsymmetric.
Definition: AztecOO_ConditionNumber.h:65
AztecOO_StatusTestResNorm::GetScaledNormValue
double GetScaledNormValue() const
Returns the scaled norm value, .
Definition: AztecOO_StatusTestResNorm.h:245
Epetra_MsrMatrix::ApplyInverse
int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.
Definition: Epetra_MsrMatrix.h:358
AztecOO_StatusTestMaxIters::GetNumIters
int GetNumIters() const
Returns the current number of iterations from the most recent StatusTest call.
Definition: AztecOO_StatusTestMaxIters.h:106
AztecOO::PrintLinearSystem
void PrintLinearSystem(const char *name)
Print linear-system to files.
Definition: AztecOO.cpp:1297
AztecOO_StatusTestCombo
AztecOO_StatusTestCombo: A class for extending the status testing capabilities of AztecOO via logical...
Definition: AztecOO_StatusTestCombo.h:84
AztecOO::SetErrorStream
void SetErrorStream(std::ostream &errstrm)
Set std::ostream for Aztec's error output.
Definition: AztecOO.cpp:517
AztecOO_StatusTestCombo::SEQ
Definition: AztecOO_StatusTestCombo.h:95
AztecOOConditionNumber
Condition number estimator using AztecOO.
Definition: AztecOO_ConditionNumber.h:56
AztecOO_Operator::OperatorDomainMap
const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_BlockMap object associated with the domain of this matrix operator.
Definition: AztecOO_Operator.h:155
AztecOO::AztecOO
AztecOO()
AztecOO Default constructor.
Definition: AztecOO.cpp:146
AztecOOConditionNumber::~AztecOOConditionNumber
~AztecOOConditionNumber()
Destructor.
Definition: AztecOO_ConditionNumber.cpp:64
Multitype
Definition: az_c_reorder.c:177
AztecOO::GetPrecOperator
Epetra_Operator * GetPrecOperator() const
Get a pointer to the preconditioner operator.
Definition: AztecOO.h:365
AztecOO_StatusTestResNorm::Print
std::ostream & Print(std::ostream &stream, int indent=0) const
Output formatted description of stopping test to output stream.
Definition: AztecOO_StatusTestResNorm.cpp:234
AZ_PREC_STRUCT
Definition: az_aztec.h:234
Epetra_MsrMatrix::OperatorDomainMap
const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this operator.
Definition: Epetra_MsrMatrix.h:281
Epetra_MsrMatrix::RowMatrixRowMap
const Epetra_Map & RowMatrixRowMap() const
Returns the Row Map object needed for implementing Epetra_RowMatrix.
Definition: Epetra_MsrMatrix.h:290
AztecOO_StatusTestMaxIters::Print
std::ostream & Print(std::ostream &stream, int indent=0) const
Output formatted description of stopping test to output stream.
Definition: AztecOO_StatusTestMaxIters.cpp:71
AztecOO_StatusTestCombo::AND
Definition: AztecOO_StatusTestCombo.h:93
AztecOO_StatusTestCombo::AndOp
void AndOp(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Use this for checkStatus when this is an AND type combo. Updates status.
Definition: AztecOO_StatusTestCombo.cpp:164
AztecOO::SetAztecParam
int SetAztecParam(int param, double value)
AztecOO param setting function.
Definition: AztecOO.h:469
Epetra_MsrMatrix::HasNormInf
virtual bool HasNormInf() const
Returns true because this class can compute an Inf-norm.
Definition: Epetra_MsrMatrix.h:363
AztecOOConditionNumber::solver_
AztecOO * solver_
solver object.
Definition: AztecOO_ConditionNumber.h:112
AztecOO_StatusType
AztecOO_StatusType
Definition: AztecOO_StatusType.h:58
Vardesc
Definition: az_c_reorder.c:192
cllist
Definition: az_c_reorder.c:133
AztecOO::GetUserOperator
Epetra_Operator * GetUserOperator() const
Get a pointer to the user operator A.
Definition: AztecOO.h:357
Epetra_MsrMatrix::InvRowSums
int InvRowSums(Epetra_Vector &x) const
Computes the sum of absolute values of the rows of the Epetra_MsrMatrix, results returned in x.
Definition: Epetra_MsrMatrix.cpp:233
AztecOO::SetProblem
int SetProblem(const Epetra_LinearProblem &prob, bool call_SetPrecMatrix=false)
AztecOO Epetra_LinearProblem Set.
Definition: AztecOO.cpp:400
AztecOO_Operator::~AztecOO_Operator
~AztecOO_Operator()
Destructor.
Definition: AztecOO_Operator.cpp:58
AztecOO::MatrixData
Definition: AztecOO.h:598
AztecOO_StatusTestCombo::GetStatus
AztecOO_StatusType GetStatus() const
Return the result of the most recent checkStatus call.
Definition: AztecOO_StatusTestCombo.h:146
alist
Definition: az_c_reorder.c:140
AztecOO::SetMatrixName
int SetMatrixName(int label)
AztecOO Label Matrix for Aztec.
Definition: AztecOO.cpp:804
AztecOOConditionNumber::getConditionNumber
double getConditionNumber()
Return condition number computed by last call to computeConditionNumber.
Definition: AztecOO_ConditionNumber.cpp:121
Epetra_MsrMatrix::ExtractMyRowCopy
int ExtractMyRowCopy(int MyRow, int Length, int &NumEntries, double *Values, int *Indices) const
Returns a copy of the specified local row in user-provided arrays.
Definition: Epetra_MsrMatrix.cpp:133
AztecOO_Operator::Comm
const Epetra_Comm & Comm() const
Returns a pointer to the Epetra_Comm communicator associated with this operator.
Definition: AztecOO_Operator.h:152
AztecOO_Operator::SetUseTranspose
int SetUseTranspose(bool use_transpose)
If set true, transpose of this operator will be applied.
Definition: AztecOO_Operator.h:89
AztecOO_StatusTestMaxIters::ResidualVectorRequired
bool ResidualVectorRequired() const
Indicates if residual vector is required by this convergence test: returns false for this class.
Definition: AztecOO_StatusTestMaxIters.h:74
AztecOO_StatusTestResNorm::TwoNorm
Definition: AztecOO_StatusTestResNorm.h:95
AztecOO_StatusTestCombo::OrOp
void OrOp(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Use this for checkStatus when this is an OR type combo. Updates status.
Definition: AztecOO_StatusTestCombo.cpp:138
Epetra_MsrMatrix::NumMyNonzeros
int NumMyNonzeros() const
Returns the number of nonzero entries in the calling processor's portion of the matrix.
Definition: Epetra_MsrMatrix.h:269
Epetra_MsrMatrix::NumGlobalDiagonals64
long long NumGlobalDiagonals64() const
Returns the number of global nonzero diagonal entries.
Definition: Epetra_MsrMatrix.h:266
AztecOO::GetAllAztecParams
const double * GetAllAztecParams() const
AztecOO param setting function.
Definition: AztecOO.h:481
AztecOO_StatusTest::AztecOO_StatusTest
AztecOO_StatusTest()
Constructor.
Definition: AztecOO_StatusTest.h:70
Epetra_MsrMatrix::SetUseTranspose
int SetUseTranspose(bool use_transpose)
If set true, transpose of this operator will be applied.
Definition: Epetra_MsrMatrix.h:326
AztecOO_StatusTestCombo::OR
Definition: AztecOO_StatusTestCombo.h:94
AztecOO_Operator::Label
const char * Label() const
Returns a character string describing the operator.
Definition: AztecOO_Operator.h:134
AztecOO::GetProblem
Epetra_LinearProblem * GetProblem() const
Get a pointer to the Linear Problem used to construct this solver; returns zero if not available.
Definition: AztecOO.h:355
PartialFailed
Definition: AztecOO_StatusType.h:63
AztecOO::SetLHS
int SetLHS(Epetra_MultiVector *X)
AztecOO LHS Set.
Definition: AztecOO.cpp:621
AZOO_iterate.h
AZOO_iterate: A function built around AztecOO that mimics the Aztec funciton AZ_iterate.
AztecOO_StatusTestCombo::AddStatusTest
AztecOO_StatusTestCombo & AddStatusTest(AztecOO_StatusTest &a)
Add another test to this combination.
Definition: AztecOO_StatusTestCombo.cpp:66
Epetra_MsrMatrix::Map
const Epetra_BlockMap & Map() const
Implement the Epetra_SrcDistObjec::Map() function.
Definition: Epetra_MsrMatrix.h:287
Epetra_MsrMatrix::Epetra_MsrMatrix
Epetra_MsrMatrix(int *proc_config, AZ_MATRIX *Amat)
Epetra_MsrMatrix constuctor using existing Aztec DMSR matrix.
Definition: Epetra_MsrMatrix.cpp:52
AztecOO_StatusTest
AztecOO_StatusTest: A pure virtual class for extending the status testing capabilities of AztecOO.
Definition: AztecOO_StatusTest.h:64
Epetra_MsrMatrix::NormInf
double NormInf() const
Returns the infinity norm of the global matrix.
Definition: Epetra_MsrMatrix.cpp:380
AztecOO_StatusTestMaxIters
AztecOO_StatusTestMaxIters: An AztecOO_StatusTest class specifying a maximum number of iterations.
Definition: AztecOO_StatusTestMaxIters.h:59
AztecOO::ScaledResidual
double ScaledResidual() const
Returns the true scaled residual for this problem.
Definition: AztecOO.h:581
AztecOOConditionNumber::AztecOOConditionNumber
AztecOOConditionNumber()
Constructor.
Definition: AztecOO_ConditionNumber.cpp:50
AztecOO::GetUserMatrix
Epetra_RowMatrix * GetUserMatrix() const
Get a pointer to the user matrix A.
Definition: AztecOO.h:361
AZOO_iterate
void AZOO_iterate(double *xsolve, double *b, int *options, double *params, double *status, int *proc_config, AZ_MATRIX *Amat, AZ_PRECOND *precond, struct AZ_SCALING *scaling)
Provides essentially equivalent functionality as the AZ_iterate function in Aztec 2....
Definition: AZOO_iterate.cpp:49
AztecOO_StatusTest::ResidualVectorRequired
virtual bool ResidualVectorRequired() const =0
Indicates if residual vector is required by this convergence test.
AztecOO_Operator::AztecOO_Operator
AztecOO_Operator(AztecOO *solver, int NumIters, double Tol=0.0)
Uses an AztecOO instance to implement the Epetra_Operator interface.
Definition: AztecOO_Operator.cpp:49
AztecOO::Iterate
int Iterate(long long MaxIters, double Tolerance)
AztecOO iteration function.
Definition: AztecOO.cpp:898
AztecOO_StatusTestResNorm::InfNorm
Definition: AztecOO_StatusTestResNorm.h:96
AztecOO_StatusTestResNorm::None
Definition: AztecOO_StatusTestResNorm.h:103
AztecOOConditionNumber::printSolve_
bool printSolve_
Conditional for printing solve to output.
Definition: AztecOO_ConditionNumber.h:115
AztecOO_StatusTestResNorm::ScaleType
ScaleType
Select the scale type.
Definition: AztecOO_StatusTestResNorm.h:101
AztecOO_StatusTestResNorm::ResType
ResType
Select how the residual vector is produced.
Definition: AztecOO_StatusTestResNorm.h:84
blockmat_struct
Definition: az_matrix_util.c:1429
AztecOO_StatusTestCombo::CheckStatus
AztecOO_StatusType CheckStatus(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Check convergence status: Unconverged, Converged, Failed.
Definition: AztecOO_StatusTestCombo.cpp:121
AztecOO_Operator::UseTranspose
bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: AztecOO_Operator.h:146
AztecOO::DestroyPreconditioner
int DestroyPreconditioner()
Destroys a preconditioner computed using ConstructPreconditioner().
Definition: AztecOO.cpp:794
AztecOO_StatusTestResNorm::GetTestValue
double GetTestValue() const
Returns the test value, , computed in most recent call to CheckStatus.
Definition: AztecOO_StatusTestResNorm.h:239
AztecOO_StatusTest::~AztecOO_StatusTest
virtual ~AztecOO_StatusTest()
Destructor.
Definition: AztecOO_StatusTest.h:73
AztecOO_StatusTestResNorm::DefineScaleForm
int DefineScaleForm(ScaleType TypeOfScaling, NormType TypeOfNorm, Epetra_Vector *Weights=0, double ScaleValue=1.0)
Define form of the scaling, its norm, its optional weighting vector, or, alternatively,...
Definition: AztecOO_StatusTestResNorm.cpp:101
AztecOO::GetAllAztecStatus
int GetAllAztecStatus(double *status)
AztecOO status extraction function.
Definition: AztecOO.h:593
AztecOO::SetRHS
int SetRHS(Epetra_MultiVector *B)
AztecOO RHS Set.
Definition: AztecOO.cpp:630
AztecOO_Operator
AztecOO_Operator: An implementation of the Epetra_Operator class.
Definition: AztecOO_Operator.h:60
Epetra_MsrMatrix
Epetra_MsrMatrix: A class for constructing and using real-valued double-precision sparse compressed r...
Definition: Epetra_MsrMatrix.h:72
AztecOO::RecursiveResidual
double RecursiveResidual() const
Returns the recursive residual for this problem.
Definition: AztecOO.h:584
Epetra_MsrMatrix::NumGlobalNonzeros
int NumGlobalNonzeros() const
Returns the number of nonzero entries in the global matrix.
Definition: Epetra_MsrMatrix.h:240
icilist
Definition: az_c_reorder.c:110
AztecOO_StatusTestResNorm::ResetStatus
void ResetStatus()
Reset state of status test object.
Definition: AztecOO_StatusTestResNorm.h:230
AztecOOConditionNumber::rangeMap_
Epetra_Map * rangeMap_
Map to create right hand side vector.
Definition: AztecOO_ConditionNumber.h:100
Epetra_MsrMatrix::Filled
bool Filled() const
If FillComplete() has been called, this query returns true, otherwise it returns false.
Definition: Epetra_MsrMatrix.h:210
AztecOOConditionNumber::rhs_
Epetra_Vector * rhs_
RHS vector. This is initializaed to a random vector.
Definition: AztecOO_ConditionNumber.h:106
AztecOOConditionNumber::dummy_
Epetra_Vector * dummy_
Dummy vector. Initializaed to zero.
Definition: AztecOO_ConditionNumber.h:109
AztecOO_StatusTestMaxIters::~AztecOO_StatusTestMaxIters
virtual ~AztecOO_StatusTestMaxIters()
Destructor.
Definition: AztecOO_StatusTestMaxIters.h:68
Epetra_MsrMatrix::NumMyCols
int NumMyCols() const
Returns the number of matrix columns owned by the calling processor.
Definition: Epetra_MsrMatrix.h:275
AztecOO::recursiveIterate
int recursiveIterate(int MaxIters, double Tolerance)
AztecOO iteration functions.
Definition: AztecOO.cpp:813
AztecOO_StatusTestCombo::GetComboType
ComboType GetComboType() const
Returns the maximum number of iterations set in the constructor.
Definition: AztecOO_StatusTestCombo.h:155
AztecOO_StatusTestResNorm::UserProvided
Definition: AztecOO_StatusTestResNorm.h:104
AztecOO::SetUserOperator
int SetUserOperator(Epetra_Operator *UserOperator)
AztecOO User Operator Set.
Definition: AztecOO.cpp:439
AztecOO_Operator::OperatorRangeMap
const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_BlockMap object associated with the range of this matrix operator.
Definition: AztecOO_Operator.h:162
AztecOO::SetAllAztecOptions
int SetAllAztecOptions(const int *options)
AztecOO option setting function.
Definition: AztecOO.h:487
Aztec2Petra.h
Aztec2Petra: A function that converts an Aztec linear problem to a Petra linear problem.
AztecOO_StatusTestResNorm::CheckStatus
AztecOO_StatusType CheckStatus(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
Check convergence status: Unconverged, Converged, Failed.
Definition: AztecOO_StatusTestResNorm.cpp:126
AztecOO_StatusTestResNorm::AztecOO_StatusTestResNorm
AztecOO_StatusTestResNorm(const Epetra_Operator &Operator, const Epetra_Vector &LHS, const Epetra_Vector &RHS, double Tolerance)
Constructor.
Definition: AztecOO_StatusTestResNorm.cpp:48
Epetra_MsrMatrix::NumMyRows
int NumMyRows() const
Returns the number of matrix rows owned by the calling processor.
Definition: Epetra_MsrMatrix.h:272
AztecOO::OperatorData
Definition: AztecOO.h:613
Epetra_MsrMatrix::ExtractDiagonalCopy
int ExtractDiagonalCopy(Epetra_Vector &Diagonal) const
Returns a copy of the main diagonal in a user-provided vector.
Definition: Epetra_MsrMatrix.cpp:152
NaN
Definition: AztecOO_StatusType.h:62
Unconverged
Definition: AztecOO_StatusType.h:59
Epetra_MsrMatrix::Comm
const Epetra_Comm & Comm() const
Returns a pointer to the Epetra_Comm communicator associated with this matrix.
Definition: Epetra_MsrMatrix.h:299
Epetra_MsrMatrix::NumGlobalNonzeros64
long long NumGlobalNonzeros64() const
Returns the number of nonzero entries in the global matrix.
Definition: Epetra_MsrMatrix.h:257
AztecOO::SetUseAdaptiveDefaultsTrue
int SetUseAdaptiveDefaultsTrue()
Force the AdaptiveIterate() method to use default adaptive strategy.
Definition: AztecOO.h:533
az_ostream_err
Definition: AZOO_printf.cpp:90
Epetra_MsrMatrix::NumGlobalDiagonals
int NumGlobalDiagonals() const
Returns the number of global nonzero diagonal entries.
Definition: Epetra_MsrMatrix.h:253
AztecOO
AztecOO: An object-oriented wrapper for Aztec.
Definition: AztecOO.h:84
AztecOO_StatusTestResNorm::~AztecOO_StatusTestResNorm
virtual ~AztecOO_StatusTestResNorm()
Destructor.
Definition: AztecOO_StatusTestResNorm.cpp:78
AztecOO::SetPrecMatrix
int SetPrecMatrix(Epetra_RowMatrix *PrecMatrix)
AztecOO Preconditioner Matrix Set.
Definition: AztecOO.cpp:524
AztecOO_StatusTestResNorm::DefineResForm
int DefineResForm(ResType TypeOfResidual, NormType TypeOfNorm, Epetra_Vector *Weights=0)
Define form of the residual, its norm and optional weighting vector.
Definition: AztecOO_StatusTestResNorm.cpp:83
Failed
Definition: AztecOO_StatusType.h:61
AztecOO::SetAdaptiveParams
int SetAdaptiveParams(int NumTrials, double *athresholds, double *rthresholds, double condestThreshold, double maxFill, int maxKspace)
Set the parameter that control the AdaptiveIterate() method.
Definition: AztecOO.cpp:1031
Epetra_MsrMatrix::MaxNumEntries
int MaxNumEntries() const
Returns the maximum of NumMyRowEntries() over all rows.
Definition: Epetra_MsrMatrix.cpp:204
AztecOO_Operator::Tol
double Tol() const
Returns the tolerance this will be used by the AztecOO solver.
Definition: AztecOO_Operator.h:143
AztecOO::TrueResidual
double TrueResidual() const
Returns the true unscaled residual for this problem.
Definition: AztecOO.h:578
AztecOO::GetRHS
Epetra_MultiVector * GetRHS() const
Get a pointer to the right-hand-side B.
Definition: AztecOO.h:375
AztecOO_Operator::NumIters
int NumIters() const
Returns the number of iterations that will be performed with the AztecOO solver.
Definition: AztecOO_Operator.h:140
Epetra_MsrMatrix::NumGlobalCols64
long long NumGlobalCols64() const
Returns the number of global matrix columns.
Definition: Epetra_MsrMatrix.h:263
AztecOOConditionNumber::SolverType
SolverType
Solver type to use.
Definition: AztecOO_ConditionNumber.h:61
AztecOO_StatusTestResNorm::Implicit
Definition: AztecOO_StatusTestResNorm.h:84
AztecOO::GetAztecStatus
const double * GetAztecStatus() const
Return the Aztec status after iterating.
Definition: AztecOO.h:526
AztecOOConditionNumber::operator_
Epetra_Operator * operator_
Operator supplied by user in initialization.
Definition: AztecOO_ConditionNumber.h:103
Epetra_MsrMatrix::NormOne
double NormOne() const
Returns the one norm of the global matrix.
Definition: Epetra_MsrMatrix.cpp:397
AztecOO::SetScaling
int SetScaling(struct AZ_SCALING *Scaling)
AztecOO External Scaling Set.
Definition: AztecOO.h:298
Epetra_MsrMatrix::NumGlobalCols
int NumGlobalCols() const
Returns the number of global matrix columns.
Definition: Epetra_MsrMatrix.h:250
AztecOO::GetLHS
Epetra_MultiVector * GetLHS() const
Get a pointer to the left-hand-side X.
Definition: AztecOO.h:373
AztecOO::Condest
double Condest() const
Returns the condition number estimate for the current preconditioner, if one exists,...
Definition: AztecOO.h:345
Epetra_MsrMatrix::RowMatrixImporter
virtual const Epetra_Import * RowMatrixImporter() const
Returns the Epetra_Import object that contains the import operations for distributed operations.
Definition: Epetra_MsrMatrix.h:296
AztecOO::CheckInput
int CheckInput() const
Prints a summary of solver parameters, performs simple sanity checks.
Definition: AztecOO.h:351
Epetra_MsrMatrix::RowMatrixColMap
const Epetra_Map & RowMatrixColMap() const
Returns the Column Map object needed for implementing Epetra_RowMatrix.
Definition: Epetra_MsrMatrix.h:293
AztecOOConditionNumber::domainMap_
Epetra_Map * domainMap_
Map to create left hand side vector.
Definition: AztecOO_ConditionNumber.h:97
Epetra_MsrMatrix::NumMyDiagonals
int NumMyDiagonals() const
Returns the number of local nonzero diagonal entries.
Definition: Epetra_MsrMatrix.h:278
AztecOO_StatusTest::CheckStatus
virtual AztecOO_StatusType CheckStatus(int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)=0
Check convergence status: Unconverged, Converged, Failed.
AztecOO_StatusTestMaxIters::GetMaxIters
int GetMaxIters() const
Returns the maximum number of iterations set in the constructor.
Definition: AztecOO_StatusTestMaxIters.h:103
AztecOO_StatusTestResNorm::ResidualVectorRequired
bool ResidualVectorRequired() const
Indicates if residual vector is required by this convergence test.
Definition: AztecOO_StatusTestResNorm.cpp:120
AztecOO_Operator::Solver
AztecOO * Solver() const
Returns a pointer to the AztecOO solver object that was used to create this AztecOO_Operator object.
Definition: AztecOO_Operator.h:137
AztecOO::GetLabel
const char * GetLabel() const
Get the label describing this AztecOO object.
Definition: AztecOO.cpp:1414
AztecOO::SetParameters
int SetParameters(Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
Method to set options/parameters using a ParameterList object.
Definition: AztecOO.cpp:309
AztecOO_Operator::Apply
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a AztecOO_Operator applied to a Epetra_MultiVector X in Y.
Definition: AztecOO_Operator.h:107
AztecOO_StatusTestResNorm::NormOfInitRes
Definition: AztecOO_StatusTestResNorm.h:102
AZ_SCALING
Definition: az_aztec.h:357
AztecOO::UnsetLHSRHS
int UnsetLHSRHS()
AztecOO unset LHS and RHS.
Definition: AztecOO.cpp:640
complex
Definition: az_c_reorder.c:66
AztecOO::SetPreconditioner
int SetPreconditioner(AZ_PRECOND *Prec)
AztecOO External Preconditioner Set (object)
Definition: AztecOO.h:286
grid_level
Definition: az_aztec.h:224
Converged
Definition: AztecOO_StatusType.h:60
olist
Definition: az_c_reorder.c:120
Epetra_MsrMatrix::Apply
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
Definition: Epetra_MsrMatrix.h:341
Epetra_MsrMatrix::NumGlobalRows
int NumGlobalRows() const
Returns the number of global matrix rows.
Definition: Epetra_MsrMatrix.h:247