Thyra Version of the Day
Thyra_DefaultMultipliedLinearOp_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_DEFAULT_MULTIPLIED_LINEAR_OP_DECL_HPP
00043 #define THYRA_DEFAULT_MULTIPLIED_LINEAR_OP_DECL_HPP
00044 
00045 #include "Thyra_MultipliedLinearOpBase.hpp"
00046 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00119 template<class Scalar>
00120 class DefaultMultipliedLinearOp : virtual public MultipliedLinearOpBase<Scalar>
00121 {
00122 public:
00123 
00126 
00133   DefaultMultipliedLinearOp();
00134 
00152   void initialize(const ArrayView<const RCP<LinearOpBase<Scalar> > > &Ops);
00153 
00171   void initialize(const ArrayView<const RCP<const LinearOpBase<Scalar> > > &Ops );
00172 
00179   void uninitialize();
00180 
00182 
00185 
00187   int numOps() const;
00189   bool opIsConst(const int k) const;
00191   RCP<LinearOpBase<Scalar> > getNonconstOp(const int k);
00193   RCP<const LinearOpBase<Scalar> > getOp(const int k) const;
00194 
00196 
00199 
00203   RCP< const VectorSpaceBase<Scalar> > range() const;
00204 
00208   RCP< const VectorSpaceBase<Scalar> > domain() const;
00209 
00211   RCP<const LinearOpBase<Scalar> > clone() const;
00212 
00214 
00217                                                 
00221   std::string description() const;
00222 
00230   void describe(
00231     Teuchos::FancyOStream &out,
00232     const Teuchos::EVerbosityLevel verbLevel
00233     ) const;
00234 
00236 
00237 protected:
00238 
00241 
00245   bool opSupportedImpl(EOpTransp M_trans) const;
00246 
00248   void applyImpl(
00249     const EOpTransp M_trans,
00250     const MultiVectorBase<Scalar> &X,
00251     const Ptr<MultiVectorBase<Scalar> > &Y,
00252     const Scalar alpha,
00253     const Scalar beta
00254     ) const;
00255 
00257 
00258 public:
00259 
00260 private:
00261 
00262   Array<Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > > Ops_;
00263 
00264   void assertInitialized() const;
00265   void validateOps();
00266   void setupDefaultObjectLabel();
00267 
00268   // Not defined and not to be called
00269   DefaultMultipliedLinearOp(const DefaultMultipliedLinearOp&);
00270   DefaultMultipliedLinearOp& operator=(const DefaultMultipliedLinearOp&);
00271 
00272 };
00273 
00274 
00279 template<class Scalar>
00280 inline
00281 RCP<DefaultMultipliedLinearOp<Scalar> >
00282 defaultMultipliedLinearOp()
00283 {
00284   return Teuchos::rcp(new DefaultMultipliedLinearOp<Scalar>);
00285 }
00286 
00287 
00292 template<class Scalar>
00293 RCP<DefaultMultipliedLinearOp<Scalar> >
00294 defaultMultipliedLinearOp(const ArrayView<const RCP<LinearOpBase<Scalar> > > &Ops)
00295 {
00296   RCP<DefaultMultipliedLinearOp<Scalar> > dmlo = defaultMultipliedLinearOp<Scalar>();
00297   dmlo->initialize(Ops);
00298   return dmlo;
00299 }
00300 
00301 
00306 template<class Scalar>
00307 RCP<DefaultMultipliedLinearOp<Scalar> >
00308 defaultMultipliedLinearOp(const ArrayView<const RCP<const LinearOpBase<Scalar> > > &Ops)
00309 {
00310   RCP<DefaultMultipliedLinearOp<Scalar> > dmlo = defaultMultipliedLinearOp<Scalar>();
00311   dmlo->initialize(Ops);
00312   return dmlo;
00313 }
00314 
00315 
00321 template<class Scalar>
00322 RCP<LinearOpBase<Scalar> >
00323 nonconstMultiply(
00324   const RCP<LinearOpBase<Scalar> > &A,
00325   const RCP<LinearOpBase<Scalar> > &B,
00326   const std::string &M_label = ""
00327   );
00328 
00329 
00335 template<class Scalar>
00336 RCP<const LinearOpBase<Scalar> >
00337 multiply(
00338   const RCP<const LinearOpBase<Scalar> > &A,
00339   const RCP<const LinearOpBase<Scalar> > &B,
00340   const std::string &M_label = ""
00341   );
00342 
00343 
00349 template<class Scalar>
00350 RCP<const LinearOpBase<Scalar> >
00351 multiply(
00352   const RCP<const LinearOpBase<Scalar> > &A,
00353   const RCP<const LinearOpBase<Scalar> > &B,
00354   const RCP<const LinearOpBase<Scalar> > &C,
00355   const std::string &M_label = ""
00356   );
00357 
00358 
00359 // /////////////////////////////////
00360 // Inline members
00361 
00362 
00363 template<class Scalar>
00364 inline
00365 void DefaultMultipliedLinearOp<Scalar>::assertInitialized() const
00366 {
00367 #ifdef TEUCHOS_DEBUG
00368   TEUCHOS_TEST_FOR_EXCEPT( !( numOps() > 0 ) );
00369 #endif
00370 }
00371 
00372 
00373 } // end namespace Thyra
00374 
00375 
00376 #endif  // THYRA_DEFAULT_MULTIPLIED_LINEAR_OP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines