NOX::Belos::PreconditionOperator Class Reference

Implementation of Belos::Operator for a preconditioner defined by a NOX::Abstract::Group. More...

#include <NOX_Belos_PreconditionOperator.H>

Collaboration diagram for NOX::Belos::PreconditionOperator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 PreconditionOperator (NOX::Abstract::Group &g, NOX::Parameter::List &preconditionerParameters)
 Constructor.
virtual ~PreconditionOperator ()
 Destructor.
virtual ::Belos::ReturnType Apply (const ::Belos::MultiVec< double > &x,::Belos::MultiVec< double > &y,::Belos::ETrans trans=::Belos::NOTRANS) const
 Apply operator.
virtual ::Belos::ReturnType ApplyInverse (const ::Belos::MultiVec< double > &x,::Belos::MultiVec< double > &y,::Belos::ETrans trans=::Belos::NOTRANS) const
 ApplyInverse operator.

Protected Member Functions

::Belos::ReturnType noxReturnTypeToBelos (NOX::Abstract::Group::ReturnType noxStatus) const
 Converts NOX::Abstract::Group::ReturnType to the corresponding Belos type.

Protected Attributes

NOX::Abstract::Groupgrp
 Underlying group.
NOX::Parameter::List & precondParams
 Parameter list for applyRightPreconditioning.


Detailed Description

Implementation of Belos::Operator for a preconditioner defined by a NOX::Abstract::Group.

This class implements the Belos::Operator interface representing a preconditioner operation using the NOX::Abstract::Group. It implements the operator Apply() method via applyRightPreconditioningMultiVector.

Definition at line 62 of file NOX_Belos_PreconditionOperator.H.


Constructor & Destructor Documentation

NOX::Belos::PreconditionOperator::PreconditionOperator ( NOX::Abstract::Group g,
NOX::Parameter::List &  preconditionerParameters 
)

Constructor.

Definition at line 47 of file NOX_Belos_PreconditionOperator.C.

NOX::Belos::PreconditionOperator::~PreconditionOperator (  )  [virtual]

Destructor.

Definition at line 56 of file NOX_Belos_PreconditionOperator.C.


Member Function Documentation

Belos::ReturnType NOX::Belos::PreconditionOperator::Apply ( const ::Belos::MultiVec< double > &  x,
::Belos::MultiVec< double > &  y,
::Belos::ETrans  trans = ::Belos::NOTRANS 
) const

Apply operator.

Calls underlying group's applyRightPreconditioningMultiVector

Definition at line 61 of file NOX_Belos_PreconditionOperator.C.

References NOX::Abstract::Group::applyRightPreconditioningMultiVector(), NOX::Belos::MultiVector::getNoxMultiVector(), grp, noxReturnTypeToBelos(), and precondParams.

Belos::ReturnType NOX::Belos::PreconditionOperator::ApplyInverse ( const ::Belos::MultiVec< double > &  x,
::Belos::MultiVec< double > &  y,
::Belos::ETrans  trans = ::Belos::NOTRANS 
) const

ApplyInverse operator.

Returns Belos::Undefined

Definition at line 92 of file NOX_Belos_PreconditionOperator.C.

Belos::ReturnType NOX::Belos::PreconditionOperator::noxReturnTypeToBelos ( NOX::Abstract::Group::ReturnType  noxStatus  )  const [protected]


Member Data Documentation

Underlying group.

Definition at line 103 of file NOX_Belos_PreconditionOperator.H.

Referenced by Apply().

NOX::Parameter::List& NOX::Belos::PreconditionOperator::precondParams [protected]

Parameter list for applyRightPreconditioning.

Definition at line 106 of file NOX_Belos_PreconditionOperator.H.

Referenced by Apply().


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

Generated on Thu Dec 17 11:03:04 2009 for Nonlinear Solver Project by  doxygen 1.5.9