Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | Private Attributes | List of all members
MeanValueFilter Class Reference

#include <matrix_lib.h>

Inheritance diagram for MeanValueFilter:
[legend]

Public Types

typedef types::global_dof_index size_type
 

Public Member Functions

 MeanValueFilter (size_type component=numbers::invalid_size_type)
 
template<typename number >
void filter (Vector< number > &v) const
 
template<typename number >
void filter (BlockVector< number > &v) const
 
template<typename number >
void vmult (Vector< number > &dst, const Vector< number > &src) const
 
template<typename number >
void vmult_add (Vector< number > &dst, const Vector< number > &src) const
 
template<typename number >
void vmult (BlockVector< number > &dst, const BlockVector< number > &src) const
 
template<typename number >
void vmult_add (BlockVector< number > &dst, const BlockVector< number > &src) const
 
template<typename VECTOR >
void Tvmult (VECTOR &, const VECTOR &) const
 
template<typename VECTOR >
void Tvmult_add (VECTOR &, const VECTOR &) const
 
template<typename number >
DEAL_II_NAMESPACE_OPEN void filter (Vector< number > &v) const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

size_type component
 

Detailed Description

Mean value filter. The vmult() functions of this matrix filter out mean values of the vector. If the vector is of type BlockVector, then an additional parameter selects a single component for this operation.

Author
Guido Kanschat, 2002, 2003

Definition at line 331 of file matrix_lib.h.

Member Typedef Documentation

Declare type for container size.

Definition at line 337 of file matrix_lib.h.

Constructor & Destructor Documentation

MeanValueFilter::MeanValueFilter ( size_type  component = numbers::invalid_size_type)

Constructor, optionally selecting a component.

Member Function Documentation

template<typename number >
void MeanValueFilter::filter ( Vector< number > &  v) const

Subtract mean value from v.

template<typename number >
void MeanValueFilter::filter ( BlockVector< number > &  v) const

Subtract mean value from v.

Definition at line 72 of file matrix_lib.templates.h.

template<typename number >
void MeanValueFilter::vmult ( Vector< number > &  dst,
const Vector< number > &  src 
) const

Return the source vector with subtracted mean value.

Definition at line 40 of file matrix_lib.templates.h.

template<typename number >
void MeanValueFilter::vmult_add ( Vector< number > &  dst,
const Vector< number > &  src 
) const

Add source vector with subtracted mean value to dest.

Definition at line 56 of file matrix_lib.templates.h.

template<typename number >
void MeanValueFilter::vmult ( BlockVector< number > &  dst,
const BlockVector< number > &  src 
) const

Return the source vector with subtracted mean value in selected component.

Definition at line 88 of file matrix_lib.templates.h.

template<typename number >
void MeanValueFilter::vmult_add ( BlockVector< number > &  dst,
const BlockVector< number > &  src 
) const

Add a soruce to dest, where the mean value in the selected component is subtracted.

Definition at line 108 of file matrix_lib.templates.h.

template<class VECTOR >
void MeanValueFilter::Tvmult ( VECTOR &  ,
const VECTOR &   
) const
inline

Not implemented.

Definition at line 738 of file matrix_lib.h.

template<class VECTOR >
void MeanValueFilter::Tvmult_add ( VECTOR &  ,
const VECTOR &   
) const
inline

Not implemented.

Definition at line 746 of file matrix_lib.h.

Member Data Documentation

size_type MeanValueFilter::component
private

Component for filtering block vectors.

Definition at line 408 of file matrix_lib.h.


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