Class documentation of Concepts

Loading...
Searching...
No Matches

#include <compositions.hh>

Inheritance diagram for concepts::Multiple< F >:
concepts::Operator< F > concepts::OutputOperator

Public Types

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

Public Member Functions

 Multiple (Operator< F > &A, F a)
 
void operator() (const Function< r_type > &fncY, Function< F > &fncX)
 
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::Multiple< F >

Multiple of an operator.

Definition at line 251 of file compositions.hh.

Member Typedef Documentation

◆ c_type

template<class F >
typedef Cmplxtype<F>::type concepts::Multiple< F >::c_type

Real type of data type.

Definition at line 256 of file compositions.hh.

◆ r_type

template<class F >
typedef Realtype<F>::type concepts::Multiple< F >::r_type

Real type of data type.

Definition at line 254 of file compositions.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

◆ Multiple()

template<class F >
concepts::Multiple< F >::Multiple ( Operator< F > &  A,
a 
)
inline

Definition at line 258 of file compositions.hh.

Member Function Documentation

◆ 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)

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
inlinevirtualinherited

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::Multiple< F >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::Operator< F >.

◆ operator()() [1/3]

◆ operator()() [2/3]

template<class F >
void concepts::Multiple< F >::operator() ( const Function< c_type > &  fncY,
Function< c_type > &  fncX 
)
inlinevirtual

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 272 of file compositions.hh.

◆ operator()() [3/3]

template<class F >
void concepts::Multiple< F >::operator() ( const Function< r_type > &  fncY,
Function< F > &  fncX 
)
inlinevirtual

Application operator. Calculates

\[ x=a \cdot Ay\]

where $A$ is the matrix and $a$ its respective coefficient.

Parameters
fncY$y$
fncX$x$

Reimplemented from concepts::Operator< F >.

Definition at line 268 of file compositions.hh.

◆ show_messages()

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

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_
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.


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