Teko  Version of the Day
 All Classes Files Functions Variables Pages
Public Member Functions | List of all members
Teko::TpetraHelpers::TpetraBlockPreconditioner Class Reference

A single Epetra wrapper for all the BlockPreconditioners. More...

#include <Teko_TpetraBlockPreconditioner.hpp>

Inherits Teko::TpetraHelpers::TpetraInverseOpWrapper.

Public Member Functions

 TpetraBlockPreconditioner (const Teuchos::RCP< const PreconditionerFactory > &bfp)
 Constructor that takes the BlockPreconditionerFactory that will build the preconditioner. More...
 
virtual void initPreconditioner (bool clearOld=false)
 Build the underlying data structure for the preconditioner. More...
 
virtual void buildPreconditioner (const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A, bool clear=true)
 Build this preconditioner from an Epetra_Operator passed in to this object. More...
 
virtual void buildPreconditioner (const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A, const Tpetra::MultiVector< ST, LO, GO, NT > &mv, bool clear=true)
 Build this preconditioner from an Epetra_Operator passed in to this object. It is assumed that this Epetra_Operator. More...
 
virtual void rebuildPreconditioner (const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A)
 Rebuild this preconditioner from an Epetra_Operator passed in this to object. More...
 
virtual void rebuildPreconditioner (const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A, const Tpetra::MultiVector< ST, LO, GO, NT > &mv)
 Rebuild this preconditioner from an Epetra_Operator passed in this to object. More...
 
virtual Teuchos::RCP
< PreconditionerState > 		getPreconditionerState ()
 
virtual Teuchos::RCP< const
PreconditionerState > 		getPreconditionerState () const
 
- Public Member Functions inherited from Teko::TpetraHelpers::TpetraOperatorWrapper
const RCP< const
Thyra::LinearOpBase< ST > > 		getThyraOp () const
 Return the thyra operator associated with this wrapper. More...
 
const RCP< const MappingStrategy > getMapStrategy () const
 Get the mapping strategy for this wrapper (translate between Thyra and Epetra) More...
 
virtual int GetBlockRowCount ()
 Get the number of block rows in this operator. More...
 
virtual int GetBlockColCount ()
 Get the number of block columns in this operator. More...
 
Teuchos::RCP< const
Tpetra::Operator< ST, LO, GO,
NT > > 		GetBlock (int i, int j) const
 Grab the i,j block. More...
 

Detailed Description

A single Epetra wrapper for all the BlockPreconditioners.

This class uses the Thyra based preconditioner factories to build an Epetra_Operator that behaves like a preconditioner. This is done by using the BlockPreconditionerFactory, and letting it build whatever preconditioner is neccessary. Thus the Epetra "layer" is just a single class that handles any generic BlockPreconditionerFactory.

Definition at line 30 of file Teko_TpetraBlockPreconditioner.hpp.

Constructor & Destructor Documentation

Teko::TpetraHelpers::TpetraBlockPreconditioner::TpetraBlockPreconditioner ( const Teuchos::RCP< const PreconditionerFactory > &  bfp)

Constructor that takes the BlockPreconditionerFactory that will build the preconditioner.

Constructor that takes the BlockPreconditionerFactory that will build the preconditioner.

Definition at line 38 of file Teko_TpetraBlockPreconditioner.cpp.

Member Function Documentation

void Teko::TpetraHelpers::TpetraBlockPreconditioner::initPreconditioner ( bool  clearOld = false)
virtual

Build the underlying data structure for the preconditioner.

Build the underlying data structure for the preconditioner. This permits the manipulation of the state object for a preconditioner. and is useful in that case some extra data needs to fill the preconditioner state.

Parameters
[in]clearOldIf true any previously constructed preconditioner will be wiped out and a new one created. If false, a preconditioner will be create only if the current one is empty (i.e. initPreconditioner had not been called).

Definition at line 42 of file Teko_TpetraBlockPreconditioner.cpp.

void Teko::TpetraHelpers::TpetraBlockPreconditioner::buildPreconditioner ( const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &  A,
bool  clear = true 
)
virtual

Build this preconditioner from an Epetra_Operator passed in to this object.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assume that this Epetra_Operator.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assumed that this Epetra_Operator will be a EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
[in]clearIf true, than any previous state saved by the preconditioner is discarded.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assume that this Epetra_Operator will be a EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
Note
This will clear any internal state stored by the state object

Definition at line 59 of file Teko_TpetraBlockPreconditioner.cpp.

void Teko::TpetraHelpers::TpetraBlockPreconditioner::buildPreconditioner ( const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &  A,
const Tpetra::MultiVector< ST, LO, GO, NT > &  tpetra_mv,
bool  clear = true 
)
virtual

Build this preconditioner from an Epetra_Operator passed in to this object. It is assumed that this Epetra_Operator.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assume that this Epetra_Operator.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assumed that this Epetra_Operator will be a EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
[in]mvA vector that was used to build the source operator.
[in]clearIf true, than any previous state saved by the preconditioner is discarded.

Build this preconditioner from an Epetra_Operator passed in to this object. It is assume that this Epetra_Operator will be a EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
[in]srcA vector that was used to build the source operator.
Note
This will clear any internal state stored by the state object

Definition at line 103 of file Teko_TpetraBlockPreconditioner.cpp.

void Teko::TpetraHelpers::TpetraBlockPreconditioner::rebuildPreconditioner ( const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &  A)
virtual

Rebuild this preconditioner from an Epetra_Operator passed in this to object.

Rebuild this preconditioner from an Epetra_Operator passed in this to object. If buildPreconditioner has not been called the preconditioner will be built instead. Otherwise efforts are taken to only rebuild what is neccessary. Also, it is assumed that this Epetra_Operator will be an EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)

Rebuild this preconditioner from an Epetra_Operator passed in this to object. If buildPreconditioner has not been called the preconditioner will be built instead. Otherwise efforts are taken to only rebuild what is neccessary. Also, it is assumed that this Epetra_Operator will be an EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
[in]mvA vector that was used to build the source operator.

Definition at line 152 of file Teko_TpetraBlockPreconditioner.cpp.

void Teko::TpetraHelpers::TpetraBlockPreconditioner::rebuildPreconditioner ( const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &  A,
const Tpetra::MultiVector< ST, LO, GO, NT > &  tpetra_mv 
)
virtual

Rebuild this preconditioner from an Epetra_Operator passed in this to object.

Rebuild this preconditioner from an Epetra_Operator passed in this to object. If buildPreconditioner has not been called the preconditioner will be built instead. Otherwise efforts are taken to only rebuild what is neccessary. Also, it is assumed that this Epetra_Operator will be an EpetraOperatorWrapper object, so the block Thyra components can be easily extracted.

Parameters
[in]AThe Epetra source operator. (Should be a EpetraOperatorWrapper!)
[in]mvA vector that was used to build the source operator.

Definition at line 200 of file Teko_TpetraBlockPreconditioner.cpp.

Teuchos::RCP< PreconditionerState > Teko::TpetraHelpers::TpetraBlockPreconditioner::getPreconditionerState ( )
virtual

Try to get a Teko::PreconditionerState object. This method attempts to cast its internal representation of a preconditioner object to a Teko::BlockPreconditioner object. If it suceeds a state object is returned. Otherwise, Teuchos::null is returned.

Returns
Get the state object associated with this preconditioner. If it doesn't exist for this type of preconditioner factory this method returns null.

Definition at line 253 of file Teko_TpetraBlockPreconditioner.cpp.

Teuchos::RCP< const PreconditionerState > Teko::TpetraHelpers::TpetraBlockPreconditioner::getPreconditionerState ( ) const
virtual

Try to get a Teko::PreconditionerState object. This method attempts to cast its internal representation of a preconditioner object to a Teko::BlockPreconditioner object. If it suceeds a state object is returned. Otherwise, Teuchos::null is returned.

Returns
Get the state object associated with this preconditioner. If it doesn't exist for this type of preconditioner factory this method returns null.

Try to get a Teko::PreconditionerState object. This method attempts to cast its internal representation of a preconditioner object to a Teko::Preconditioner object. If it suceeds a state object is returned. Otherwise, Teuchos::null is returned.

Returns
Get the state object associated with this preconditioner. If it doesn't exist for this type of preconditioner factory this method returns null.

Definition at line 270 of file Teko_TpetraBlockPreconditioner.cpp.

The documentation for this class was generated from the following files:
Generated on Fri Nov 22 2024 09:19:41 for Teko by   doxygen 1.8.5