NOX_Epetra_LinearSystem_MPBD.hpp

Go to the documentation of this file.

/*
// @HEADER
// ***********************************************************************
// 
//                           Stokhos Package
//                 Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER
*/

#ifndef NOX_EPETRA_LINEARSYSTEMMPBD_H
#define NOX_EPETRA_LINEARSYSTEMMPBD_H

#include "Stokhos_ConfigDefs.h"

#ifdef HAVE_STOKHOS_NOX

#include "NOX_Common.H"

#include "NOX_Epetra_LinearSystem.H"  // base class
#include "NOX_Utils.H"                  // class data element

#include "Stokhos_ProductContainer.hpp"
#include "Stokhos_VectorOrthogPolyTraitsEpetra.hpp"
#include "Stokhos_BlockDiagonalOperator.hpp"
#include "EpetraExt_BlockVector.h"

namespace NOX {
  namespace Epetra {
    namespace Interface {
      class Required;
      class Jacobian;
      class Preconditioner;
    }
  }
}

namespace NOX {

  namespace Epetra {

    class LinearSystemMPBD : public virtual NOX::Epetra::LinearSystem {
    public:

      LinearSystemMPBD(
  Teuchos::ParameterList& printingParams, 
  Teuchos::ParameterList& linearSolverParams, 
  const Teuchos::RCP<NOX::Epetra::LinearSystem>& block_solver,
  const Teuchos::RCP<NOX::Epetra::Interface::Required>& iReq, 
  const Teuchos::RCP<NOX::Epetra::Interface::Jacobian>& iJac, 
  const Teuchos::RCP<Epetra_Operator>& J,
  const Teuchos::RCP<const Epetra_Map>& base_map,
  const Teuchos::RCP<NOX::Epetra::Scaling> scalingObject = 
  Teuchos::null);

      virtual ~LinearSystemMPBD();

      virtual bool applyJacobian(const NOX::Epetra::Vector& input, 
         NOX::Epetra::Vector& result) const;

      virtual bool applyJacobianTranspose(const NOX::Epetra::Vector& input, 
            NOX::Epetra::Vector& result) const;
      
      virtual bool applyJacobianInverse(Teuchos::ParameterList &params, 
          const NOX::Epetra::Vector &input, 
          NOX::Epetra::Vector &result);
      
      virtual bool applyRightPreconditioning(bool useTranspose,
               Teuchos::ParameterList& params, 
               const NOX::Epetra::Vector& input, 
               NOX::Epetra::Vector& result) const;
      
      virtual Teuchos::RCP<NOX::Epetra::Scaling> getScaling();
      
      virtual void resetScaling(const Teuchos::RCP<NOX::Epetra::Scaling>& s);
      
      virtual bool computeJacobian(const NOX::Epetra::Vector& x);
      
      virtual bool createPreconditioner(const NOX::Epetra::Vector& x, 
          Teuchos::ParameterList& p,
          bool recomputeGraph) const;
      
      virtual bool destroyPreconditioner() const;
      
      virtual bool recomputePreconditioner(const NOX::Epetra::Vector& x, 
             Teuchos::ParameterList& linearSolverParams) const;

      virtual PreconditionerReusePolicyType 
      getPreconditionerPolicy(bool advanceReuseCounter=true);
      
      virtual bool isPreconditionerConstructed() const;
      
      virtual bool hasPreconditioner() const;
      
      virtual Teuchos::RCP<const Epetra_Operator> 
      getJacobianOperator() const;
      
      virtual Teuchos::RCP<Epetra_Operator> getJacobianOperator();
      
      virtual Teuchos::RCP<const Epetra_Operator> 
      getGeneratedPrecOperator() const;
      
      virtual Teuchos::RCP<Epetra_Operator> getGeneratedPrecOperator();
      
      virtual void setJacobianOperatorForSolve(const Teuchos::RCP<const Epetra_Operator>& solveJacOp);

      virtual void setPrecOperatorForSolve(const Teuchos::RCP<const Epetra_Operator>& solvePrecOp);
      
    protected:

      enum PREC_STRATEGY {
  STANDARD,
  MEAN,
  ON_THE_FLY
      };
      
      Teuchos::RCP<NOX::Epetra::LinearSystem> block_solver;
      
      Teuchos::RCP<NOX::Epetra::Interface::Jacobian> jacInterfacePtr;

      int num_mp_blocks;
      
      mutable Teuchos::RCP<Stokhos::BlockDiagonalOperator> mp_op;
      
      mutable Teuchos::RCP<const Stokhos::ProductContainer<Epetra_Operator> > block_ops;
      
      Teuchos::RCP<const Epetra_Map> base_map;
      
      Teuchos::RCP<NOX::Epetra::Scaling> scaling;
      
      NOX::Utils utils;

      PREC_STRATEGY precStrategy;

      mutable Teuchos::Array< Teuchos::RCP<const Epetra_Operator> > precs;

      mutable Teuchos::RCP<EpetraExt::BlockVector> prec_x;

    };
    
  } // namespace Epetra
} // namespace NOX

#endif

#endif