Reference documentation for deal.II version Git f264146 2017-10-18 16:34:34 -0400
Public Member Functions | Private Attributes | List of all members
MGCoarseGridLACIteration< SolverType, VectorType > Class Template Reference

#include <deal.II/multigrid/mg_coarse.h>

Inheritance diagram for MGCoarseGridLACIteration< SolverType, VectorType >:
[legend]

Public Member Functions

 MGCoarseGridLACIteration ()
 
template<typename MatrixType , typename PreconditionerType >
 MGCoarseGridLACIteration (SolverType &, const MatrixType &, const PreconditionerType &)
 
 ~MGCoarseGridLACIteration ()
 
template<typename MatrixType , typename PreconditionerType >
void initialize (SolverType &, const MatrixType &, const PreconditionerType &)
 
void clear ()
 
void operator() (const unsigned int level, VectorType &dst, const VectorType &src) const
 
template<typename MatrixType >
void set_matrix (const MatrixType &)
 
- Public Member Functions inherited from MGCoarseGridBase< VectorType >
virtual ~MGCoarseGridBase ()=default
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

SmartPointer< SolverType, MGCoarseGridLACIteration< SolverType, VectorType > > solver
 
LinearOperator< VectorType > matrix
 
LinearOperator< VectorType > precondition
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 

Detailed Description

template<typename SolverType, class VectorType = Vector<double>>
class MGCoarseGridLACIteration< SolverType, VectorType >

Coarse grid solver using LAC iterative methods. This is a little wrapper, transforming a triplet of iterative solver, matrix and preconditioner into a coarse grid solver.

The type of the matrix (i.e. the template parameter MatrixType) should be derived from Subscriptor to allow for the use of a smart pointer to it.

Deprecated:
Use MGCoarseGridIterativeSolver instead.
Author
Guido Kanschat, 1999, Ralf Hartmann, 2002.

Definition at line 90 of file mg_coarse.h.

Constructor & Destructor Documentation

template<typename SolverType , class VectorType = Vector<double>>
MGCoarseGridLACIteration< SolverType, VectorType >::MGCoarseGridLACIteration ( )

Default constructor.

template<typename SolverType , class VectorType = Vector<double>>
template<typename MatrixType , typename PreconditionerType >
MGCoarseGridLACIteration< SolverType, VectorType >::MGCoarseGridLACIteration ( SolverType &  ,
const MatrixType &  ,
const PreconditionerType &   
)

Constructor. Store solver, matrix and preconditioning method for later use.

template<typename SolverType , class VectorType = Vector<double>>
MGCoarseGridLACIteration< SolverType, VectorType >::~MGCoarseGridLACIteration ( )

Destructor freeing the pointers.

Member Function Documentation

template<typename SolverType , class VectorType = Vector<double>>
template<typename MatrixType , typename PreconditionerType >
void MGCoarseGridLACIteration< SolverType, VectorType >::initialize ( SolverType &  ,
const MatrixType &  ,
const PreconditionerType &   
)

Initialize new data.

template<typename SolverType , class VectorType = Vector<double>>
void MGCoarseGridLACIteration< SolverType, VectorType >::clear ( )

Clear all pointers.

template<typename SolverType , class VectorType = Vector<double>>
void MGCoarseGridLACIteration< SolverType, VectorType >::operator() ( const unsigned int  level,
VectorType &  dst,
const VectorType &  src 
) const
virtual

Implementation of the abstract function. Calls the solver method with matrix, vectors and preconditioner.

Implements MGCoarseGridBase< VectorType >.

template<typename SolverType , class VectorType = Vector<double>>
template<typename MatrixType >
void MGCoarseGridLACIteration< SolverType, VectorType >::set_matrix ( const MatrixType &  )

Set the matrix. This gives the possibility to replace the matrix that was given to the constructor by a new matrix.

Member Data Documentation

template<typename SolverType , class VectorType = Vector<double>>
SmartPointer<SolverType,MGCoarseGridLACIteration<SolverType,VectorType> > MGCoarseGridLACIteration< SolverType, VectorType >::solver
private

Reference to the solver.

Definition at line 144 of file mg_coarse.h.

template<typename SolverType , class VectorType = Vector<double>>
LinearOperator<VectorType> MGCoarseGridLACIteration< SolverType, VectorType >::matrix
private

LinearOperator wrapping a reference to the matrix.

Definition at line 149 of file mg_coarse.h.

template<typename SolverType , class VectorType = Vector<double>>
LinearOperator<VectorType> MGCoarseGridLACIteration< SolverType, VectorType >::precondition
private

LinearOperator wrapping a reference to the preconditioner.

Definition at line 154 of file mg_coarse.h.


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