A solver for diagonal matrices. More...

#include <diagonal.hh>

Inheritance diagram for concepts::DiagonalSolver< F >:
concepts::Operator< F >

Public Types

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

Public Member Functions

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

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 

Protected Attributes

uint dimX_
 Dimension of image space and the source space. More...
 
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 142 of file diagonal.hh.

Member Typedef Documentation

◆ c_type

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

Real type of data type.

Definition at line 147 of file diagonal.hh.

◆ r_type

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

Real type of data type.

Definition at line 145 of file diagonal.hh.

◆ type

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

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

◆ DiagonalSolver()

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

Constructor.

Parameters
mDiagonal matrix to be inverted

◆ ~DiagonalSolver()

template<typename F >
virtual concepts::DiagonalSolver< F >::~DiagonalSolver ( )
virtual

Member Function Documentation

◆ apply_()

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

Definition at line 190 of file diagonal.hh.

◆ dimX()

template<class F >
virtual const uint concepts::Operator< F >::dimX ( ) const
inlinevirtualinherited

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

Definition at line 93 of file compositions.hh.

◆ dimY()

template<class F >
virtual const uint concepts::Operator< F >::dimY ( ) const
inlinevirtualinherited

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

Definition at line 98 of file compositions.hh.

◆ info()

template<typename F >
virtual std::ostream& concepts::DiagonalSolver< F >::info ( std::ostream &  os) const
protectedvirtual

Reimplemented from concepts::Operator< F >.

◆ operator()() [1/6]

template<class F >
virtual void concepts::Operator< F >::operator() ( )
virtualinherited

◆ operator()() [2/6]

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 183 of file diagonal.hh.

◆ operator()() [3/6]

template<class F >
virtual void concepts::Operator< F >::operator() ( const Function< r_type > &  fncY,
Function< F > &  fncX 
)
virtualinherited

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 in concepts::VecOperator< T >, concepts::VecOperator< Real >, concepts::LiCo< F >, concepts::LiCoI< F >, concepts::Multiple< F >, concepts::VecOperator< F >, concepts::VecOperator< F::d_type >, and concepts::VecOperator< Cmplx >.

◆ operator()() [4/6]

template<typename F >
void concepts::DiagonalSolver< F >::operator() ( const Function< r_type > &  rhs,
Function< F > &  sol 
)
virtual

Definition at line 175 of file diagonal.hh.

◆ operator()() [5/6]

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

Application method to complex matrices.

◆ operator()() [6/6]

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

Application method to real matrices.

◆ show_messages()

template<class F >
virtual void concepts::Operator< F >::show_messages ( )
inlinevirtualinherited

Reimplemented in concepts::Newton< F >, concepts::MumpsOverlap< F >, and concepts::Mumps< F >.

Definition at line 100 of file compositions.hh.

Member Data Documentation

◆ dimX_

template<class F >
uint concepts::Operator< F >::dimX_
protectedinherited

Dimension of image space and the source space.

Definition at line 104 of file compositions.hh.

◆ dimY_

template<class F >
uint concepts::Operator< F >::dimY_
protectedinherited

Definition at line 104 of file compositions.hh.

◆ inverse_

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

Definition at line 166 of file diagonal.hh.


The documentation for this class was generated from the following file:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich