dune-istl  2.4.1-rc2
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Amg::LevelTransferPolicy< FO, CO > Class Template Referenceabstract

Abstract base class for transfer between levels and creation of the coarse level system. More...

#include <dune/istl/paamg/twolevelmethod.hh>

Inheritance diagram for Dune::Amg::LevelTransferPolicy< FO, CO >:
Inheritance graph

Public Types

typedef FO FineOperatorType
 The linear operator of the finel level system. Has to be derived from AssembledLinearOperator. More...
 
typedef
FineOperatorType::range_type 
FineRangeType
 The type of the range of the fine level operator. More...
 
typedef
FineOperatorType::domain_type 
FineDomainType
 The type of the domain of the fine level operator. More...
 
typedef CO CoarseOperatorType
 The linear operator of the finel level system. Has to be derived from AssembledLinearOperator. More...
 
typedef
CoarseOperatorType::range_type 
CoarseRangeType
 The type of the range of the coarse level operator. More...
 
typedef
CoarseOperatorType::domain_type 
CoarseDomainType
 The type of the domain of the coarse level operator. More...
 

Public Member Functions

std::shared_ptr
< CoarseOperatorType > & 
getCoarseLevelOperator ()
 Get the coarse level operator. More...
 
CoarseRangeTypegetCoarseLevelRhs ()
 Get the coarse level right hand side. More...
 
CoarseDomainTypegetCoarseLevelLhs ()
 Get the coarse level left hand side. More...
 
virtual void moveToCoarseLevel (const FineRangeType &fineRhs)=0
 Transfers the data to the coarse level. More...
 
virtual void moveToFineLevel (FineDomainType &fineLhs)=0
 Updates the fine level linear system after the correction of the coarse levels system. More...
 
virtual void createCoarseLevelSystem (const FineOperatorType &fineOperator)=0
 Algebraically creates the coarse level system. More...
 
virtual LevelTransferPolicyclone () const =0
 Clone the current object. More...
 
virtual ~LevelTransferPolicy ()
 Destructor. More...
 

Protected Attributes

CoarseRangeType rhs_
 The coarse level rhs. More...
 
CoarseDomainType lhs_
 The coarse level lhs. More...
 
std::shared_ptr
< CoarseOperatorType
operator_
 the coarse level linear operator. More...
 

Detailed Description

template<class FO, class CO>
class Dune::Amg::LevelTransferPolicy< FO, CO >

Abstract base class for transfer between levels and creation of the coarse level system.

Template Parameters
FOThe type of the linear operator of the finel level system. Has to be derived from AssembledLinearOperator.
COThe type of the linear operator of the coarse level system. Has to be derived from AssembledLinearOperator.

Member Typedef Documentation

template<class FO, class CO>
typedef CoarseOperatorType::domain_type Dune::Amg::LevelTransferPolicy< FO, CO >::CoarseDomainType

The type of the domain of the coarse level operator.

template<class FO, class CO>
typedef CO Dune::Amg::LevelTransferPolicy< FO, CO >::CoarseOperatorType

The linear operator of the finel level system. Has to be derived from AssembledLinearOperator.

template<class FO, class CO>
typedef CoarseOperatorType::range_type Dune::Amg::LevelTransferPolicy< FO, CO >::CoarseRangeType

The type of the range of the coarse level operator.

template<class FO, class CO>
typedef FineOperatorType::domain_type Dune::Amg::LevelTransferPolicy< FO, CO >::FineDomainType

The type of the domain of the fine level operator.

template<class FO, class CO>
typedef FO Dune::Amg::LevelTransferPolicy< FO, CO >::FineOperatorType

The linear operator of the finel level system. Has to be derived from AssembledLinearOperator.

template<class FO, class CO>
typedef FineOperatorType::range_type Dune::Amg::LevelTransferPolicy< FO, CO >::FineRangeType

The type of the range of the fine level operator.

Constructor & Destructor Documentation

template<class FO, class CO>
virtual Dune::Amg::LevelTransferPolicy< FO, CO >::~LevelTransferPolicy ( )
inlinevirtual

Destructor.

Member Function Documentation

template<class FO, class CO>
virtual LevelTransferPolicy* Dune::Amg::LevelTransferPolicy< FO, CO >::clone ( ) const
pure virtual
template<class FO, class CO>
virtual void Dune::Amg::LevelTransferPolicy< FO, CO >::createCoarseLevelSystem ( const FineOperatorType fineOperator)
pure virtual

Algebraically creates the coarse level system.

After returning from this function the coarse level operator can be accessed using getCoarseLevelOperator().

Parameters
fineOperatorThe operator of the fine level system.

Implemented in Dune::Amg::AggregationLevelTransferPolicy< O, C >.

Referenced by Dune::Amg::TwoLevelMethod< FO, CSP, S >::TwoLevelMethod().

template<class FO, class CO>
CoarseDomainType& Dune::Amg::LevelTransferPolicy< FO, CO >::getCoarseLevelLhs ( )
inline

Get the coarse level left hand side.

Returns
The coarse level leftt hand side.

Referenced by Dune::Amg::TwoLevelMethod< FO, CSP, S >::apply().

template<class FO, class CO>
std::shared_ptr<CoarseOperatorType>& Dune::Amg::LevelTransferPolicy< FO, CO >::getCoarseLevelOperator ( )
inline

Get the coarse level operator.

Returns
A shared pointer to the coarse level system.
template<class FO, class CO>
CoarseRangeType& Dune::Amg::LevelTransferPolicy< FO, CO >::getCoarseLevelRhs ( )
inline

Get the coarse level right hand side.

Returns
The coarse level right hand side.

Referenced by Dune::Amg::TwoLevelMethod< FO, CSP, S >::apply().

template<class FO, class CO>
virtual void Dune::Amg::LevelTransferPolicy< FO, CO >::moveToCoarseLevel ( const FineRangeType fineRhs)
pure virtual

Transfers the data to the coarse level.

Restricts the residual to the right hand side of the coarse level system and initialies the left hand side of the coarse level system. These can afterwards be accessed usinf getCoarseLevelRhs() and getCoarseLevelLhs().

Parameters
fineDefectThe current residual of the fine level system.

Referenced by Dune::Amg::TwoLevelMethod< FO, CSP, S >::apply().

template<class FO, class CO>
virtual void Dune::Amg::LevelTransferPolicy< FO, CO >::moveToFineLevel ( FineDomainType fineLhs)
pure virtual

Updates the fine level linear system after the correction of the coarse levels system.

After returning from this function the coarse level correction will have been added to fine level system.

Parameters
[in,out]fineLhsThe left hand side of the fine level to update with the coarse level correction.

Implemented in Dune::Amg::AggregationLevelTransferPolicy< O, C >.

Referenced by Dune::Amg::TwoLevelMethod< FO, CSP, S >::apply().

Member Data Documentation

template<class FO, class CO>
CoarseDomainType Dune::Amg::LevelTransferPolicy< FO, CO >::lhs_
protected
template<class FO, class CO>
std::shared_ptr<CoarseOperatorType> Dune::Amg::LevelTransferPolicy< FO, CO >::operator_
protected

the coarse level linear operator.

Referenced by Dune::Amg::LevelTransferPolicy< O, O >::getCoarseLevelOperator().

template<class FO, class CO>
CoarseRangeType Dune::Amg::LevelTransferPolicy< FO, CO >::rhs_
protected

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