Thyra_DefaultMultipliedLinearOpDecl.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_MULTIPLIED_LINEAR_OP_DECL_HPP
#define THYRA_DEFAULT_MULTIPLIED_LINEAR_OP_DECL_HPP

#include "Thyra_MultipliedLinearOpBase.hpp"
#include "Thyra_SingleScalarLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"
#include "Teuchos_arrayArg.hpp"
#include "Teuchos_Handleable.hpp"

namespace Thyra {

template<class Scalar>
class DefaultMultipliedLinearOp
  : virtual public MultipliedLinearOpBase<Scalar>        // Public interface
  , virtual protected SingleScalarLinearOpBase<Scalar>   // Implementation detail
  , virtual public Teuchos::Handleable<LinearOpBase<Scalar> >
{
public:
  /* */
  TEUCHOS_GET_RCP(LinearOpBase<Scalar>);

  using SingleScalarLinearOpBase<Scalar>::apply;


  DefaultMultipliedLinearOp();

  DefaultMultipliedLinearOp(
    const int                                                   numOps
    ,const Teuchos::RefCountPtr<LinearOpBase<Scalar> >          Ops[]
    );

  DefaultMultipliedLinearOp(
    const int                                                   numOps
    ,const Teuchos::RefCountPtr<const LinearOpBase<Scalar> >    Ops[]
    );

  void initialize(
    const int                                                   numOps
    ,const Teuchos::RefCountPtr<LinearOpBase<Scalar> >          Ops[]
    );

  void initialize(
    const int                                                   numOps
    ,const Teuchos::RefCountPtr<const LinearOpBase<Scalar> >    Ops[]
    );

  void uninitialize();



  int numOps() const;
  bool opIsConst(const int k) const;
  Teuchos::RefCountPtr<LinearOpBase<Scalar> > getNonconstOp(const int k);
  Teuchos::RefCountPtr<const LinearOpBase<Scalar> > getOp(const int k) 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:

  std::vector<Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > >   Ops_;

  void assertInitialized() const;
  void validateOps();

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

};

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
nonconstMultiply(
  const Teuchos::RefCountPtr<LinearOpBase<Scalar> >    &A
  ,const Teuchos::RefCountPtr<LinearOpBase<Scalar> >   &B
  );

template<class Scalar>
Teuchos::RefCountPtr<const LinearOpBase<Scalar> >
multiply(
  const Teuchos::RefCountPtr<const LinearOpBase<Scalar> >    &A
  ,const Teuchos::RefCountPtr<const LinearOpBase<Scalar> >   &B
  );

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

template<class Scalar>
inline
void DefaultMultipliedLinearOp<Scalar>::assertInitialized() const
{
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( !( numOps() > 0 ) );
#endif
}

} // end namespace Thyra

#endif  // THYRA_DEFAULT_MULTIPLIED_LINEAR_OP_DECL_HPP

---