00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Playa: Programmable Linear Algebra 00005 // Copyright 2012 Sandia Corporation 00006 // 00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, 00008 // the U.S. Government retains certain rights in this software. 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 Kevin Long (kevin.long@ttu.edu) 00038 // 00039 00040 /* @HEADER@ */ 00041 00042 #ifndef PLAYA_LINEAROPERATORBASEDECL_HPP 00043 #define PLAYA_LINEAROPERATORBASEDECL_HPP 00044 00045 #include "PlayaDefs.hpp" 00046 #include "Teuchos_BLAS_types.hpp" 00047 #include "PlayaVectorDecl.hpp" 00048 #include "PlayaObjectWithVerbosity.hpp" 00049 00050 namespace Playa 00051 { 00052 00053 template <class Scalar> class VectorSpaceBase; 00054 template <class Scalar> class Vector; 00055 template <class Scalar> class VectorType; 00056 using Teuchos::ETransp; 00057 00058 /** 00059 * Base class for linear operators. Most operator subtypes can safely derive 00060 * from LinearOpWithSpaces which provides trivial implementations of 00061 * the domain() and range() methods. 00062 * 00063 */ 00064 template <class Scalar> 00065 class LinearOperatorBase 00066 : public ObjectWithVerbosity 00067 { 00068 public: 00069 /** Virtual dtor */ 00070 ~LinearOperatorBase(){} 00071 00072 /** Return the domain */ 00073 virtual const RCP<const VectorSpaceBase<Scalar> > domain() const = 0 ; 00074 00075 /** Return the range */ 00076 virtual const RCP<const VectorSpaceBase<Scalar> > range() const = 0 ; 00077 00078 /** 00079 * Apply the operator. 00080 * 00081 * \param applyType Indicates whether to apply the operator, its transpose, 00082 * or its conjugate transpose. 00083 * \param in The vector on which the operator is to act 00084 * \param out The vector into which the result of the operation 00085 * is to be written. This vector should already be initialized by the 00086 * appropriate space. 00087 **/ 00088 virtual void apply( 00089 Teuchos::ETransp applyType, 00090 const Vector<Scalar>& in, 00091 Vector<Scalar> out) const = 0 ; 00092 }; 00093 00094 00095 00096 00097 } 00098 00099 00100 #endif