Class documentation of Concepts

Loading...
Searching...
No Matches
cluster::Operator01< NodeX, NodeY > Class Template Reference

#include <operator01.hh>

Inheritance diagram for cluster::Operator01< NodeX, NodeY >:
concepts::Operator< TreeTraits< NodeX >::F > concepts::OutputOperator

Classes

class  NfldMatrix
 

Public Types

typedef TreeTraits< NodeX > TraitsX
 Interface for the operator.
 
typedef TreeTraits< NodeY > TraitsY
 
typedef TraitsX::F FX
 
typedef TraitsY::F FY
 
typedef TreeTraits< NodeX >::F type
 Type of data, e.g. matrix entries.
 
typedef Realtype< TreeTraits< NodeX >::F >::type r_type
 Real type of data type.
 
typedef Cmplxtype< TreeTraits< NodeX >::F >::type c_type
 Real type of data type.
 

Public Member Functions

 Operator01 (concepts::BilinearForm< FX > &bf, ClstF< NodeX, NodeY > &F, ClstX< NodeX > &X, ClstY< NodeY > &Y)
 
void operator() (const concepts::Function< FY > &fncY, concepts::Function< FX > &fncX)
 
void operator() (const concepts::Vector< FY > &fncY, concepts::Vector< FX > &fncX)
 
float memory () const
 
const concepts::Space< FX > & spaceX () const
 
const concepts::Space< FY > & spaceY () const
 
virtual void operator() (const Function< r_type > &fncY, Function< TreeTraits< NodeX >::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

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 NodeX, class NodeY>
class cluster::Operator01< NodeX, NodeY >

Cluster approximation of the stiffness matrix.

Parameters
NodeXNode of a cluster tree
NodeYNode of a cluster tree

Definition at line 33 of file operator01.hh.

Member Typedef Documentation

◆ c_type

typedef Cmplxtype<TreeTraits< NodeX >::F >::type concepts::Operator< TreeTraits< NodeX >::F >::c_type
inherited

Real type of data type.

Definition at line 49 of file compositions.hh.

◆ FX

template<class NodeX , class NodeY >
typedef TraitsX::F cluster::Operator01< NodeX, NodeY >::FX

Definition at line 38 of file operator01.hh.

◆ FY

template<class NodeX , class NodeY >
typedef TraitsY::F cluster::Operator01< NodeX, NodeY >::FY

Definition at line 39 of file operator01.hh.

◆ r_type

typedef Realtype<TreeTraits< NodeX >::F >::type concepts::Operator< TreeTraits< NodeX >::F >::r_type
inherited

Real type of data type.

Definition at line 47 of file compositions.hh.

◆ TraitsX

template<class NodeX , class NodeY >
typedef TreeTraits<NodeX> cluster::Operator01< NodeX, NodeY >::TraitsX

Interface for the operator.

Definition at line 36 of file operator01.hh.

◆ TraitsY

template<class NodeX , class NodeY >
typedef TreeTraits<NodeY> cluster::Operator01< NodeX, NodeY >::TraitsY

Definition at line 37 of file operator01.hh.

◆ type

typedef TreeTraits< NodeX >::F concepts::Operator< TreeTraits< NodeX >::F >::type
inherited

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

◆ Operator01()

template<class NodeX , class NodeY >
cluster::Operator01< NodeX, NodeY >::Operator01 ( concepts::BilinearForm< FX > &  bf,
ClstF< NodeX, NodeY > &  F,
ClstX< NodeX > &  X,
ClstY< NodeY > &  Y 
)

Constructor.

Parameters
bfBilinear form to compute the near field entries
FFar field approximation F
XFar field approximation X
YFar field approximation Y

Member Function Documentation

◆ dimX()

virtual const uint concepts::Operator< TreeTraits< NodeX >::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()

virtual const uint concepts::Operator< TreeTraits< NodeX >::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<class NodeX , class NodeY >
std::ostream & cluster::Operator01< NodeX, NodeY >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::Operator< TreeTraits< NodeX >::F >.

◆ memory()

template<class NodeX , class NodeY >
float cluster::Operator01< NodeX, NodeY >::memory ( ) const

Memory usage of the operator and the near field (without the far field approximation) in byte.

◆ operator()() [1/4]

virtual void concepts::Operator< TreeTraits< NodeX >::F >::operator() ( )
virtualinherited

Application operator without argument

◆ operator()() [2/4]

template<class NodeX , class NodeY >
void cluster::Operator01< NodeX, NodeY >::operator() ( const concepts::Function< FY > &  fncY,
concepts::Function< FX > &  fncX 
)
Exceptions
MissingFeature

◆ operator()() [3/4]

virtual void concepts::Operator< TreeTraits< NodeX >::F >::operator() ( const Function< c_type > &  fncY,
Function< c_type > &  fncX 
)
virtualinherited

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.

◆ operator()() [4/4]

virtual void concepts::Operator< TreeTraits< NodeX >::F >::operator() ( const Function< r_type > &  fncY,
Function< TreeTraits< NodeX >::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.

◆ show_messages()

virtual void concepts::Operator< TreeTraits< NodeX >::F >::show_messages ( )
inlinevirtualinherited

Definition at line 100 of file compositions.hh.

◆ spaceX()

template<class NodeX , class NodeY >
const concepts::Space< FX > & cluster::Operator01< NodeX, NodeY >::spaceX ( ) const
inline

Definition at line 103 of file operator01.hh.

◆ spaceY()

template<class NodeX , class NodeY >
const concepts::Space< FY > & cluster::Operator01< NodeX, NodeY >::spaceY ( ) const
inline

Definition at line 104 of file operator01.hh.

Member Data Documentation

◆ dimX_

uint concepts::Operator< TreeTraits< NodeX >::F >::dimX_
protectedinherited

Dimension of image space and the source space.

Definition at line 104 of file compositions.hh.

◆ dimY_

uint concepts::Operator< TreeTraits< NodeX >::F >::dimY_
protectedinherited

Definition at line 104 of file compositions.hh.


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