Teko Version of the Day
Public Member Functions
Teko::DiagnosticPreconditionerFactory Class Reference

A class which builds a diagnostic operator to wrap the application of the inverse operator. Also times the construction of the inverse operator. More...

#include <Teko_DiagnosticPreconditionerFactory.hpp>

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

List of all members.

Public Member Functions

 DiagnosticPreconditionerFactory ()
 Default constructor, for use with the AutoClone class.
 DiagnosticPreconditionerFactory (const Teuchos::RCP< Teko::InverseFactory > &invFactory, const std::string &label, const Teuchos::RCP< std::ostream > &os=Teuchos::null, bool printResidual=false)
virtual ~DiagnosticPreconditionerFactory ()
 default destructor: prints out diagnostic string
virtual LinearOp buildPreconditionerOperator (LinearOp &lo, PreconditionerState &state) const
 Function that is called to build the preconditioner for the linear operator that is passed in.
Methods for construction from a parameter list entry
virtual void initializeFromParameterList (const Teuchos::ParameterList &settings)
 This function builds the internals of the preconditioner factory from a parameter list.
virtual Teuchos::RCP
< Teuchos::ParameterList > 
getRequestedParameters () const
 Request the additional parameters this preconditioner factory needs.
virtual bool updateRequestedParameters (const Teuchos::ParameterList &pl)
 Update this object with the fields from a parameter list.

Detailed Description

A class which builds a diagnostic operator to wrap the application of the inverse operator. Also times the construction of the inverse operator.

For construction purposes this class can be initialized using a parameter list. Most often used in conjuncition with an InverseLibrary object. In particular the relevant parameters are

       <Parameter name="Type" type="string" value="Diagnostic Inverse"/>
       <Parameter name="Inverse Factory" type="string" value="<Some Inverse Factory>"/>
       <Parameter name="Descriptive Label" type="string" value="<Some Label>"/>
       <Parameter name="Print Residual" type="bool" value="false"/>

Definition at line 72 of file Teko_DiagnosticPreconditionerFactory.hpp.


Constructor & Destructor Documentation

Teko::DiagnosticPreconditionerFactory::DiagnosticPreconditionerFactory ( )

Default constructor, for use with the AutoClone class.

Definition at line 58 of file Teko_DiagnosticPreconditionerFactory.cpp.

Teko::DiagnosticPreconditionerFactory::DiagnosticPreconditionerFactory ( const Teuchos::RCP< Teko::InverseFactory > &  invFactory,
const std::string &  label,
const Teuchos::RCP< std::ostream > &  os = Teuchos::null,
bool  printResidual = false 
)

Construct a preconditioner factory that prints diagnostics about a particualar inverse operator.

Parameters:
[in]invFactoryFactory and operator to use diagnostics
[in]labelLabel to give to factory and operator

Construct a preconditioner factory that applies a specified preconditioner, a fixed number of times.

Definition at line 65 of file Teko_DiagnosticPreconditionerFactory.cpp.

Teko::DiagnosticPreconditionerFactory::~DiagnosticPreconditionerFactory ( ) [virtual]

default destructor: prints out diagnostic string

Definition at line 75 of file Teko_DiagnosticPreconditionerFactory.cpp.


Member Function Documentation

LinearOp Teko::DiagnosticPreconditionerFactory::buildPreconditionerOperator ( LinearOp &  lo,
PreconditionerState 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 LinearOp.

Parameters:
[in]loSource 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::PreconditionerFactory.

Definition at line 121 of file Teko_DiagnosticPreconditionerFactory.cpp.

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

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

This function builds the internals of the preconditioner factory from a parameter list. Furthermore, it allows a preconditioner factory developer to easily add a factory to the build system. This function is required for building a preconditioner from a parameter list.

Parameters:
[in]settingsParmaeter list to use as the internal settings

Reimplemented from Teko::PreconditionerFactory.

Definition at line 174 of file Teko_DiagnosticPreconditionerFactory.cpp.

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

Request the additional parameters this preconditioner factory needs.

Request the additonal parameters needed by this preconditioner factory. The parameter list will have a set of fields that can be filled with the requested values. These fields include all requirements, even those of the sub-solvers if there are any. Once correctly filled the object can be updated by calling the updateRequestedParameters with the filled parameter list.

Returns:
A parameter list with the requested parameters.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 202 of file Teko_DiagnosticPreconditionerFactory.cpp.

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

Update this object with the fields from a parameter list.

Update the requested fields using a parameter list. This method is expected to pair with the getRequestedParameters method (i.e. the fields requested are going to be update using this method).

Parameters:
[in]plParameter list containing the requested parameters.
Returns:
If the method succeeded (found all its required parameters) this method returns true, otherwise it returns false.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 213 of file Teko_DiagnosticPreconditionerFactory.cpp.


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