Reference documentation for deal.II version Git e694e60270 2021-02-25 22:28:05 -0500
\(\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 | Private Attributes | List of all members
MGCoarseGridApplySmoother< VectorType > Class Template Reference

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

Inheritance diagram for MGCoarseGridApplySmoother< VectorType >:
[legend]

Public Member Functions

 MGCoarseGridApplySmoother ()
 
 MGCoarseGridApplySmoother (const MGSmootherBase< VectorType > &coarse_smooth)
 
void clear ()
 
void initialize (const MGSmootherBase< VectorType > &coarse_smooth)
 
void operator() (const unsigned int level, VectorType &dst, const VectorType &src) const override
 
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)
 

Private Attributes

SmartPointer< const MGSmootherBase< VectorType >, MGCoarseGridApplySmoother< VectorType > > coarse_smooth
 

Detailed Description

template<class VectorType = Vector<double>>
class MGCoarseGridApplySmoother< VectorType >

Coarse grid solver using smoother only. This is a little wrapper, transforming a smoother into a coarse grid solver.

Definition at line 38 of file mg_coarse.h.

Constructor & Destructor Documentation

◆ MGCoarseGridApplySmoother() [1/2]

template<class VectorType = Vector<double>>
MGCoarseGridApplySmoother< VectorType >::MGCoarseGridApplySmoother ( )

Default constructor.

◆ MGCoarseGridApplySmoother() [2/2]

template<class VectorType = Vector<double>>
MGCoarseGridApplySmoother< VectorType >::MGCoarseGridApplySmoother ( const MGSmootherBase< VectorType > &  coarse_smooth)

Constructor. Store a pointer to the smoother for later use.

Member Function Documentation

◆ clear()

template<class VectorType = Vector<double>>
void MGCoarseGridApplySmoother< VectorType >::clear ( )

Clear the pointer.

◆ initialize()

template<class VectorType = Vector<double>>
void MGCoarseGridApplySmoother< VectorType >::initialize ( const MGSmootherBase< VectorType > &  coarse_smooth)

Initialize new data.

◆ operator()()

template<class VectorType = Vector<double>>
void MGCoarseGridApplySmoother< VectorType >::operator() ( const unsigned int  level,
VectorType dst,
const VectorType src 
) const
overridevirtual

Implementation of the abstract function.

Implements MGCoarseGridBase< VectorType >.

◆ 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 301 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 318 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 using the BOOST serialization library.

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 310 of file subscriptor.h.

Member Data Documentation

◆ coarse_smooth

template<class VectorType = Vector<double>>
SmartPointer<const MGSmootherBase<VectorType>, MGCoarseGridApplySmoother<VectorType> > MGCoarseGridApplySmoother< VectorType >::coarse_smooth
private

Reference to the smoother.

Definition at line 77 of file mg_coarse.h.


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