Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_TpetraThyraWrappers_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 // 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_TPETRA_THYRA_WRAPPERS_DECL_HPP
00043 #define THYRA_TPETRA_THYRA_WRAPPERS_DECL_HPP
00044 
00045 
00046 #include "Thyra_OperatorVectorTypes.hpp"
00047 #include "Thyra_TpetraVectorSpace_decl.hpp"
00048 #include "Thyra_TpetraVector_decl.hpp"
00049 #include "Thyra_TpetraMultiVector_decl.hpp"
00050 #include "Thyra_TpetraLinearOp_decl.hpp"
00051 
00052 
00053 namespace Thyra {
00054 
00055 
00063 RCP<const Teuchos::Comm<Ordinal> >
00064 convertTpetraToThyraComm( const RCP<const Teuchos::Comm<int> > &tpetraComm );
00065 
00066 
00071 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00072 RCP<const VectorSpaceBase<Scalar> >
00073 createVectorSpace(const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &tpetraMap);
00074 
00075 
00080 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00081 RCP<VectorBase<Scalar> >
00082 createVector(
00083   const RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector,
00084   const RCP<const VectorSpaceBase<Scalar> > space = Teuchos::null
00085   );
00086 
00087 
00092 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00093 RCP<const VectorBase<Scalar> >
00094 createConstVector(
00095   const RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector,
00096   const RCP<const VectorSpaceBase<Scalar> > space = Teuchos::null
00097   );
00098 
00099 
00104 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00105 RCP<MultiVectorBase<Scalar> >
00106 createMultiVector(
00107   const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector,
00108   const RCP<const VectorSpaceBase<Scalar> > rangeSpace = Teuchos::null,
00109   const RCP<const VectorSpaceBase<Scalar> > domainSpace = Teuchos::null
00110   );
00111 
00112 
00117 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00118 RCP<const MultiVectorBase<Scalar> >
00119 createConstMultiVector(
00120   const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector,
00121   const RCP<const VectorSpaceBase<Scalar> > rangeSpace = Teuchos::null,
00122   const RCP<const VectorSpaceBase<Scalar> > domainSpace = Teuchos::null
00123   );
00124 
00125 
00130 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00131 RCP<LinearOpBase<Scalar> >
00132 createLinearOp(
00133   const RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator,
00134   const RCP<const VectorSpaceBase<Scalar> > rangeSpace = Teuchos::null,
00135   const RCP<const VectorSpaceBase<Scalar> > domainSpace = Teuchos::null
00136   );
00137 
00138 
00143 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00144 RCP<const LinearOpBase<Scalar> >
00145 createConstLinearOp(
00146   const RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator,
00147   const RCP<const VectorSpaceBase<Scalar> > rangeSpace = Teuchos::null,
00148   const RCP<const VectorSpaceBase<Scalar> > domainSpace = Teuchos::null
00149   );
00150 
00151 
00172 template <class Scalar, class LocalOrdinal, class GlobalOrdinal=LocalOrdinal,
00173   class Node=Kokkos::DefaultNode::DefaultNodeType >
00174 class TpetraOperatorVectorExtraction {
00175 public:
00176 
00177   // ToDo: Get a Tpetra::Map from a Thyra::VectorSpaceBase?
00178 
00182   static RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00183   getTpetraVector(const RCP<VectorBase<Scalar> > &v);
00184 
00188   static RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00189   getConstTpetraVector(const RCP<const VectorBase<Scalar> > &v);
00190 
00194   static RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00195   getTpetraMultiVector(const RCP<MultiVectorBase<Scalar> > &mv);
00196 
00200   static RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00201   getConstTpetraMultiVector(const RCP<const MultiVectorBase<Scalar> > &mv);
00202 
00206   static RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00207   getTpetraOperator(const RCP<LinearOpBase<Scalar> > &op);
00208 
00212   static RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00213   getConstTpetraOperator(const RCP<const LinearOpBase<Scalar> > &op);
00214 
00215 };
00216 
00217 
00218 } // namespace Thyra
00219 
00220 
00221 #endif // THYRA_TPETRA_THYRA_WRAPPERS_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines