Thyra_EpetraLinearOp.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//               Thyra: Trilinos Solver Framework Core
//                 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_EPETRA_LINEAR_OP_HPP
#define THYRA_EPETRA_LINEAR_OP_HPP

#include "Thyra_LinearOpBase.hpp"
#include "Thyra_EpetraLinearOpBase.hpp"
#include "Thyra_SpmdVectorSpaceBase.hpp"


namespace Thyra {


class EpetraLinearOp
  : virtual public LinearOpBase<double>,
    virtual public EpetraLinearOpBase
{
public:


  EpetraLinearOp();

  void initialize(
    const RCP<Epetra_Operator> &op,
    EOpTransp opTrans = NOTRANS,
    EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
    EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED,
    const RCP<const VectorSpaceBase<double> > &range = Teuchos::null,
    const RCP<const VectorSpaceBase<double> > &domain = Teuchos::null
    );

  void partiallyInitialize(
    const RCP<const VectorSpaceBase<double> > &range,
    const RCP<const VectorSpaceBase<double> > &domain,
    const RCP<Epetra_Operator> &op,
    EOpTransp opTrans = NOTRANS,
    EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
    EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED
    );

  void setFullyInitialized(bool isFullyInitialized = true);
  
  void uninitialize(
    RCP<Epetra_Operator> *op= NULL,
    EOpTransp *opTrans = NULL,
    EApplyEpetraOpAs *applyAs = NULL,
    EAdjointEpetraOp *adjointSupport = NULL,
    RCP<const VectorSpaceBase<double> > *range = NULL,
    RCP<const VectorSpaceBase<double> > *domain = NULL
    );

  RCP<const SpmdVectorSpaceBase<double> > spmdRange() const;

  RCP<const SpmdVectorSpaceBase<double> > spmdDomain() const;

  RCP<Epetra_Operator> epetra_op();

  RCP<const Epetra_Operator> epetra_op() const;



  void getNonconstEpetraOpView(
    const Ptr<RCP<Epetra_Operator> > &epetraOp,
    const Ptr<EOpTransp> &epetraOpTransp,
    const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
    const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport
    );
  void getEpetraOpView(
    const Ptr<RCP<const Epetra_Operator> > &epetraOp,
    const Ptr<EOpTransp> &epetraOpTransp,
    const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
    const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport
    ) const;



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

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

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


  
  std::string description() const;
  void describe(
    FancyOStream &out,
    const Teuchos::EVerbosityLevel verbLevel
    ) const;
  
  
protected:


  bool opSupportedImpl(EOpTransp M_trans) const;

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



  virtual RCP< const SpmdVectorSpaceBase<double> > 
  allocateDomain(
    const RCP<Epetra_Operator> &op, 
    EOpTransp op_trans 
    ) const; 
  
  virtual RCP< const SpmdVectorSpaceBase<double> >
  allocateRange( 
    const RCP<Epetra_Operator> &op, 
    EOpTransp op_trans 
    ) const; 


private:

  // ////////////////////////////////////
  // Private data members

  bool isFullyInitialized_;
  RCP<Epetra_Operator> op_;
  EOpTransp opTrans_;
  EApplyEpetraOpAs applyAs_;
  EAdjointEpetraOp adjointSupport_;
  RCP<const SpmdVectorSpaceBase<double> > range_;
  RCP<const SpmdVectorSpaceBase<double> > domain_;

  // ////////////////////////////////////
  // Private member functions

  const Epetra_Map& getRangeMap() const;
  const Epetra_Map& getDomainMap() const;

};  // end class EpetraLinearOp


RCP<EpetraLinearOp> nonconstEpetraLinearOp();


RCP<EpetraLinearOp>
partialNonconstEpetraLinearOp(
  const RCP<const VectorSpaceBase<double> > &range,
  const RCP<const VectorSpaceBase<double> > &domain,
  const RCP<Epetra_Operator> &op,
  EOpTransp opTrans = NOTRANS,
  EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
  EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED
  );


RCP<EpetraLinearOp>
nonconstEpetraLinearOp(
  const RCP<Epetra_Operator> &op,
  EOpTransp opTrans = NOTRANS,
  EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
  EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED,
  const RCP< const VectorSpaceBase<double> > &range = Teuchos::null,
  const RCP< const VectorSpaceBase<double> > &domain = Teuchos::null
  );


RCP<const EpetraLinearOp>
epetraLinearOp(
  const RCP<const Epetra_Operator> &op,
  EOpTransp opTrans = NOTRANS,
  EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
  EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED,
  const RCP<const VectorSpaceBase<double> > &range = Teuchos::null,
  const RCP<const VectorSpaceBase<double> > &domain = Teuchos::null
  );


RCP<EpetraLinearOp>
nonconstEpetraLinearOp(
  const RCP<Epetra_Operator> &op,
  const std::string &label,
  EOpTransp opTrans = NOTRANS,
  EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
  EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED,
  const RCP<const VectorSpaceBase<double> > &range = Teuchos::null,
  const RCP<const VectorSpaceBase<double> > &domain = Teuchos::null
  );


RCP<const EpetraLinearOp>
epetraLinearOp(
  const RCP<const Epetra_Operator> &op,
  const std::string &label,
  EOpTransp opTrans = NOTRANS,
  EApplyEpetraOpAs applyAs = EPETRA_OP_APPLY_APPLY,
  EAdjointEpetraOp adjointSupport = EPETRA_OP_ADJOINT_SUPPORTED,
  const RCP< const SpmdVectorSpaceBase<double> > &range = Teuchos::null,
  const RCP< const SpmdVectorSpaceBase<double> > &domain = Teuchos::null
  );


} // end namespace Thyra


#endif  // THYRA_EPETRA_LINEAR_OP_HPP