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

Contains operator internals need for ML. More...

#include <Teko_MLPreconditionerFactory.hpp>

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

Public Member Functions

Teuchos::RCP
< ML_Epetra::MultiLevelPreconditioner > 
constructMLPreconditioner (const Teuchos::ParameterList &mainList, const std::vector< Teuchos::RCP< const Teuchos::ParameterList > > &coarseningParams)
 Build an ML preconditioner object using the set of coarsening parameters. More...
 
void setMLComm (ML_Comm *comm)
 set ML Comm pointer...it will be automatically cleaned up More...
 
void setMLOperator (ML_Operator *op)
 set ML Operator pointer...it will be automatically cleaned up More...
 
void setIsFilled (bool value)
 Set if ML internals been constructed yet. More...
 
void setAggregationMatrices (const std::vector< Epetra_RowMatrix * > &diags)
 Set matrices to build multigrid hierarcy from. More...
 
bool isFilled () const
 Has this object been filled yet. More...
 
- Public Member Functions inherited from Teko::BlockPreconditionerState
virtual void setBlockSourceVector (const Teko::BlockedMultiVector &srcVec)
 Set the vector associated with this operator (think nonlinear system) More...
 
virtual const
Teko::BlockedMultiVector 
getBlockedSourceVector () const
 Set the vector associated with this operator (think nonlinear system) More...
 
- Public Member Functions inherited from Teko::PreconditionerState
virtual bool isInitialized () const
 
virtual void setInitialized (bool init=true)
 
virtual void setSourceVector (const Teko::MultiVector &srcVec)
 Set the vector associated with this operator (think nonlinear system) More...
 
virtual const Teko::MultiVector getSourceVector () const
 Set the vector associated with this operator (think nonlinear system) More...
 
virtual void addInverse (const std::string &name, const Teko::InverseLinearOp &ilo)
 Add a named inverse to the state object. More...
 
virtual Teko::InverseLinearOp getInverse (const std::string &name) const
 Get a named inverse from the state object. More...
 
virtual void addLinearOp (const std::string &name, const Teko::LinearOp &lo)
 Add a named operator to the state object. More...
 
virtual Teko::LinearOp getLinearOp (const std::string &name)
 Add a named operator to the state object. More...
 
virtual void addModifiableOp (const std::string &name, const Teko::ModifiableLinearOp &mlo)
 Add a named operator to the state object. More...
 
virtual Teko::ModifiableLinearOp & getModifiableOp (const std::string &name)
 Add a named operator to the state object. More...
 
virtual void merge (const PreconditionerState &ps, int position=-1)
 Merge internal storage of another PreconditionerState object into this one. More...
 
unsigned int getTag () const
 Get the tag for this operator. More...
 
void setTag (unsigned int tag)
 Set the tag for this operator. More...
 
 PreconditionerState ()
 
 PreconditionerState (const PreconditionerState &src)
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &paramList)
 Set parameters from a parameter list and return with default values. More...
 
Teuchos::RCP
< Teuchos::ParameterList > 
getNonconstParameterList ()
 Get the parameter list that was set using setParameterList(). More...
 
Teuchos::RCP
< Teuchos::ParameterList > 
unsetParameterList ()
 Unset the parameter list that was set using setParameterList(). More...
 

Additional Inherited Members

- Protected Attributes inherited from Teko::PreconditionerState
Teuchos::RCP
< Teuchos::ParameterList > 
paramList_
 for ParameterListAcceptor More...
 
Teko::MultiVector srcVector_
 Store a source vector. More...
 
std::map< std::string,
Teko::InverseLinearOp > 
inverses_
 Store a map of inverse linear operators. More...
 
bool isInitialized_
 Stores the initialization state. More...
 

Detailed Description

Contains operator internals need for ML.

Definition at line 16 of file Teko_MLPreconditionerFactory.hpp.

Member Function Documentation

Teuchos::RCP< ML_Epetra::MultiLevelPreconditioner > Teko::MLPreconditionerState::constructMLPreconditioner ( const Teuchos::ParameterList &  mainList,
const std::vector< Teuchos::RCP< const Teuchos::ParameterList > > &  coarseningParams 
)

Build an ML preconditioner object using the set of coarsening parameters.

Definition at line 41 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerState::setMLComm ( ML_Comm *  comm)

set ML Comm pointer...it will be automatically cleaned up

Definition at line 20 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerState::setMLOperator ( ML_Operator *  op)

set ML Operator pointer...it will be automatically cleaned up

Definition at line 24 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerState::setIsFilled ( bool  value)

Set if ML internals been constructed yet.

Definition at line 29 of file Teko_MLPreconditionerFactory.cpp.

void Teko::MLPreconditionerState::setAggregationMatrices ( const std::vector< Epetra_RowMatrix * > &  diags)

Set matrices to build multigrid hierarcy from.

Definition at line 37 of file Teko_MLPreconditionerFactory.cpp.

bool Teko::MLPreconditionerState::isFilled ( ) const

Has this object been filled yet.

Definition at line 31 of file Teko_MLPreconditionerFactory.cpp.


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