Thyra Version of the Day
Thyra_DefaultLinearOpSource_decl.hpp
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
00043 #define THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
00044 
00045 #include "Thyra_LinearOpSourceBase.hpp"
00046 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00047 
00048 namespace Thyra {
00049 
00053 template<class Scalar>
00054 class DefaultLinearOpSource : virtual public LinearOpSourceBase<Scalar>
00055 {
00056 public:
00057 
00060 
00063   DefaultLinearOpSource();
00064 
00067   DefaultLinearOpSource(
00068     const Teuchos::RCP<LinearOpBase<Scalar> >    &op
00069     );
00070 
00073   DefaultLinearOpSource(
00074     const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00075     );
00076 
00079   void initialize(
00080     const Teuchos::RCP<LinearOpBase<Scalar> >    &op
00081     );
00082 
00085   void initialize(
00086     const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00087     );
00088 
00095   void uninitialize();
00096 
00098 
00099   // ToDo: Override functions from Describable!
00100 
00104   bool isOpConst() const;
00106   Teuchos::RCP<LinearOpBase<Scalar> > getNonconstOp();
00108   Teuchos::RCP<const LinearOpBase<Scalar> > getOp() const;
00110   
00111 private:
00112   
00113   Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> >  op_;
00114   
00115 };
00116 
00117 // //////////////////////////////
00118 // Related functions
00119 
00125 template <class Scalar>
00126 Teuchos::RCP<const DefaultLinearOpSource<Scalar> >
00127 defaultLinearOpSource(
00128   const Teuchos::RCP<const LinearOpBase<Scalar> >    &op
00129   )
00130 {
00131   return Teuchos::rcp(new DefaultLinearOpSource<Scalar>(op));
00132 }
00133 
00134 } // namespace Thyra
00135 
00136 #endif // THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines