Thyra Version of the Day
Thyra_ProductVectorSpaceBase.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_PRODUCT_VECTOR_SPACE_BASE_HPP
00043 #define THYRA_PRODUCT_VECTOR_SPACE_BASE_HPP
00044 
00045 
00046 #include "Thyra_VectorSpaceBase.hpp"
00047 #include "Teuchos_ExpandScalarTypeMacros.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00094 template<class Scalar>
00095 class ProductVectorSpaceBase : virtual public VectorSpaceBase<Scalar> {
00096 public:
00097 
00104   virtual int numBlocks() const = 0;
00105 
00112   virtual Teuchos::RCP<const VectorSpaceBase<Scalar> > getBlock(const int k) const = 0; 
00113 
00114 #ifdef DOXYGEN_COMPILE
00115 private:
00116   const VectorSpaceBase<Scalar> *spaces;
00117 #endif
00118 
00119 private:
00120   
00121   // Not defined and not to be called
00122   ProductVectorSpaceBase<Scalar>&
00123   operator=(const ProductVectorSpaceBase<Scalar>&);
00124 
00125 };
00126 
00127 
00133 template<class Scalar>
00134 inline
00135 RCP<ProductVectorSpaceBase<Scalar> >
00136 nonconstProductVectorSpaceBase(
00137   const RCP<VectorSpaceBase<Scalar> > &v,
00138   const bool forceSuccess = true
00139   )
00140 {
00141   return Teuchos::rcp_dynamic_cast<ProductVectorSpaceBase<Scalar> >(
00142     v, forceSuccess);
00143 }
00144 
00145 
00151 template<class Scalar>
00152 inline
00153 RCP<const ProductVectorSpaceBase<Scalar> >
00154 productVectorSpaceBase(
00155   const RCP<const VectorSpaceBase<Scalar> > &v,
00156   const bool forceSuccess = true
00157   )
00158 {
00159   return Teuchos::rcp_dynamic_cast<const ProductVectorSpaceBase<Scalar> >(
00160     v, forceSuccess);
00161 }
00162 
00163 
00169 inline
00170 RCP<ProductVectorSpaceBase<double> >
00171 nonconstProductVectorSpaceBase(
00172   const RCP<VectorSpaceBase<double> > &vs,
00173   const bool forceSuccess = true
00174   )
00175 {
00176   return nonconstProductVectorSpaceBase<double>(vs, forceSuccess);
00177 }
00178 
00179 
00184 inline
00185 RCP<const ProductVectorSpaceBase<double> >
00186 productVectorSpaceBase(
00187   const RCP<const VectorSpaceBase<double> > &vs,
00188   const bool forceSuccess = true
00189   )
00190 {
00191   return productVectorSpaceBase<double>(vs, forceSuccess);
00192 }
00193 
00194 
00195 } // namespace Thyra
00196 
00197 #endif // THYRA_PRODUCT_VECTOR_SPACE_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines