Teko_LU2x2InverseOp.hpp

Go to the documentation of this file.

/*
// @HEADER
//
// ***********************************************************************
//
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

*/

#ifndef __Teko_LU2x2InverseOp_hpp__
#define __Teko_LU2x2InverseOp_hpp__

#include "Teko_Utilities.hpp"
#include "Teko_BlockImplicitLinearOp.hpp"

namespace Teko {

class LU2x2InverseOp : public BlockImplicitLinearOp {
 public:
  LU2x2InverseOp(const BlockedLinearOp &A, const LinearOp &invA00, const LinearOp &invS);

  LU2x2InverseOp(const BlockedLinearOp &A, const LinearOp &hatInvA00, const LinearOp &tildeInvA00,
                 const LinearOp &invS);



  virtual VectorSpace range() const { return productRange_; }

  virtual VectorSpace domain() const { return productDomain_; }

  virtual void implicitApply(const BlockedMultiVector &x, BlockedMultiVector &y,
                             const double alpha = 1.0, const double beta = 0.0) const;

  virtual void describe(Teuchos::FancyOStream &out_arg,
                        const Teuchos::EVerbosityLevel verbLevel) const;

 protected:
  using BlockImplicitLinearOp::implicitApply;

  // fundamental operators to use
  const BlockedLinearOp A_;     
  const LinearOp hatInvA00_;    
  const LinearOp tildeInvA00_;  
  const LinearOp invS_;         

  // some blocks of A
  const LinearOp A10_;  
  const LinearOp A01_;  

  Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> >
      productRange_;  
  Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> >
      productDomain_;  

 private:
  // hide me!
  LU2x2InverseOp();
  LU2x2InverseOp(const LU2x2InverseOp &);
};

inline LinearOp createLU2x2InverseOp(BlockedLinearOp &A, LinearOp &invA00, LinearOp &invS) {
  return Teuchos::rcp(new LU2x2InverseOp(A, invA00, invS));
}

inline LinearOp createLU2x2InverseOp(BlockedLinearOp &A, LinearOp &invA00, LinearOp &invS,
                                     const std::string &str) {
  Teuchos::RCP<Thyra::LinearOpBase<double> > result =
      Teuchos::rcp(new LU2x2InverseOp(A, invA00, invS));
  result->setObjectLabel(str);

  return result;
}

inline LinearOp createLU2x2InverseOp(BlockedLinearOp &A, LinearOp &hatInvA00, LinearOp &tildeInvA00,
                                     LinearOp &invS) {
  return Teuchos::rcp(new LU2x2InverseOp(A, hatInvA00, tildeInvA00, invS));
}

inline LinearOp createLU2x2InverseOp(BlockedLinearOp &A, LinearOp &hatInvA00, LinearOp &tildeInvA00,
                                     LinearOp &invS, const std::string &str) {
  Teuchos::RCP<Thyra::LinearOpBase<double> > result =
      Teuchos::rcp(new LU2x2InverseOp(A, hatInvA00, tildeInvA00, invS));
  result->setObjectLabel(str);

  return result;
}

}  // end namespace Teko

#endif