Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
concepts::DiagonalSolver< F > Class Template Reference

A solver for diagonal matrices. More...

#include <diagonal.hh>

Inheritance diagram for concepts::DiagonalSolver< F >:
Inheritance graph
[legend]
Collaboration diagram for concepts::DiagonalSolver< F >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Cmplxtype< F >::type c_type
 Real type of data type.
typedef Realtype< F >::type r_type
 Real type of data type.
typedef F type
 Type of data, e.g. matrix entries.

Public Member Functions

 DiagonalSolver (const DiagonalMatrix< F > &m)
 Constructor.
virtual const uint dimX () const
 Returns the size of the image space of the operator (number of rows of the corresponding matrix)
virtual const uint dimY () const
 Returns the size of the source space of the operator (number of columns of the corresponding matrix)
virtual void operator() (const Function< r_type > &rhs, Function< F > &sol)
 Application operator for real function fncY.
void operator() (const Matrix< r_type > &mX, Matrix< F > &mY)
 Application method to real matrices.
virtual void operator() (const Function< c_type > &rhs, Function< c_type > &sol)
 Application operator for complex function fncY.
void operator() (const Matrix< c_type > &mX, Matrix< c_type > &mY)
 Application method to complex matrices.
virtual ~DiagonalSolver ()

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.

Protected Attributes

uint dimX_
 Dimension of image space and the source space.
uint dimY_

Private Member Functions

template<typename H , typename I >
void apply_ (const Matrix< H > &mX, Matrix< I > &mY)

Private Attributes

DiagonalMatrix< F > inverse_

Detailed Description

template<typename F>
class concepts::DiagonalSolver< F >

A solver for diagonal matrices.

Inverts a diagonal matrix and stores this inverse in order to apply it when applying the solver.

Author:
Christoph Winkelmann, 2002
Examples:

hpFEM2d-simple.cc, and hpFEM2d.cc.

Definition at line 124 of file diagonal.hh.


Member Typedef Documentation

template<typename F>
typedef Cmplxtype<F>::type concepts::DiagonalSolver< F >::c_type

Real type of data type.

Reimplemented from concepts::Operator< F >.

Definition at line 129 of file diagonal.hh.

template<typename F>
typedef Realtype<F>::type concepts::DiagonalSolver< F >::r_type

Real type of data type.

Reimplemented from concepts::Operator< F >.

Definition at line 127 of file diagonal.hh.

template<class F>
typedef F concepts::Operator< F >::type [inherited]

Type of data, e.g. matrix entries.

Reimplemented in concepts::AfterIteration< F >, and concepts::SubMatrixN< F >.

Definition at line 43 of file compositions.hh.


Constructor & Destructor Documentation

template<typename F>
concepts::DiagonalSolver< F >::DiagonalSolver ( const DiagonalMatrix< F > &  m)

Constructor.

Parameters:
mDiagonal matrix to be inverted
template<typename F>
virtual concepts::DiagonalSolver< F >::~DiagonalSolver ( ) [virtual]

Member Function Documentation

template<typename F >
template<typename H , typename I >
void concepts::DiagonalSolver< F >::apply_ ( const Matrix< H > &  mX,
Matrix< I > &  mY 
) [private]

Definition at line 172 of file diagonal.hh.

Here is the call graph for this function:

template<class F>
virtual const uint concepts::Operator< F >::dimX ( ) const [inline, virtual, inherited]

Returns the size of the image space of the operator (number of rows of the corresponding matrix)

Definition at line 87 of file compositions.hh.

template<class F>
virtual const uint concepts::Operator< F >::dimY ( ) const [inline, virtual, inherited]

Returns the size of the source space of the operator (number of columns of the corresponding matrix)

Definition at line 92 of file compositions.hh.

template<typename F>
virtual std::ostream& concepts::DiagonalSolver< F >::info ( std::ostream &  os) const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::Operator< F >.

template<typename F >
void concepts::DiagonalSolver< F >::operator() ( const Function< c_type > &  fncY,
Function< c_type > &  fncX 
) [virtual]

Application operator for complex function fncY.

Computes fncX = A(fncY) where A is this operator. fncX becomes complex.

In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.

If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.

Reimplemented from concepts::Operator< F >.

Definition at line 165 of file diagonal.hh.

template<typename F >
void concepts::DiagonalSolver< F >::operator() ( const Function< r_type > &  fncY,
Function< F > &  fncX 
) [virtual]

Application operator for real function fncY.

Computes fncX = A(fncY) where A is this operator.

fncX becomes the type of the operator, for real data it becomes real, for complex data it becomes complex.

In derived classes its enough to implement the operator() for real Operator's. If a complex counterpart is not implemented, the function fncY is transformed to a complex function and then the application operator for complex functions is called.

If in a derived class the operator() for real Operator's is not implemented, a exception is thrown from here.

Reimplemented from concepts::Operator< F >.

Definition at line 157 of file diagonal.hh.

template<typename F>
void concepts::DiagonalSolver< F >::operator() ( const Matrix< r_type > &  mX,
Matrix< F > &  mY 
)

Application method to real matrices.

template<typename F>
void concepts::DiagonalSolver< F >::operator() ( const Matrix< c_type > &  mX,
Matrix< c_type > &  mY 
)

Application method to complex matrices.


Member Data Documentation

template<class F>
uint concepts::Operator< F >::dimX_ [protected, inherited]

Dimension of image space and the source space.

Definition at line 96 of file compositions.hh.

template<class F>
uint concepts::Operator< F >::dimY_ [protected, inherited]

Definition at line 96 of file compositions.hh.

template<typename F>
DiagonalMatrix<F> concepts::DiagonalSolver< F >::inverse_ [private]

Definition at line 148 of file diagonal.hh.


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

Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)