concepts::ShiftAndInvertOperatorForGEVPs< F > Class Template Reference

#include <gevp_solver.hh>

Inheritance diagram for concepts::ShiftAndInvertOperatorForGEVPs< F >:
concepts::VecOperator< 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

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...
 
getShift ()
 
void operator() ()
 Application method without second argument. Used for parallel solvers. More...
 
virtual void operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
 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...
 
void operator() (const Matrix< c_type > &mX, Matrix< c_type > &mY)
 Application method to complex matrices. Calls apply_() More...
 
void operator() (const Matrix< r_type > &mX, Matrix< F > &mY)
 Application method to real matrices. Calls function apply() More...
 
virtual void operator() (const Vector< c_type > &fncY, Vector< c_type > &fncX)
 Application operator for complex function fncY. More...
 
virtual void operator() (const Vector< r_type > &fncY, Vector< F > &fncX)
 Application operator for real vector fncY. More...
 
 ShiftAndInvertOperatorForGEVPs (SparseMatrix< F > &A, SparseMatrix< F > &B, F shift)
 
virtual void show_messages ()
 
virtual ~ShiftAndInvertOperatorForGEVPs ()
 

Protected Member Functions

virtual void apply_ ()
 Intrinsic application method without argument. More...
 
virtual void apply_ (const Vector< F > &fncY, Vector< F > &fncX)
 Intrinsic application method, i.e. More...
 
virtual std::ostream & info (std::ostream &os) const
 

Protected Attributes

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

Private Attributes

SparseMatrix< F > & _B
 
_shift
 
std::unique_ptr< SuperLU< F > > _shift_and_invert_pointer
 

Detailed Description

template<class F>
class concepts::ShiftAndInvertOperatorForGEVPs< F >

Definition at line 18 of file gevp_solver.hh.

Member Typedef Documentation

◆ c_type

template<class F >
typedef Cmplxtype<F>::type concepts::VecOperator< F >::c_type
inherited

Real type of data type.

Definition at line 120 of file compositions.hh.

◆ r_type

template<class F >
typedef Realtype<F>::type concepts::VecOperator< F >::r_type
inherited

Real type of data type.

Definition at line 118 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

◆ ShiftAndInvertOperatorForGEVPs()

template<class F >
concepts::ShiftAndInvertOperatorForGEVPs< F >::ShiftAndInvertOperatorForGEVPs ( SparseMatrix< F > &  A,
SparseMatrix< F > &  B,
shift 
)
inline

Definition at line 22 of file gevp_solver.hh.

◆ ~ShiftAndInvertOperatorForGEVPs()

template<class F >
virtual concepts::ShiftAndInvertOperatorForGEVPs< F >::~ShiftAndInvertOperatorForGEVPs ( )
inlinevirtual

Definition at line 35 of file gevp_solver.hh.

Member Function Documentation

◆ apply_() [1/2]

template<class F >
virtual void concepts::ShiftAndInvertOperatorForGEVPs< F >::apply_ ( )
inlineprotectedvirtual

Intrinsic application method without argument.

Implements concepts::VecOperator< F >.

Definition at line 56 of file gevp_solver.hh.

◆ apply_() [2/2]

template<class F >
virtual void concepts::ShiftAndInvertOperatorForGEVPs< F >::apply_ ( const Vector< F > &  fncY,
Vector< F > &  fncX 
)
inlineprotectedvirtual

Intrinsic application method, i.e.

real Operator and real Vector or complex Operator and real Vector.

Implements concepts::VecOperator< F >.

Definition at line 49 of file gevp_solver.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.

◆ getShift()

template<class F >
F concepts::ShiftAndInvertOperatorForGEVPs< F >::getShift ( )

◆ info()

template<class F >
virtual std::ostream& concepts::ShiftAndInvertOperatorForGEVPs< F >::info ( std::ostream &  os) const
inlineprotectedvirtual

Reimplemented from concepts::VecOperator< F >.

Definition at line 43 of file gevp_solver.hh.

◆ operator()() [1/7]

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

Application method without second argument. Used for parallel solvers.

Reimplemented from concepts::Operator< F >.

◆ operator()() [2/7]

template<class F >
virtual void concepts::VecOperator< 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.

Reimplemented from concepts::Operator< F >.

◆ operator()() [3/7]

template<class F >
virtual void concepts::VecOperator< 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 from concepts::Operator< F >.

◆ operator()() [4/7]

template<class F >
void concepts::VecOperator< F >::operator() ( const Matrix< c_type > &  mX,
Matrix< c_type > &  mY 
)
inherited

Application method to complex matrices. Calls apply_()

◆ operator()() [5/7]

template<class F >
void concepts::VecOperator< F >::operator() ( const Matrix< r_type > &  mX,
Matrix< F > &  mY 
)
inherited

Application method to real matrices. Calls function apply()

◆ operator()() [6/7]

template<class F >
virtual void concepts::VecOperator< F >::operator() ( const Vector< c_type > &  fncY,
Vector< 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 vector fncY is splitted into real and imaginary part and the application operator for real vectors is called for each. Then the result is combined

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

◆ operator()() [7/7]

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

Application operator for real vector fncY.

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

Type of fncX becomes that 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 vector fncY is transformed to a complex vector and then the application for complex vectors is called.

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

◆ 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

◆ _B

template<class F >
SparseMatrix<F>& concepts::ShiftAndInvertOperatorForGEVPs< F >::_B
private

Definition at line 61 of file gevp_solver.hh.

◆ _shift

template<class F >
F concepts::ShiftAndInvertOperatorForGEVPs< F >::_shift
private

Definition at line 67 of file gevp_solver.hh.

◆ _shift_and_invert_pointer

template<class F >
std::unique_ptr<SuperLU<F> > concepts::ShiftAndInvertOperatorForGEVPs< F >::_shift_and_invert_pointer
private

Definition at line 65 of file gevp_solver.hh.

◆ 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:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich