Teko Version of the Day
Public Member Functions
Teko::NS::SIMPLEPreconditionerFactory Class Reference

#include <Teko_SIMPLEPreconditionerFactory.hpp>

Inheritance diagram for Teko::NS::SIMPLEPreconditionerFactory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SIMPLEPreconditionerFactory ()
 Default constructor.
LinearOp buildPreconditionerOperator (BlockedLinearOp &blo, BlockPreconditionerState &state) const
 Function that is called to build the preconditioner for the linear operator that is passed in.
virtual void setMassMatrix (Teko::LinearOp &mass)
 Set the mass matrix for this factory.
virtual Teuchos::RCP
< Teuchos::ParameterList > 
getRequestedParameters () const
 For assisting in construction of the preconditioner.
virtual bool updateRequestedParameters (const Teuchos::ParameterList &pl)
 For assisting in construction of the preconditioner.
virtual void initializeFromParameterList (const Teuchos::ParameterList &pl)
 Initialize from a parameter list.

Detailed Description

The basic XML parameter list for SIMPLE looks like.

    <ParameterList name="SIMPLEC">
      <Parameter name="Type" type="string" value="NS SIMPLE"/>

      <!-- Inverse operations to use -->
      <Parameter name="Inverse Velocity Type" type="string" value="ML_GS-Velocity"/>
      <Parameter name="Inverse Pressure Type" type="string" value="ML_GS-Pressure"/>

      <Parameter name="Explicit Velocity Inverse Type" type="string" value="AbsRowSum"/>

      <Parameter name="Alpha" type="double" value="0.9"/>
    </ParameterList>

Definition at line 73 of file Teko_SIMPLEPreconditionerFactory.hpp.


Constructor & Destructor Documentation

Teko::NS::SIMPLEPreconditionerFactory::SIMPLEPreconditionerFactory ( )

Default constructor.

Definition at line 83 of file Teko_SIMPLEPreconditionerFactory.cpp.


Member Function Documentation

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

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

This function builds a preconditioner based on the passed in BlockedLinearOp.

Parameters:
[in]bloSource linear operator that is to be preconditioned.
[in]stateAn object associated with this operator to store the preconditioner state.
Returns:
The preconditioner as a linear operator (i.e. to perform a matrix-vector operation simply call "apply").

Implements Teko::BlockPreconditionerFactory.

Definition at line 89 of file Teko_SIMPLEPreconditionerFactory.cpp.

virtual void Teko::NS::SIMPLEPreconditionerFactory::setMassMatrix ( Teko::LinearOp &  mass) [inline, virtual]

Set the mass matrix for this factory.

Definition at line 92 of file Teko_SIMPLEPreconditionerFactory.hpp.

Teuchos::RCP< Teuchos::ParameterList > Teko::NS::SIMPLEPreconditionerFactory::getRequestedParameters ( ) const [virtual]

For assisting in construction of the preconditioner.

For assiting in construction of the preconditioner.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 303 of file Teko_SIMPLEPreconditionerFactory.cpp.

bool Teko::NS::SIMPLEPreconditionerFactory::updateRequestedParameters ( const Teuchos::ParameterList &  pl) [virtual]

For assisting in construction of the preconditioner.

For assiting in construction of the preconditioner.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 341 of file Teko_SIMPLEPreconditionerFactory.cpp.

void Teko::NS::SIMPLEPreconditionerFactory::initializeFromParameterList ( const Teuchos::ParameterList &  pl) [virtual]

Initialize from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 226 of file Teko_SIMPLEPreconditionerFactory.cpp.


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