Teko Version of the Day
Public Member Functions | Protected Member Functions
Teko::MLPreconditionerFactory Class Reference

Class that constructs and returns an ML preconditioner object that is capable of doing block smoothing. More...

#include <Teko_MLPreconditionerFactory.hpp>

Inheritance diagram for Teko::MLPreconditionerFactory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual LinearOp buildPreconditionerOperator (BlockedLinearOp &blo, BlockPreconditionerState &state) const
 Function that is called to build the preconditioner for the linear operator that is passed in.
virtual Teuchos::RCP
< PreconditionerState
buildPreconditionerState () const
 Function that permits the construction of an arbitrary PreconditionerState object.
void initializeFromParameterList (const Teuchos::ParameterList &settings)
 This function builds the internals of the preconditioner factory from a parameter list.

Protected Member Functions

void fillMLPreconditionerState (const BlockedLinearOp &blo, MLPreconditionerState &mlState) const
 Fills an ML preconditioner state object.

Detailed Description

Class that constructs and returns an ML preconditioner object that is capable of doing block smoothing.

Definition at line 61 of file Teko_MLPreconditionerFactory.hpp.


Member Function Documentation

LinearOp Teko::MLPreconditionerFactory::buildPreconditionerOperator ( BlockedLinearOp &  blo,
BlockPreconditionerState state 
) const [virtual]

Function that is called to build the preconditioner for the linear operator that is passed in.

Implements Teko::BlockPreconditionerFactory.

Definition at line 77 of file Teko_MLPreconditionerFactory.cpp.

Teuchos::RCP< PreconditionerState > Teko::MLPreconditionerFactory::buildPreconditionerState ( ) const [virtual]

Function that permits the construction of an arbitrary PreconditionerState object.

Reimplemented from Teko::BlockPreconditionerFactory.

Definition at line 92 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerFactory::initializeFromParameterList ( const Teuchos::ParameterList &  settings) [virtual]

This function builds the internals of the preconditioner factory from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 152 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerFactory::fillMLPreconditionerState ( const BlockedLinearOp &  blo,
MLPreconditionerState mlState 
) const [protected]

Fills an ML preconditioner state object.

Note:
This function assumes the blocked linear operator is flat and no nesting has occured. (Each operator is actually a Epetra_CrsMatrix)

Definition at line 97 of file Teko_MLPreconditionerFactory.cpp.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables