Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_DefaultLinearOpSource_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
00030 #define THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
00031 
00032 #include "Thyra_LinearOpSourceBase.hpp"
00033 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00034 
00035 namespace Thyra {
00036 
00040 template<class Scalar>
00041 class DefaultLinearOpSource : virtual public LinearOpSourceBase<Scalar>
00042 {
00043 public:
00044 
00047 
00050   DefaultLinearOpSource();
00051 
00054   DefaultLinearOpSource(
00055     const Teuchos::RCP<LinearOpBase<Scalar> >    &op
00056     );
00057 
00060   DefaultLinearOpSource(
00061     const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00062     );
00063 
00066   void initialize(
00067     const Teuchos::RCP<LinearOpBase<Scalar> >    &op
00068     );
00069 
00072   void initialize(
00073     const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00074     );
00075 
00082   void uninitialize();
00083 
00085 
00086   // ToDo: Override functions from Describable!
00087 
00091   bool isOpConst() const;
00093   Teuchos::RCP<LinearOpBase<Scalar> > getNonconstOp();
00095   Teuchos::RCP<const LinearOpBase<Scalar> > getOp() const;
00097   
00098 private:
00099   
00100   Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> >  op_;
00101   
00102 };
00103 
00104 // //////////////////////////////
00105 // Related functions
00106 
00112 template <class Scalar>
00113 Teuchos::RCP<const DefaultLinearOpSource<Scalar> >
00114 defaultLinearOpSource(
00115   const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00116   )
00117 {
00118   return Teuchos::rcp(new DefaultLinearOpSource<Scalar>(op));
00119 }
00120 
00121 } // namespace Thyra
00122 
00123 #endif // THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines