Poster of Linux kernelThe best gift for a Linux geek
AztecLinearSolver

AztecLinearSolver

Section: C Library Functions (3) Updated: Thu Apr 7 2011
Local index Up
 

NAME

AztecLinearSolver -  

SYNOPSIS


#include <trilinos_aztec_linear_solver.h>

Inherits LinearSolver< T >.  

Public Member Functions


AztecLinearSolver ()

~AztecLinearSolver ()

void clear ()

void init ()

std::pair< unsigned int, Real > solve (SparseMatrix< T > &matrix_in, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const double tol, const unsigned int m_its)

std::pair< unsigned int, Real > solve (SparseMatrix< T > &matrix, SparseMatrix< T > &preconditioner, NumericVector< T > &solution, NumericVector< T > &rhs, const double tol, const unsigned int m_its)

std::pair< unsigned int, Real > solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const double tol, const unsigned int m_its)

virtual std::pair< unsigned int, Real > solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const double tol, const unsigned int m_its)

void get_residual_history (std::vector< double > &hist)

Real get_initial_residual ()

virtual void print_converged_reason ()

bool initialized () const

SolverType solver_type () const

void set_solver_type (const SolverType st)

PreconditionerType preconditioner_type () const

void set_preconditioner_type (const PreconditionerType pct)

void attach_preconditioner (Preconditioner< T > *preconditioner)
 

Static Public Member Functions


static AutoPtr< LinearSolver< T > > build (const SolverPackage solver_package=libMesh::default_solver_package())

static std::string get_info ()

static void print_info ()

static unsigned int n_objects ()
 

Public Attributes


bool same_preconditioner
 

Protected Types


typedef std::map< std::string, std::pair< unsigned int, unsigned int > > Counts
 

Protected Member Functions


void increment_constructor_count (const std::string &name)

void increment_destructor_count (const std::string &name)
 

Protected Attributes


SolverType _solver_type

PreconditionerType _preconditioner_type

bool _is_initialized

Preconditioner< T > * _preconditioner
 

Static Protected Attributes


static Counts _counts

static Threads::atomic< unsigned int > _n_objects

static Threads::spin_mutex _mutex
 

Private Attributes


Epetra_LinearProblem * _linear_problem

AztecOO * _linear_solver
 

Detailed Description

 

template<typename T> class AztecLinearSolver< T >

Trilinos include files. This class provides an interface to AztecOO iterative solvers that is compatible with the libMesh LinearSolver<>

Author:

Benjamin Kirk, 2002-2008

Definition at line 50 of file trilinos_aztec_linear_solver.h.  

Member Typedef Documentation

 

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > ReferenceCounter::Counts [protected, inherited]Data structure to log the information. The log is identified by the class name.

Definition at line 105 of file reference_counter.h.  

Constructor & Destructor Documentation

 

template<typename T > AztecLinearSolver< T >::AztecLinearSolver () [inline]Constructor. Initializes Aztec data structures

Definition at line 161 of file trilinos_aztec_linear_solver.h.

References libMeshEnums::BLOCK_JACOBI_PRECOND, libMeshEnums::ILU_PRECOND, and libMesh::n_processors().

{
  if (libMesh::n_processors() == 1)
    this->_preconditioner_type = ILU_PRECOND;
  else
    this->_preconditioner_type = BLOCK_JACOBI_PRECOND;
}
 

template<typename T > AztecLinearSolver< T >::~AztecLinearSolver () [inline]Destructor.

Definition at line 173 of file trilinos_aztec_linear_solver.h.

{
  this->clear ();
}
 

Member Function Documentation

 

template<typename T> void LinearSolver< T >::attach_preconditioner (Preconditioner< T > *preconditioner) [inherited]Attaches a Preconditioner object to be used

Definition at line 103 of file linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, and libMeshEnums::SHELL_PRECOND.

{
  if(this->_is_initialized)
  {
    std::cerr<<'Preconditioner must be attached before the solver is initialized!'<<std::endl;
    libmesh_error();
  }
  
  _preconditioner_type = SHELL_PRECOND;
  _preconditioner = preconditioner;
}
 

template<typename T > AutoPtr< LinearSolver< T > > LinearSolver< T >::build (const SolverPackagesolver_package = libMesh::default_solver_package()) [static, inherited]Builds a LinearSolver using the linear solver package specified by solver_package

Definition at line 37 of file linear_solver.C.

References LASPACK_SOLVERS, libMeshEnums::PETSC_SOLVERS, and TRILINOS_SOLVERS.

Referenced by LegacyXdrIO::read_mesh().

{
  // Build the appropriate solver
  switch (solver_package)
    {


#ifdef LIBMESH_HAVE_LASPACK
    case LASPACK_SOLVERS:
      {
        AutoPtr<LinearSolver<T> > ap(new LaspackLinearSolver<T>);
        return ap;
      }
#endif


#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      {
        AutoPtr<LinearSolver<T> > ap(new PetscLinearSolver<T>);
        return ap;
      }
#endif


#ifdef LIBMESH_HAVE_TRILINOS
    case TRILINOS_SOLVERS:
      {
        AutoPtr<LinearSolver<T> > ap(new AztecLinearSolver<T>);
        return ap;
      }
#endif

    default:
      std::cerr << 'ERROR:  Unrecognized solver package: '
                << solver_package
                << std::endl;
      libmesh_error();
    }
    
  AutoPtr<LinearSolver<T> > ap(NULL);
  return ap;    
}
 

template<typename T > void AztecLinearSolver< T >::clear () [virtual]Release all memory and clear data structures.

Reimplemented from LinearSolver< T >.

Definition at line 38 of file trilinos_aztec_linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, libMeshEnums::BLOCK_JACOBI_PRECOND, libMeshEnums::GMRES, libMeshEnums::ILU_PRECOND, libMesh::initialized(), and libMesh::n_processors().

{
  if (this->initialized())
  {
    this->_is_initialized = false;
             
    // Mimic PETSc default solver and preconditioner
    this->_solver_type           = GMRES;

    if (libMesh::n_processors() == 1)
      this->_preconditioner_type = ILU_PRECOND;
    else
      this->_preconditioner_type = BLOCK_JACOBI_PRECOND;
  }
}
 

std::string ReferenceCounter::get_info () [static, inherited]Gets a string containing the reference information.

Definition at line 45 of file reference_counter.C.

References ReferenceCounter::_counts, and Quality::name().

Referenced by ReferenceCounter::print_info().

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)

  std::ostringstream out;
  
  out << '
      << ' ---------------------------------------------------------------------------- 
      << '| Reference count information                                                |
      << ' ---------------------------------------------------------------------------- ;
  
  for (Counts::iterator it = _counts.begin();
       it != _counts.end(); ++it)
    {
      const std::string name(it->first);
      const unsigned int creations    = it->second.first;
      const unsigned int destructions = it->second.second;

      out << '| ' << name << ' reference count information:
          << '|  Creations:    ' << creations    << '
          << '|  Destructions: ' << destructions << ';
    }
  
  out << ' ---------------------------------------------------------------------------- ;

  return out.str();

#else

  return '';
  
#endif
}
 

template<typename T > Real AztecLinearSolver< T >::get_initial_residual ()Returns just the initial residual for the solve just completed with this interface. Use this method instead of the one above if you just want the starting residual and not the entire history.

Definition at line 199 of file trilinos_aztec_linear_solver.C.

{
  return _linear_solver->TrueResidual();
}
 

template<typename T > void AztecLinearSolver< T >::get_residual_history (std::vector< double > &hist)Fills the input vector with the sequence of residual norms from the latest iterative solve.

Definition at line 164 of file trilinos_aztec_linear_solver.C.

{
  libmesh_not_implemented();

//   int ierr = 0;
//   int its  = 0;

//   // Fill the residual history vector with the residual norms
//   // Note that GetResidualHistory() does not copy any values, it
//   // simply sets the pointer p.  Note that for some Krylov subspace
//   // methods, the number of residuals returned in the history
//   // vector may be different from what you are expecting.  For
//   // example, TFQMR returns two residual values per iteration step.
//   PetscReal* p;
//   ierr = KSPGetResidualHistory(_ksp, &p, &its);
//   CHKERRABORT(libMesh::COMM_WORLD,ierr);

//   // Check for early return
//   if (its == 0) return;
  
//   // Create space to store the result
//   hist.resize(its);

//   // Copy history into the vector provided by the user.
//   for (int i=0; i<its; ++i)
//     {
//       hist[i] = *p;
//       p++;
//     }
}
 

