Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_BorderedOperator_def.hpp
00001 /*@HEADER
00002 // ***********************************************************************
00003 //
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) 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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 */
00042 
00043 
00044 #ifndef IFPACK2_BORDEREDOPERATOR_DEF_HPP
00045 #define IFPACK2_BORDEREDOPERATOR_DEF_HPP
00046 
00047 #include "Ifpack2_BorderedOperator_decl.hpp"
00048 #include "Tpetra_MultiVector.hpp"
00049 #include "Teuchos_TestForException.hpp"
00050 
00051 namespace Ifpack2 {
00052 
00053 template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
00054 BorderedOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node >::
00055 BorderedOperator (const Teuchos::RCP<const Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node > >& A) : 
00056   A_ (A)
00057 { 
00058   TEUCHOS_TEST_FOR_EXCEPTION(
00059     A_.is_null (), std::runtime_error, 
00060     Teuchos::typeName (*this) << "::BorderedOperator constructor: "
00061     "The input Operator A is null.");
00062 }
00063 
00064 template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
00065 Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
00066 BorderedOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap() const
00067 {
00068   return A_->getDomainMap();
00069 }
00070 
00071 template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
00072 Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
00073 BorderedOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap() const
00074 {
00075   return A_->getRangeMap();
00076 }
00077 
00078 template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
00079 bool
00080 BorderedOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply() const 
00081 {
00082   return A_->hasTransposeApply();
00083 }
00084 
00085 template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
00086 void 
00087 BorderedOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node >::
00088 apply (const Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node >& X,
00089        Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node >& Y,
00090        Teuchos::ETransp mode, 
00091        Scalar coefAx, 
00092        Scalar coefY ) const 
00093 {
00094   TEUCHOS_TEST_FOR_EXCEPTION(
00095     X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
00096     "Ifpack2::BorderedOperator::apply(): X.getNumVectors() = " 
00097     << X.getNumVectors() << " != Y.getNumVectors() = " 
00098     << Y.getNumVectors() << ".");
00099   A_->apply (X, Y, mode, coefAx, coefY );
00100 }
00101 
00102 } // namespace Ifpack2
00103 
00104 #define IFPACK2_BORDEREDOPERATOR_INSTANT(S,LO,GO,N) \
00105   template class Ifpack2::BorderedOperator< S, LO, GO, N >;
00106 
00107 #endif /* IFPACK2_BorderedOperator_DEF_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends