Reference documentation for deal.II version Git f0d9923401 2020-09-28 19:47:38 -0600
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | List of all members
MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType > Class Template Reference

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

Inheritance diagram for MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >:
[legend]

Public Member Functions

 MGSmootherPrecondition (const unsigned int steps=1, const bool variable=false, const bool symmetric=false, const bool transpose=false)
 
template<typename MatrixType2 >
void initialize (const MGLevelObject< MatrixType2 > &matrices, const typename PreconditionerType::AdditionalData &additional_data=typename PreconditionerType::AdditionalData())
 
template<typename MatrixType2 , class DATA >
void initialize (const MGLevelObject< MatrixType2 > &matrices, const MGLevelObject< DATA > &additional_data)
 
template<typename MatrixType2 , class DATA >
void initialize (const MGLevelObject< MatrixType2 > &matrices, const DATA &additional_data, const unsigned int block_row, const unsigned int block_col)
 
template<typename MatrixType2 , class DATA >
void initialize (const MGLevelObject< MatrixType2 > &matrices, const MGLevelObject< DATA > &additional_data, const unsigned int block_row, const unsigned int block_col)
 
void clear () override
 
virtual void smooth (const unsigned int level, VectorType &u, const VectorType &rhs) const override
 
virtual void apply (const unsigned int level, VectorType &u, const VectorType &rhs) const override
 
std::size_t memory_consumption () const
 
void set_steps (const unsigned int)
 
void set_variable (const bool)
 
void set_symmetric (const bool)
 
void set_transpose (const bool)
 
void set_debug (const unsigned int level)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Public Attributes

MGLevelObject< PreconditionerType > smoothers
 

Protected Attributes

GrowingVectorMemory< VectorTypevector_memory
 
unsigned int steps
 
bool variable
 
bool symmetric
 
bool transpose
 
unsigned int debug
 

Private Attributes

MGLevelObject< LinearOperator< VectorType > > matrices
 

Detailed Description

template<typename MatrixType, typename PreconditionerType, typename VectorType>
class MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >

Smoother using preconditioner classes.

This class performs smoothing on each level. The operation can be controlled by several parameters. First, the relaxation parameter omega is used in the underlying relaxation method. steps is the number of relaxation steps on the finest level (on all levels if variable is off). If variable is true, the number of smoothing steps is doubled on each coarser level. This results in a method having the complexity of the W-cycle, but saving grid transfers. This is the method proposed by Bramble at al.

The option symmetric switches on alternating between the smoother and its transpose in each step as proposed by Bramble.

transpose uses the transposed smoothing operation using Tvmult instead of the regular vmult of the relaxation scheme.

If you are using block matrices, the second initialize function offers the possibility to extract a single block for smoothing. In this case, the multigrid method must be used only with the vector associated to that single block.

The library contains instantiation for SparseMatrix<.> and Vector<.>, where the template arguments are all combinations of float and double. Additional instantiations may be created by including the file mg_smoother.templates.h.

Definition at line 444 of file mg_smoother.h.

Constructor & Destructor Documentation

◆ MGSmootherPrecondition()

template<typename MatrixType, typename PreconditionerType, typename VectorType>
MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::MGSmootherPrecondition ( const unsigned int  steps = 1,
const bool  variable = false,
const bool  symmetric = false,
const bool  transpose = false 
)

Constructor. Sets smoothing parameters.

Member Function Documentation

◆ initialize() [1/4]

template<typename MatrixType, typename PreconditionerType, typename VectorType>
template<typename MatrixType2 >
void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::initialize ( const MGLevelObject< MatrixType2 > &  matrices,
const typename PreconditionerType::AdditionalData &  additional_data = typename PreconditionerType::AdditionalData() 
)

Initialize for matrices. This function stores pointers to the level matrices and initializes the smoothing operator with the same smoother for each level.

additional_data is an object of type PreconditionerType::AdditionalData and is handed to the initialization function of the relaxation method.

◆ initialize() [2/4]

template<typename MatrixType, typename PreconditionerType, typename VectorType>
template<typename MatrixType2 , class DATA >
void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::initialize ( const MGLevelObject< MatrixType2 > &  matrices,
const MGLevelObject< DATA > &  additional_data 
)

Initialize for matrices. This function stores pointers to the level matrices and initializes the smoothing operator with the according smoother for each level.

additional_data is an object of type PreconditionerType::AdditionalData and is handed to the initialization function of the relaxation method.

◆ initialize() [3/4]

template<typename MatrixType, typename PreconditionerType, typename VectorType>
template<typename MatrixType2 , class DATA >
void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::initialize ( const MGLevelObject< MatrixType2 > &  matrices,
const DATA &  additional_data,
const unsigned int  block_row,
const unsigned int  block_col 
)

Initialize for single blocks of matrices. Of this block matrix, the block indicated by block_row and block_col is selected on each level. This function stores pointers to the level matrices and initializes the smoothing operator with the same smoother for each level.

additional_data is an object of type PreconditionerType::AdditionalData and is handed to the initialization function of the relaxation method.

