Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_LocalOperator.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Tpetra: Templated Linear Algebra Services Package
5// Copyright (2008) Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
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// ************************************************************************
38// @HEADER
39
40#ifndef TPETRA_LOCALOPERATOR_HPP
41#define TPETRA_LOCALOPERATOR_HPP
42
44#include "Teuchos_BLAS_types.hpp"
45#include "Kokkos_ArithTraits.hpp"
46#include <type_traits>
47
48namespace Tpetra {
49
58 template<class Scalar, class Device>
60 public:
61 using scalar_type = typename Kokkos::ArithTraits<Scalar>::val_type;
62 using array_layout = Kokkos::LayoutLeft;
63 using device_type =
64 Kokkos::Device<typename Device::execution_space,
65 typename Device::memory_space>;
66
67 virtual ~LocalOperator () = default;
68
69 virtual void
70 apply (Kokkos::View<const scalar_type**, array_layout,
71 device_type, Kokkos::MemoryTraits<Kokkos::Unmanaged> > X,
72 Kokkos::View<scalar_type**, array_layout,
73 device_type, Kokkos::MemoryTraits<Kokkos::Unmanaged> > Y,
74 const Teuchos::ETransp mode,
75 const scalar_type alpha,
76 const scalar_type beta) const = 0;
77
78 virtual bool hasTransposeApply () const { return false; }
79 };
80
81} // namespace Tpetra
82
83#endif // TPETRA_LOCALOPERATOR_HPP
Forward declaration of Tpetra::LocalCrsMatrixOperator.
Abstract interface for local operators (e.g., matrices and preconditioners).
Namespace Tpetra contains the class and methods constituting the Tpetra library.