concepts::Operator< F > Class Template Reference

#include <compositions.hh>

Inheritance diagram for concepts::Operator< F >:

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

Public Member Functions
	Operator (uint dimX, uint dimY)
virtual void	operator() (const Function< r_type > &fncY, Function< F > &fncX)
virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
virtual void	operator() ()
virtual const uint	dimX () const
virtual const uint	dimY () const
virtual void	show_messages ()

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_

Detailed Description

template<class F>
class concepts::Operator< F >

Abstract class for an operator.

Definition at line 42 of file compositions.hh.

Member Typedef Documentation

c_type

template<class F >

typedef Cmplxtype<F>::type concepts::Operator< F >::c_type

Real type of data type.

Definition at line 49 of file compositions.hh.

r_type

template<class F >

typedef Realtype<F>::type concepts::Operator< F >::r_type

Real type of data type.

Definition at line 47 of file compositions.hh.

type

template<class F >

typedef F concepts::Operator< F >::type

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

Operator()

template<class F >

concepts::Operator< F >::Operator ( uint  dimX, uint  dimY  )

inline

Definition at line 51 of file compositions.hh.

~Operator()

template<class F >

virtual concepts::Operator< F >::~Operator ( )

inlinevirtual

Definition at line 52 of file compositions.hh.

Member Function Documentation

dimX()

template<class F >

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

inlinevirtual

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

Examples

hpFEM2d-simple.cc, hpFEM2d.cc, and matfileTutorial.cc.

Definition at line 93 of file compositions.hh.

dimY()

template<class F >

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

inlinevirtual

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

Examples

matfileTutorial.cc.

Definition at line 98 of file compositions.hh.

info()

template<class F >

virtual std::ostream & concepts::Operator< F >::info ( std::ostream &  os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in concepts::Mumps< F >, concepts::MumpsOverlap< F >, aglowav::C2W< F >, aglowav::W2C< F >, aglowav::C2_tl2< F >, aglowav::C2tl2< F >, aglowav::CGt2< F >, aglowav::ComposeN< F >, aglowav2::Operator00< F >, aglowav2::C2W< F >, aglowav2::W2C< F >, bem::D< F >, bem::D_1< F >, cluster::Operator01< NodeX, NodeY >, cluster::Operator02< NodeX, NodeY >, concepts::ShiftAndInvertOperatorForGEVPs< F >, hp3D::SpaceTransition, concepts::AfterIteration< F >, concepts::BelosSolver< T >, concepts::BiCGStab< F, G >, concepts::CG< F >, concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, concepts::VecOperator< T >, concepts::Compose< F, H >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::Constrained, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::DiagonalSolver< F >, concepts::DDSolver< F, G >, concepts::GMRes< F >, concepts::LapackChol, concepts::NRLSolver, concepts::Pardiso, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::TrivExtendRestrict< F >, concepts::TrivExtendRestrict< Real >, concepts::PETSc, concepts::PETScMat, concepts::SolverConjugate, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::Spooles, concepts::SubMatrixN< F >, concepts::SuperLU< F >, concepts::Transpose< F >, concepts::Umfpack, sparseqr::Driver, sparseqr::GivensRotations< F >, sparseqr::GivensRotations< Real >, vectorial::BlockOperator< F >, vectorial::BramblePasciak, and vectorial::CGUzawa.

operator()() [1/3]

template<class F >

virtual void concepts::Operator< F >::operator() ( )

virtual

Application operator without argument

Reimplemented in concepts::BelosSolver< T >, concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, and concepts::VecOperator< T >.

operator()() [2/3]

template<class F >

virtual void concepts::Operator< 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 in concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, concepts::VecOperator< T >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, concepts::Transpose< F >, concepts::Matrix< F >, concepts::Matrix< F::type >, concepts::Matrix< FX >, concepts::Matrix< Real >, and concepts::DiagonalSolver< F >.

operator()() [3/3]

template<class F >

virtual void concepts::Operator< 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 in aglowav::C2W< F >, aglowav2::C2W< F >, aglowav::W2C< F >, aglowav2::W2C< F >, aglowav::C2_tl2< F >, aglowav::C2tl2< F >, aglowav::CGt2< F >, aglowav::ComposeN< F >, aglowav2::Operator00< F >, bem::D< F >, bem::D_1< F >, concepts::TrivExtendRestrict< F >, sparseqr::GivensRotations< F >, vectorial::BlockOperator< F >, concepts::TrivExtendRestrict< Real >, sparseqr::GivensRotations< Real >, concepts::AfterIteration< F >, concepts::Compose< F, H >, concepts::DDSolver< F, G >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Matrix< F >, concepts::Matrix< F::type >, and concepts::DiagonalSolver< F >.

show_messages()

template<class F >

virtual void concepts::Operator< F >::show_messages ( )

inlinevirtual

Reimplemented in concepts::MumpsOverlap< F >.

Definition at line 100 of file compositions.hh.

Member Data Documentation

dimX_

template<class F >

uint concepts::Operator< F >::dimX_

protected

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_

protected

Definition at line 104 of file compositions.hh.

---

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

• eigensolver/ARPACK.hh
• operator/compositions.hh