void ReferenceCounter::increment_constructor_count (const std::string &name) [inline, protected, inherited]Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 149 of file reference_counter.h.

References ReferenceCounter::_counts, Quality::name(), and Threads::spin_mtx.

Referenced by ReferenceCountedObject< Value >::ReferenceCountedObject().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.first++;
}
 

void ReferenceCounter::increment_destructor_count (const std::string &name) [inline, protected, inherited]Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 167 of file reference_counter.h.

References ReferenceCounter::_counts, Quality::name(), and Threads::spin_mtx.

Referenced by ReferenceCountedObject< Value >::~ReferenceCountedObject().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.second++;
}
 

template<typename T > void AztecLinearSolver< T >::init () [virtual]Initialize data structures if not done so already.

Implements LinearSolver< T >.

Definition at line 57 of file trilinos_aztec_linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, libMeshEnums::BLOCK_JACOBI_PRECOND, libMeshEnums::ILU_PRECOND, and libMesh::initialized().

{
  // Initialize the data structures if not done so already.
  if (!this->initialized())
  {
    this->_is_initialized = true;
 
    _linear_solver = new AztecOO();

    switch(this->_preconditioner_type)
    {
    case ILU_PRECOND:
      _linear_solver->SetAztecOption(AZ_precond,AZ_dom_decomp);
      break;
    case BLOCK_JACOBI_PRECOND:
      _linear_solver->SetAztecOption(AZ_precond,AZ_Jacobi);
      break;
    default:
      _linear_solver->SetAztecOption(AZ_precond,AZ_dom_decomp);
    }
  }
}
 

template<typename T> bool LinearSolver< T >::initialized () const [inline, inherited]Returns:

true if the data structures are initialized, false otherwise.

Definition at line 78 of file linear_solver.h.

{ return _is_initialized; }
 

static unsigned int ReferenceCounter::n_objects () [inline, static, inherited]Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 76 of file reference_counter.h.

References ReferenceCounter::_n_objects.

Referenced by System::read_serialized_blocked_dof_objects(), and System::write_serialized_blocked_dof_objects().

  { return _n_objects; }
 

template<typename T > PreconditionerType LinearSolver< T >::preconditioner_type () const [inherited]Returns the type of preconditioner to use.

Definition at line 83 of file linear_solver.C.

{
  if(_preconditioner)
    return _preconditioner->type();
    
  return _preconditioner_type;
}
 

template<typename T > void AztecLinearSolver< T >::print_converged_reason () [virtual]Prints a useful message about why the latest linear solve con(di)verged.

Implements LinearSolver< T >.

Definition at line 207 of file trilinos_aztec_linear_solver.C.

{
  libmesh_not_implemented();

// #if PETSC_VERSION_LESS_THAN(2,3,1)
//   std::cout << 'This method is currently not supported '
//          << '(but may work!) for Petsc 2.3.0 and earlier.' << std::endl;
// #else
//   KSPConvergedReason reason;
//   KSPGetConvergedReason(_ksp, &reason);
  
//   //  KSP_CONVERGED_RTOL (residual 2-norm decreased by a factor of rtol, from 2-norm of right hand side)
//   //  KSP_CONVERGED_ATOL (residual 2-norm less than abstol)
//   //  KSP_CONVERGED_ITS (used by the preonly preconditioner that always uses ONE iteration) 
//   //  KSP_CONVERGED_STEP_LENGTH
//   //  KSP_DIVERGED_ITS  (required more than its to reach convergence)
//   //  KSP_DIVERGED_DTOL (residual norm increased by a factor of divtol)
//   //  KSP_DIVERGED_NAN (residual norm became Not-a-number likely do to 0/0)
//   //  KSP_DIVERGED_BREAKDOWN (generic breakdown in method)

//   switch (reason)
//     {
//     case KSP_CONVERGED_RTOL:
//        {
//      std::cout << 'Linear solver converged, relative tolerance reached.' << std::endl;
//      break;
//        }
//     case KSP_CONVERGED_ATOL:
//        {
//       std::cout << 'Linear solver converged, absolute tolerance reached.' << std::endl;
//       break;
//        }

//       // Divergence
//     case KSP_DIVERGED_ITS:
//        {
//       std::cout << 'Linear solver diverged, max no. of iterations reached.' << std::endl;
//       break;
//        }
//     case KSP_DIVERGED_DTOL:
//        {
//       std::cout << 'Linear solver diverged, residual norm increase by dtol (default 1.e5).' << std::endl;
//       break;
//        }
//     case KSP_DIVERGED_NAN:
//        {
//       std::cout << 'Linear solver diverged, residual norm is NaN.' << std::endl;
//       break;
//        }
//     case KSP_DIVERGED_BREAKDOWN:
//        {
//       std::cout << 'Linear solver diverged, generic breakdown in the method.' << std::endl;
//       break;
//        }
//     default:
//       {
//      std::cout << 'Unknown/unsupported con(di)vergence reason: ' << reason << std::endl;
//       }
//     }
// #endif
}
 