◆ initialize() [4/4]

template<typename MatrixType, typename PreconditionerType, typename VectorType>
template<typename MatrixType2 , class DATA >
void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::initialize ( const MGLevelObject< MatrixType2 > &  matrices,
const MGLevelObject< DATA > &  additional_data,
const unsigned int  block_row,
const unsigned int  block_col 
)

Initialize for single blocks of matrices. Of this block matrix, the block indicated by block_row and block_col is selected on each level. This function stores pointers to the level matrices and initializes the smoothing operator with the according smoother for each level.

additional_data is an object of type PreconditionerType::AdditionalData and is handed to the initialization function of the relaxation method.

◆ clear()

template<typename MatrixType, typename PreconditionerType, typename VectorType>
void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::clear ( )
overridevirtual

Empty all vectors.

Implements MGSmootherBase< VectorType >.

◆ smooth()

template<typename MatrixType, typename PreconditionerType, typename VectorType>
virtual void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::smooth ( const unsigned int  level,
VectorType u,
const VectorType rhs 
) const
overridevirtual

The actual smoothing method.

Implements MGSmootherBase< VectorType >.

◆ apply()

template<typename MatrixType, typename PreconditionerType, typename VectorType>
virtual void MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::apply ( const unsigned int  level,
VectorType u,
const VectorType rhs 
) const
overridevirtual

The apply variant of smoothing, setting the vector u to zero before calling the smooth function. This function is equivalent to the following code

u = 0;
smooth(level, u, rhs);

In the multigrid preconditioner interfaces, the apply() method is used for the pre-smoothing operation because the previous content in the solution vector needs to be overwritten for a new incoming residual. On the other hand, all subsequent operations need to smooth the content already present in the vector u given the right hand side, which is done by smooth().

Reimplemented from MGSmootherBase< VectorType >.

◆ memory_consumption()

template<typename MatrixType, typename PreconditionerType, typename VectorType>
std::size_t MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::memory_consumption ( ) const

Memory used by this object.

◆ set_steps()

template<typename VectorType>
void MGSmoother< VectorType >::set_steps ( const unsigned  int)
inherited

Modify the number of smoothing steps on finest level.

◆ set_variable()

template<typename VectorType>
void MGSmoother< VectorType >::set_variable ( const bool  )
inherited

Switch on/off variable smoothing.

◆ set_symmetric()

template<typename VectorType>
void MGSmoother< VectorType >::set_symmetric ( const bool  )
inherited

Switch on/off symmetric smoothing.

◆ set_transpose()

template<typename VectorType>
void MGSmoother< VectorType >::set_transpose ( const bool  )
inherited

Switch on/off transposed smoothing. The effect is overridden by set_symmetric().

◆ set_debug()

template<typename VectorType>
void MGSmoother< VectorType >::set_debug ( const unsigned int  level)
inherited

Set debug to a nonzero value to get debug information logged to deallog. Increase to get more information

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

Member Data Documentation

◆ smoothers

template<typename MatrixType, typename PreconditionerType, typename VectorType>
MGLevelObject<PreconditionerType> MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::smoothers

Object containing relaxation methods.

Definition at line 555 of file mg_smoother.h.

◆ matrices

template<typename MatrixType, typename PreconditionerType, typename VectorType>
MGLevelObject<LinearOperator<VectorType> > MGSmootherPrecondition< MatrixType, PreconditionerType, VectorType >::matrices
private

Pointer to the matrices.

Definition at line 568 of file mg_smoother.h.

◆ vector_memory

template<typename VectorType>
GrowingVectorMemory<VectorType> MGSmoother< VectorType >::vector_memory
mutableprotectedinherited

A memory object to be used for temporary vectors.

The object is marked as mutable since we will need to use it to allocate temporary vectors also in functions that are const.

Definition at line 98 of file mg_smoother.h.

◆ steps

template<typename VectorType>
unsigned int MGSmoother< VectorType >::steps
protectedinherited

Number of smoothing steps on the finest level. If no variable smoothing is chosen, this is the number of steps on all levels.

Definition at line 104 of file mg_smoother.h.

◆ variable

template<typename VectorType>
bool MGSmoother< VectorType >::variable
protectedinherited

Variable smoothing: double the number of smoothing steps whenever going to the next coarser level

Definition at line 110 of file mg_smoother.h.

◆ symmetric

template<typename VectorType>
bool MGSmoother< VectorType >::symmetric
protectedinherited

Symmetric smoothing: in the smoothing iteration, alternate between the relaxation method and its transpose.

Definition at line 116 of file mg_smoother.h.

◆ transpose

template<typename VectorType>
bool MGSmoother< VectorType >::transpose
protectedinherited

Use the transpose of the relaxation method instead of the method itself. This has no effect if symmetric smoothing is chosen.

Definition at line 122 of file mg_smoother.h.

◆ debug

template<typename VectorType>
unsigned int MGSmoother< VectorType >::debug
protectedinherited

Output debugging information to deallog if this is nonzero.

Definition at line 127 of file mg_smoother.h.


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