Thyra_DefaultInverseLinearOpDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) 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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP
#define THYRA_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP

#include "Thyra_InverseLinearOpBase.hpp"
#include "Thyra_SingleScalarLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"
#include "Teuchos_arrayArg.hpp"

namespace Thyra {

enum EThrowOnSolveFailure {
  THROW_ON_SOLVE_FAILURE=1 
  ,IGNORE_SOLVE_FAILURE=0  
};

template<class Scalar>
class DefaultInverseLinearOp
  : virtual public InverseLinearOpBase<Scalar>             // Public interface
  , virtual protected SingleScalarLinearOpBase<Scalar>     // Implementation detail
{
public:

  using SingleScalarLinearOpBase<Scalar>::apply;


  DefaultInverseLinearOp();

  DefaultInverseLinearOp(
    const Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >      &lows
    ,const SolveCriteria<Scalar>                                    *fwdSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                     throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
    ,const SolveCriteria<Scalar>                                    *adjSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                     throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
    );

  DefaultInverseLinearOp(
    const Teuchos::RefCountPtr<const LinearOpWithSolveBase<Scalar> >      &lows
    ,const SolveCriteria<Scalar>                                          *fwdSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                           throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
    ,const SolveCriteria<Scalar>                                          *adjSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                           throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
    );

  void initialize(
    const Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >      &lows
    ,const SolveCriteria<Scalar>                                    *fwdSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                     throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
    ,const SolveCriteria<Scalar>                                    *adjSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                     throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
    );

  void initialize(
    const Teuchos::RefCountPtr<const LinearOpWithSolveBase<Scalar> >      &lows
    ,const SolveCriteria<Scalar>                                          *fwdSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                           throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
    ,const SolveCriteria<Scalar>                                          *adjSolveCriteria       = NULL
    ,const EThrowOnSolveFailure                                           throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
    );

  void uninitialize();



  bool isLowsConst() const;
  Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >
  getNonconstLows(); 
  Teuchos::RefCountPtr<const LinearOpWithSolveBase<Scalar> >
  getLows() const; 



  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > range() const;

  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > domain() const;

  Teuchos::RefCountPtr<const LinearOpBase<Scalar> > clone() const;


                                                
  std::string description() const;

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


protected:


  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp                     M_trans
    ,const MultiVectorBase<Scalar>    &X
    ,MultiVectorBase<Scalar>          *Y
    ,const Scalar                     alpha
    ,const Scalar                     beta
    ) const;


private:

  Teuchos::ConstNonconstObjectContainer<LinearOpWithSolveBase<Scalar> >   lows_;
  Teuchos::RefCountPtr<SolveCriteria<Scalar> >                            fwdSolveCriteria_;
  EThrowOnSolveFailure                                                    throwOnFwdSolveFailure_;
  Teuchos::RefCountPtr<SolveCriteria<Scalar> >                            adjSolveCriteria_;
  EThrowOnSolveFailure                                                    throwOnAdjSolveFailure_;

  void assertInitialized() const;

  template<class LOWS>
  void initializeImpl(
    const Teuchos::RefCountPtr<LOWS>      &lows
    ,const SolveCriteria<Scalar>          *fwdSolveCriteria
    ,const EThrowOnSolveFailure           throwOnFwdSolveFailure
    ,const SolveCriteria<Scalar>          *adjSolveCriteria
    ,const EThrowOnSolveFailure           throwOnAdjSolveFailure
    );

  // Not defined and not to be called
  DefaultInverseLinearOp(const DefaultInverseLinearOp&);
  DefaultInverseLinearOp& operator=(const DefaultInverseLinearOp&);

};

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
nonconstInverse(
  const Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >    &A
  ,const SolveCriteria<Scalar>                                  *fwdSolveCriteria       = NULL
  ,const EThrowOnSolveFailure                                   throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
  ,const SolveCriteria<Scalar>                                  *adjSolveCriteria       = NULL
  ,const EThrowOnSolveFailure                                   throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
  );

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
inverse(
  const Teuchos::RefCountPtr<const LinearOpWithSolveBase<Scalar> >     &A
  ,const SolveCriteria<Scalar>                                         *fwdSolveCriteria       = NULL
  ,const EThrowOnSolveFailure                                          throwOnFwdSolveFailure  = THROW_ON_SOLVE_FAILURE
  ,const SolveCriteria<Scalar>                                         *adjSolveCriteria       = NULL
  ,const EThrowOnSolveFailure                                          throwOnAdjSolveFailure  = THROW_ON_SOLVE_FAILURE
  );

// /////////////////////////////////
// Inline members

template<class Scalar>
inline
void DefaultInverseLinearOp<Scalar>::assertInitialized() const
{
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( !lows_.getConstObj().get() );
#endif
}

} // end namespace Thyra

#endif  // THYRA_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP

---