Thyra_DefaultAddedLinearOp_decl.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_ADDED_LINEAR_OP_DECL_HPP
#define THYRA_DEFAULT_ADDED_LINEAR_OP_DECL_HPP


#include "Thyra_AddedLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"


namespace Thyra {


template<class Scalar>
class DefaultAddedLinearOp : virtual public AddedLinearOpBase<Scalar>
{
public:


  DefaultAddedLinearOp();

  DefaultAddedLinearOp(const ArrayView<const RCP<LinearOpBase<Scalar> > > &Ops);

  DefaultAddedLinearOp(const ArrayView<const RCP<const LinearOpBase<Scalar> > > &Ops);

  void initialize(const ArrayView<const RCP<LinearOpBase<Scalar> > > &Ops);

  void initialize(const ArrayView<const RCP<const LinearOpBase<Scalar> > > &Ops);

  void uninitialize();



  int numOps() const;
  bool opIsConst(const int k) const;
  RCP<LinearOpBase<Scalar> > getNonconstOp(const int k);
  RCP<const LinearOpBase<Scalar> > getOp(const int k) const;



  RCP< const VectorSpaceBase<Scalar> > range() const;

  RCP< const VectorSpaceBase<Scalar> > domain() const;

  RCP<const LinearOpBase<Scalar> > clone() const;


                                                
  std::string description() const;

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



  THYRA_DEPRECATED DefaultAddedLinearOp(
    const int numOps,
    const RCP<const LinearOpBase<Scalar> > Ops[]
    );

  THYRA_DEPRECATED DefaultAddedLinearOp(
    const int numOps,
    const RCP<LinearOpBase<Scalar> > Ops[]
    );

  THYRA_DEPRECATED void initialize(
    const int numOps_in,
    const RCP<LinearOpBase<Scalar> > Ops[]
    )
    {
      initialize(Teuchos::arrayView(Ops, numOps_in));
    }

  THYRA_DEPRECATED void initialize(
    const int numOps_in,
    const RCP<const LinearOpBase<Scalar> > Ops[]
    )
    {
      initialize(Teuchos::arrayView(Ops, numOps_in));
    }


protected:


  bool opSupportedImpl(EOpTransp M_trans) const;

  void applyImpl(
    const EOpTransp M_trans,
    const MultiVectorBase<Scalar> &X,
    const Ptr<MultiVectorBase<Scalar> > &Y,
    const Scalar alpha,
    const Scalar beta
    ) const;


private:

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

  void assertInitialized() const;
  void validateOps();
  void setupDefaultObjectLabel();

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

};


template<class Scalar>
inline
RCP<DefaultAddedLinearOp<Scalar> >
defaultAddedLinearOp(const ArrayView<const RCP<LinearOpBase<Scalar> > > &Ops)
{
  return Teuchos::rcp(new DefaultAddedLinearOp<Scalar>(Ops));
}


template<class Scalar>
inline
RCP<DefaultAddedLinearOp<Scalar> >
defaultAddedLinearOp(const ArrayView<const RCP<const LinearOpBase<Scalar> > > &Ops)
{
  return Teuchos::rcp(new DefaultAddedLinearOp<Scalar>(Ops));
}


template<class Scalar>
RCP<LinearOpBase<Scalar> >
nonconstAdd(
  const RCP<LinearOpBase<Scalar> > &A,
  const RCP<LinearOpBase<Scalar> > &B,
  const std::string &label = ""
  );


template<class Scalar>
RCP<const LinearOpBase<Scalar> >
add(
  const RCP<const LinearOpBase<Scalar> > &A,
  const RCP<const LinearOpBase<Scalar> > &B,
  const std::string &label = ""
  );


template<class Scalar>
RCP<LinearOpBase<Scalar> >
nonconstSubtract(
  const RCP<LinearOpBase<Scalar> > &A,
  const RCP<LinearOpBase<Scalar> > &B,
  const std::string &label = ""
  );


template<class Scalar>
RCP<const LinearOpBase<Scalar> >
subtract(
  const RCP<const LinearOpBase<Scalar> > &A,
  const RCP<const LinearOpBase<Scalar> > &B,
  const std::string &label = ""
  );


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


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


} // end namespace Thyra


#endif  // THYRA_DEFAULT_ADDED_LINEAR_OP_DECL_HPP