LinearSolver

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

NAME

LinearSolver -

SYNOPSIS

#include <linear_solver.h>

Inherits ReferenceCountedObject< LinearSolver< T > >.

Inherited by AztecLinearSolver< T >, LaspackLinearSolver< T >, and PetscLinearSolver< T >.

Public Member Functions

LinearSolver ()

virtual ~LinearSolver ()

bool initialized () const

virtual void clear ()

virtual void init ()=0

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)

virtual std::pair< unsigned int, Real > solve (SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)=0

virtual std::pair< unsigned int, Real > solve (SparseMatrix< T > &, SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)=0

virtual std::pair< unsigned int, Real > solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)=0

virtual std::pair< unsigned int, Real > solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)=0

virtual void print_converged_reason ()=0

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

Detailed Description

template<typename T> class LinearSolver< T >

This class provides a uniform interface for linear solvers. This base class is overloaded to provide linear solvers from different packages like PETSC or LASPACK.

Author:

: Benjamin Kirk, 2003

Definition at line 53 of file 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 > LinearSolver< T >::LinearSolver () [inline]Constructor. Initializes Solver data structures

Definition at line 214 of file linear_solver.h.

                               :

  same_preconditioner  (false),
  _solver_type         (GMRES),
  _preconditioner_type (ILU_PRECOND),
  _is_initialized      (false),
  _preconditioner      (NULL)
{
}

template<typename T > LinearSolver< T >::~LinearSolver () [inline, virtual]Destructor.

Definition at line 228 of file linear_solver.h.

{
  this->clear ();
}

Member Function Documentation

template<typename T> void LinearSolver< T >::attach_preconditioner (Preconditioner< T > *preconditioner)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]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> virtual void LinearSolver< T >::clear () [inline, virtual]Release all memory and clear data structures.

Reimplemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

Definition at line 83 of file linear_solver.h.

{}

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
}

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> virtual void LinearSolver< T >::init () [pure virtual]Initialize data structures if not done so already.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

template<typename T> bool LinearSolver< T >::initialized () const [inline]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 () constReturns 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> virtual void LinearSolver< T >::print_converged_reason () [pure virtual]Prints a useful message about why the latest linear solve con(di)verged.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

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)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]Sets the type of solver to use.

Definition at line 98 of file linear_solver.h.

  { _solver_type = st; }

template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (SparseMatrix< T > &, SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function calls the solver '_solver_type' preconditioned with the '_preconditioner_type' preconditioner. Note that this method will compute the preconditioner from the system matrix.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function calls the solver '_solver_type' preconditioned with the '_preconditioner_type' preconditioner. Note that this method will compute the preconditioner from the system matrix.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function solves a system whose matrix is a shell matrix.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure 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.

Implemented in LaspackLinearSolver< T >, PetscLinearSolver< T >, and AztecLinearSolver< T >.

template<typename T> SolverType LinearSolver< T >::solver_type () const [inline]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]Flag indicating if the data structures have been initialized.

Definition at line 200 of file linear_solver.h.

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

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]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]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]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_preconditionerBoolean 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

Detailed Description

template<typename T> class LinearSolver< 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 > LinearSolver< T >::LinearSolver () [inline]Constructor. Initializes Solver data structures
template<typename T > LinearSolver< T >::~LinearSolver () [inline, virtual]Destructor.

Member Function Documentation

template<typename T> void LinearSolver< T >::attach_preconditioner (Preconditioner< T > *preconditioner)Attaches a Preconditioner object to be used
template<typename T > AutoPtr< LinearSolver< T > > LinearSolver< T >::build (const SolverPackagesolver_package = libMesh::default_solver_package()) [static]Builds a LinearSolver using the linear solver package specified by solver_package
template<typename T> virtual void LinearSolver< T >::clear () [inline, virtual]Release all memory and clear data structures.
std::string ReferenceCounter::get_info () [static, inherited]Gets a string containing the reference information.
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> virtual void LinearSolver< T >::init () [pure virtual]Initialize data structures if not done so already.
template<typename T> bool LinearSolver< T >::initialized () const [inline]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 () constReturns the type of preconditioner to use.
template<typename T> virtual void LinearSolver< T >::print_converged_reason () [pure 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)Sets the type of preconditioner to use.
template<typename T> void LinearSolver< T >::set_solver_type (const SolverTypest) [inline]Sets the type of solver to use.
template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (SparseMatrix< T > &, SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function calls the solver '_solver_type' preconditioned with the '_preconditioner_type' preconditioner. Note that this method will compute the preconditioner from the system matrix.
template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (SparseMatrix< T > &, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function calls the solver '_solver_type' preconditioned with the '_preconditioner_type' preconditioner. Note that this method will compute the preconditioner from the system matrix.
template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure virtual]This function solves a system whose matrix is a shell matrix.
template<typename T> virtual std::pair<unsigned int, Real> LinearSolver< T >::solve (const ShellMatrix< T > &shell_matrix, const SparseMatrix< T > &precond_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsignedint) [pure 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> SolverType LinearSolver< T >::solver_type () const [inline]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]Flag indicating if the data structures have been initialized.
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]Holds the Preconditioner object to be used for the linear solves.
template<typename T> PreconditionerType LinearSolver< T >::_preconditioner_type [protected]Enum statitng with type of preconditioner to use.
template<typename T> SolverType LinearSolver< T >::_solver_type [protected]Enum stating which type of iterative solver to use.
template<typename T> bool LinearSolver< T >::same_preconditionerBoolean 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:49:25 GMT, April 16, 2011