Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_BorderedOperator_def.hpp
1/*@HEADER
2// ***********************************************************************
3//
4// Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5// Copyright (2009) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40//@HEADER
41*/
42
43
44#ifndef IFPACK2_BORDEREDOPERATOR_DEF_HPP
45#define IFPACK2_BORDEREDOPERATOR_DEF_HPP
46
47#include "Ifpack2_BorderedOperator_decl.hpp"
48#include "Tpetra_MultiVector.hpp"
49#include "Teuchos_TestForException.hpp"
50
51namespace Ifpack2 {
52
53template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
55BorderedOperator (const Teuchos::RCP<const Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node > >& A) :
56 A_ (A)
57{
58 TEUCHOS_TEST_FOR_EXCEPTION(
59 A_.is_null (), std::runtime_error,
60 Teuchos::typeName (*this) << "::BorderedOperator constructor: "
61 "The input Operator A is null.");
62}
63
64template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
65Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
67{
68 return A_->getDomainMap();
69}
70
71template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
72Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
74{
75 return A_->getRangeMap();
76}
77
78template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
79bool
81{
82 return A_->hasTransposeApply();
83}
84
85template< class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node >
86void
88apply (const Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node >& X,
89 Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node >& Y,
90 Teuchos::ETransp mode,
91 Scalar coefAx,
92 Scalar coefY ) const
93{
94 TEUCHOS_TEST_FOR_EXCEPTION(
95 X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
96 "Ifpack2::BorderedOperator::apply(): X.getNumVectors() = "
97 << X.getNumVectors() << " != Y.getNumVectors() = "
98 << Y.getNumVectors() << ".");
99 A_->apply (X, Y, mode, coefAx, coefY );
100}
101
102} // namespace Ifpack2
103
104#define IFPACK2_BORDEREDOPERATOR_INSTANT(S,LO,GO,N) \
105 template class Ifpack2::BorderedOperator< S, LO, GO, N >;
106
107#endif /* IFPACK2_BorderedOperator_DEF_HPP */
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
The range Map of this operator. It must be compatible with Y.getMap().
Definition: Ifpack2_BorderedOperator_def.hpp:73
bool hasTransposeApply() const
Whether this operator can apply the transpose or conjugate transpose.
Definition: Ifpack2_BorderedOperator_def.hpp:80
BorderedOperator(const Teuchos::RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A)
Constructor with Tpetra::Operator input.
Definition: Ifpack2_BorderedOperator_def.hpp:55
void apply(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
Apply the bordered operator.
Definition: Ifpack2_BorderedOperator_def.hpp:88
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
The domain Map of this operator. It must be compatible with X.getMap().
Definition: Ifpack2_BorderedOperator_def.hpp:66
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74