libtrilinos-nox-dev 12.10.1-3 / usr / include / trilinos / LOCA_Epetra_LeftPreconditionedOp.H

// $Id$
// $Source$

//@HEADER
// ************************************************************************
//
//            LOCA: Library of Continuation Algorithms Package
//                 Copyright (2005) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
//  CVS Information
//  $Source$
//  $Author$
//  $Date$
//  $Revision$
// ************************************************************************
//@HEADER

#ifndef LOCA_EPETRA_LEFTPRECONDITIONEDOP_H
#define LOCA_EPETRA_LEFTPRECONDITIONEDOP_H

#include "Teuchos_RCP.hpp"

#include "Epetra_Operator.h"    // base class
#include "NOX_Common.H"         // for std::string data member

namespace LOCA {

  namespace Epetra {

    /*!
     * \brief An Epetra operator for implementing the operator
     * \f$P = M^{-1}J\f$.
     */
    /*!
     * This class implements the Epetra_Operator interface for
     * \f$P = M^{-1}J\f$ where \f$J\f$ and \f$M\f$ are Epetra_Operator's.
     */
    class LeftPreconditionedOp : public Epetra_Operator {

    public:

      //! Constructor
      /*!
       * \param jacOperator [in] Jacobian operator J
       * \param precOperator [in] Preconditioner operator M
       */
      LeftPreconditionedOp(
    const Teuchos::RCP<Epetra_Operator>& jacOperator,
    const Teuchos::RCP<Epetra_Operator>& precOperator);

      //! Destructor
      virtual ~LeftPreconditionedOp();

      //! Set to true if the transpose of the operator is requested
      virtual int SetUseTranspose(bool UseTranspose);

      /*!
       * \brief Returns the result of a Epetra_Operator applied to a
       * Epetra_MultiVector Input in Result as described above.
       */
      virtual int Apply(const Epetra_MultiVector& Input,
            Epetra_MultiVector& Result) const;

      /*!
       * \brief Returns the result of the inverse of the operator applied to a
       * Epetra_MultiVector Input in Result as described above.
       */
      virtual int ApplyInverse(const Epetra_MultiVector& X,
                   Epetra_MultiVector& Y) const;

      //! Returns an approximate infinity norm of the operator matrix.
      /*!
       * This is defined only if %NormInf() of the underlying operators \f$J\f$
       * and \f$M\f$ is defined and is given by
       * \f$\|J\|_\infty+\|M\|_\infty\f$.
       */
      virtual double NormInf() const;

      //! Returns a character std::string describing the operator
      virtual const char* Label () const;

      //! Returns the current UseTranspose setting.
      virtual bool UseTranspose() const;

      /*!
       * \brief Returns true if the \e this object can provide an
       * approximate Inf-norm, false otherwise.
       */
      virtual bool HasNormInf() const;

      /*!
       * \brief Returns a reference to the Epetra_Comm communicator
       * associated with this operator.
       */
      virtual const Epetra_Comm & Comm() const;

      /*!
       * \brief Returns the Epetra_Map object associated with the
       * domain of this matrix operator.
       */
      virtual const Epetra_Map& OperatorDomainMap () const;

      /*!
       * \brief Returns the Epetra_Map object associated with the
       * range of this matrix operator.
       */
      virtual const Epetra_Map& OperatorRangeMap () const;

    private:

      //! Private to prohibit copying
      LeftPreconditionedOp(const LeftPreconditionedOp&);

      //! Private to prohibit copying
      LeftPreconditionedOp& operator=(const LeftPreconditionedOp&);

    protected:

      //! Label for operator
      std::string label;

      //! Stores operator representing J
      Teuchos::RCP<Epetra_Operator> J;

      //! Stores operator representing M
      Teuchos::RCP<Epetra_Operator> M;

      //! Flag indicating whether to use the transpose
      bool useTranspose;

    };
  } // namespace Epetra
} // namespace LOCA

#endif