void ReferenceCounter::print_info () [static, inherited]Prints the reference information to std::cout.

Definition at line 83 of file reference_counter.C.

References ReferenceCounter::get_info().

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
  std::cout << ReferenceCounter::get_info();
  
#endif
}
 

template<typename T > void LinearSolver< T >::set_preconditioner_type (const PreconditionerTypepct) [inherited]Sets the type of preconditioner to use.

Definition at line 93 of file linear_solver.C.

{
  if(_preconditioner)
    _preconditioner->set_type(pct);
  else
    _preconditioner_type = pct;
}
 

template<typename T> void LinearSolver< T >::set_solver_type (const SolverTypest) [inline, inherited]Sets the type of solver to use.

Definition at line 98 of file linear_solver.h.

  { _solver_type = st; }
 

template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [virtual]This function solves a system whose matrix is a shell matrix.

Implements LinearSolver< T >.

Definition at line 127 of file trilinos_aztec_linear_solver.C.

{
  libmesh_not_implemented();
}
 

template<typename T > std::pair<unsigned int, Real> AztecLinearSolver< T >::solve (SparseMatrix< T > &matrix_in, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [inline, virtual]Call the Aztec solver. It calls the method below, using the same matrix for the system and preconditioner matrices.

Implements LinearSolver< T >.

Definition at line 78 of file trilinos_aztec_linear_solver.h.

  {
    return this->solve(matrix_in, matrix_in, solution_in, rhs_in, tol, m_its);
  }
 

template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [virtual]This function solves a system whose matrix is a shell matrix, but a sparse matrix is used as preconditioning matrix, this allowing other preconditioners than JACOBI.

Implements LinearSolver< T >.

Definition at line 145 of file trilinos_aztec_linear_solver.C.

{
  libmesh_not_implemented();
}
 

template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (SparseMatrix< T > &matrix, SparseMatrix< T > &preconditioner, NumericVector< T > &solution, NumericVector< T > &rhs, const doubletol, const unsigned intm_its) [virtual]This method allows you to call a linear solver while specifying the matrix to use as the (left) preconditioning matrix. Note that the linear solver will not compute a preconditioner in this case, and will instead premultiply by the matrix you provide.

Implements LinearSolver< T >.

Definition at line 85 of file trilinos_aztec_linear_solver.C.

References EpetraMatrix< T >::close(), libMesh::init(), and EpetraMatrix< T >::mat().

{
  START_LOG('solve()', 'AztecLinearSolver');  

  // Make sure the data passed in are really of Epetra types
  EpetraMatrix<T>* matrix   = libmesh_cast_ptr<EpetraMatrix<T>*>(&matrix_in);
  EpetraMatrix<T>* precond  = libmesh_cast_ptr<EpetraMatrix<T>*>(&precond_in);
  EpetraVector<T>* solution = libmesh_cast_ptr<EpetraVector<T>*>(&solution_in);
  EpetraVector<T>* rhs      = libmesh_cast_ptr<EpetraVector<T>*>(&rhs_in);

  this->init();

  // Close the matrices and vectors in case this wasn't already done.
  matrix->close ();
  precond->close ();
  solution->close ();
  rhs->close ();
  
  _linear_solver->SetAztecOption(AZ_max_iter,m_its);
  _linear_solver->SetAztecParam(AZ_tol,tol);

  Epetra_FECrsMatrix * emat = matrix->mat();
  Epetra_Vector * esol = solution->vec();
  Epetra_Vector * erhs = rhs->vec();

  _linear_solver->Iterate(emat, esol, erhs, m_its, tol);

  STOP_LOG('solve()', 'AztecLinearSolver');
  
  // return the # of its. and the final residual norm.
  return std::make_pair(_linear_solver->NumIters(), _linear_solver->TrueResidual());
}
 

template<typename T> SolverType LinearSolver< T >::solver_type () const [inline, inherited]Returns the type of solver to use.

Definition at line 93 of file linear_solver.h.

{ return _solver_type; }
 

Member Data Documentation

 

ReferenceCounter::Counts ReferenceCounter::_counts [static, protected, inherited]Actually holds the data.

Definition at line 110 of file reference_counter.h.

Referenced by ReferenceCounter::get_info(), ReferenceCounter::increment_constructor_count(), and ReferenceCounter::increment_destructor_count().  

template<typename T> bool LinearSolver< T >::_is_initialized [protected, inherited]Flag indicating if the data structures have been initialized.

Definition at line 200 of file linear_solver.h.

Referenced by LinearSolver< Number >::initialized().  

template<typename T > Epetra_LinearProblem* AztecLinearSolver< T >::_linear_problem [private]The Epetra linear problem object.

Definition at line 149 of file trilinos_aztec_linear_solver.h.  

template<typename T > AztecOO* AztecLinearSolver< T >::_linear_solver [private]The AztecOO solver object

Definition at line 154 of file trilinos_aztec_linear_solver.h.  

Threads::spin_mutex ReferenceCounter::_mutex [static, protected, inherited]Mutual exclusion object to enable thread-safe reference counting.

Definition at line 123 of file reference_counter.h.  

Threads::atomic< unsigned int > ReferenceCounter::_n_objects [static, protected, inherited]The number of objects. Print the reference count information when the number returns to 0.

Definition at line 118 of file reference_counter.h.

Referenced by ReferenceCounter::n_objects(), ReferenceCounter::ReferenceCounter(), and ReferenceCounter::~ReferenceCounter().  

template<typename T> Preconditioner<T>* LinearSolver< T >::_preconditioner [protected, inherited]Holds the Preconditioner object to be used for the linear solves.

Definition at line 205 of file linear_solver.h.  

template<typename T> PreconditionerType LinearSolver< T >::_preconditioner_type [protected, inherited]Enum statitng with type of preconditioner to use.

Definition at line 195 of file linear_solver.h.  

template<typename T> SolverType LinearSolver< T >::_solver_type [protected, inherited]Enum stating which type of iterative solver to use.

Definition at line 190 of file linear_solver.h.

Referenced by LinearSolver< Number >::set_solver_type(), and LinearSolver< Number >::solver_type().  

template<typename T> bool LinearSolver< T >::same_preconditioner [inherited]Boolean flag to indicate whether we want to use an identical preconditioner to the previous solve. This can save substantial work in the cases where the system matrix is the same for successive solves.

Definition at line 182 of file linear_solver.h.

 

Author

Generated automatically by Doxygen for libMesh from the source code.


 

Index

NAME
SYNOPSIS
Public Member Functions
Static Public Member Functions
Public Attributes
Protected Types
Protected Member Functions
Protected Attributes
Static Protected Attributes
Private Attributes
Detailed Description
template<typename T> class AztecLinearSolver< T >
Member Typedef Documentation
typedef std::map<std::string, std::pair<unsigned int, unsigned int> > ReferenceCounter::Counts [protected, inherited]Data structure to log the information. The log is identified by the class name.
Constructor & Destructor Documentation
template<typename T > AztecLinearSolver< T >::AztecLinearSolver () [inline]Constructor. Initializes Aztec data structures
template<typename T > AztecLinearSolver< T >::~AztecLinearSolver () [inline]Destructor.
Member Function Documentation
template<typename T> void LinearSolver< T >::attach_preconditioner (Preconditioner< T > *preconditioner) [inherited]Attaches a Preconditioner object to be used
template<typename T > AutoPtr< LinearSolver< T > > LinearSolver< T >::build (const SolverPackagesolver_package = libMesh::default_solver_package()) [static, inherited]Builds a LinearSolver using the linear solver package specified by solver_package
template<typename T > void AztecLinearSolver< T >::clear () [virtual]Release all memory and clear data structures.
std::string ReferenceCounter::get_info () [static, inherited]Gets a string containing the reference information.
template<typename T > Real AztecLinearSolver< T >::get_initial_residual ()Returns just the initial residual for the solve just completed with this interface. Use this method instead of the one above if you just want the starting residual and not the entire history.
template<typename T > void AztecLinearSolver< T >::get_residual_history (std::vector< double > &hist)Fills the input vector with the sequence of residual norms from the latest iterative solve.
void ReferenceCounter::increment_constructor_count (const std::string &name) [inline, protected, inherited]Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.
void ReferenceCounter::increment_destructor_count (const std::string &name) [inline, protected, inherited]Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.
template<typename T > void AztecLinearSolver< T >::init () [virtual]Initialize data structures if not done so already.
template<typename T> bool LinearSolver< T >::initialized () const [inline, inherited]Returns:
static unsigned int ReferenceCounter::n_objects () [inline, static, inherited]Prints the number of outstanding (created, but not yet destroyed) objects.
template<typename T > PreconditionerType LinearSolver< T >::preconditioner_type () const [inherited]Returns the type of preconditioner to use.
template<typename T > void AztecLinearSolver< T >::print_converged_reason () [virtual]Prints a useful message about why the latest linear solve con(di)verged.
void ReferenceCounter::print_info () [static, inherited]Prints the reference information to std::cout.
template<typename T > void LinearSolver< T >::set_preconditioner_type (const PreconditionerTypepct) [inherited]Sets the type of preconditioner to use.
template<typename T> void LinearSolver< T >::set_solver_type (const SolverTypest) [inline, inherited]Sets the type of solver to use.
template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [virtual]This function solves a system whose matrix is a shell matrix.
template<typename T > std::pair<unsigned int, Real> AztecLinearSolver< T >::solve (SparseMatrix< T > &matrix_in, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [inline, virtual]Call the Aztec solver. It calls the method below, using the same matrix for the system and preconditioner matrices.
template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const doubletol, const unsigned intm_its) [virtual]This function solves a system whose matrix is a shell matrix, but a sparse matrix is used as preconditioning matrix, this allowing other preconditioners than JACOBI.
template<typename T > std::pair< unsigned int, Real > AztecLinearSolver< T >::solve (SparseMatrix< T > &matrix, SparseMatrix< T > &preconditioner, NumericVector< T > &solution, NumericVector< T > &rhs, const doubletol, const unsigned intm_its) [virtual]This method allows you to call a linear solver while specifying the matrix to use as the (left) preconditioning matrix. Note that the linear solver will not compute a preconditioner in this case, and will instead premultiply by the matrix you provide.
template<typename T> SolverType LinearSolver< T >::solver_type () const [inline, inherited]Returns the type of solver to use.
Member Data Documentation
ReferenceCounter::Counts ReferenceCounter::_counts [static, protected, inherited]Actually holds the data.
template<typename T> bool LinearSolver< T >::_is_initialized [protected, inherited]Flag indicating if the data structures have been initialized.
template<typename T > Epetra_LinearProblem* AztecLinearSolver< T >::_linear_problem [private]The Epetra linear problem object.
template<typename T > AztecOO* AztecLinearSolver< T >::_linear_solver [private]The AztecOO solver object
Threads::spin_mutex ReferenceCounter::_mutex [static, protected, inherited]Mutual exclusion object to enable thread-safe reference counting.
Threads::atomic< unsigned int > ReferenceCounter::_n_objects [static, protected, inherited]The number of objects. Print the reference count information when the number returns to 0.
template<typename T> Preconditioner<T>* LinearSolver< T >::_preconditioner [protected, inherited]Holds the Preconditioner object to be used for the linear solves.
template<typename T> PreconditionerType LinearSolver< T >::_preconditioner_type [protected, inherited]Enum statitng with type of preconditioner to use.
template<typename T> SolverType LinearSolver< T >::_solver_type [protected, inherited]Enum stating which type of iterative solver to use.
template<typename T> bool LinearSolver< T >::same_preconditioner [inherited]Boolean flag to indicate whether we want to use an identical preconditioner to the previous solve. This can save substantial work in the cases where the system matrix is the same for successive solves.
Author

This document was created by man2html, using the manual pages.
Time: 21:42:10 GMT, April 16, 2011