Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_BandedContainer_decl.hpp
Go to the documentation of this file.
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#ifndef IFPACK2_BANDEDCONTAINER_DECL_HPP
43#define IFPACK2_BANDEDCONTAINER_DECL_HPP
44
47
48#include "Ifpack2_Container.hpp"
49#include "Tpetra_MultiVector.hpp"
50#include "Tpetra_Map.hpp"
51#include "Tpetra_RowMatrix.hpp"
52#include "Teuchos_SerialBandDenseMatrix.hpp"
53
54namespace Ifpack2 {
55
100
101template<class MatrixType, class LocalScalarType>
103: public ContainerImpl<MatrixType, LocalScalarType>
104{
106
107private:
114 using matrix_type = MatrixType;
116 using LSC = LocalScalarType;
118
120 using typename Container<MatrixType>::SC;
122 using typename Container<MatrixType>::LO;
124 using typename Container<MatrixType>::GO;
126 using typename Container<MatrixType>::NO;
127
128 using typename Container<MatrixType>::ISC;
129 using typename ContainerImpl<MatrixType, LSC>::LISC;
130
131 using typename Container<MatrixType>::mv_type;
132 using typename Container<MatrixType>::map_type;
133 using local_mv_type = Tpetra::MultiVector<LSC, LO, GO, NO>;
134 using typename Container<MatrixType>::vector_type;
135 using typename Container<MatrixType>::import_type;
136
137 using typename Container<MatrixType>::HostView;
138 using typename ContainerImpl<MatrixType, LSC>::HostSubviewLocal;
139 using typename ContainerImpl<MatrixType, LSC>::ConstHostSubviewLocal;
140 using typename ContainerImpl<MatrixType,LSC>::block_crs_matrix_type;
141 using HostViewLocal = typename local_mv_type::dual_view_type::t_host;
142
143 static_assert(std::is_same<MatrixType,
144 Tpetra::RowMatrix<SC, LO, GO, NO> >::value,
145 "Ifpack2::BandedContainer: Please use MatrixType = Tpetra::RowMatrix.");
146
155 using typename Container<MatrixType>::row_matrix_type;
156
158public:
160
161
172 BandedContainer (const Teuchos::RCP<const row_matrix_type>& matrix,
173 const Teuchos::Array<Teuchos::Array<LO> >& partitions,
174 const Teuchos::RCP<const import_type>&,
175 bool pointIndexed);
176
178
180 virtual ~BandedContainer ();
181
183
185
187 virtual void setParameters (const Teuchos::ParameterList& List) override;
188
190
192
194 virtual void initialize () override;
195
197 virtual void compute () override;
198
201 void computeBandwidth();
202
203 void clearBlocks() override;
204
206
208
212 virtual std::ostream& print (std::ostream& os) const override;
213
215
217
219 virtual std::string description () const override;
220
222 virtual void
223 describe (Teuchos::FancyOStream &out,
224 const Teuchos::EVerbosityLevel verbLevel =
225 Teuchos::Describable::verbLevel_default) const override;
226
228
230 static std::string getName();
231
232private:
233
235 void extract() override;
236
240 void factor ();
241
250 void
251 solveBlock(ConstHostSubviewLocal X,
252 HostSubviewLocal Y,
253 int blockIndex,
254 Teuchos::ETransp mode,
255 const LSC alpha,
256 const LSC beta) const override;
257
259 std::vector<Teuchos::SerialBandDenseMatrix<int, LSC> > diagBlocks_;
260
262 Teuchos::Array<int> ipiv_;
263
264 Teuchos::Array<LO> kl_; //< number of subdiagonals
265 Teuchos::Array<LO> ku_; //< number of superdiagonals
266
268 Teuchos::Array<LSC> scalars_;
269
271 Teuchos::Array<LO> scalarOffsets_;
272};
273
274} // namespace Ifpack2
275
276#endif // IFPACK2_BANDEDCONTAINER_DECL_HPP
Store and solve a local Banded linear problem.
Definition Ifpack2_BandedContainer_decl.hpp:104
BandedContainer(const Teuchos::RCP< const row_matrix_type > &matrix, const Teuchos::Array< Teuchos::Array< LO > > &partitions, const Teuchos::RCP< const import_type > &, bool pointIndexed)
Constructor.
Definition Ifpack2_BandedContainer_def.hpp:62
virtual void compute() override
Initialize and compute each block.
Definition Ifpack2_BandedContainer_def.hpp:242
virtual void initialize() override
Do all set-up operations that only require matrix structure.
Definition Ifpack2_BandedContainer_def.hpp:208
virtual std::ostream & print(std::ostream &os) const override
Print information about this object to the given output stream.
Definition Ifpack2_BandedContainer_def.hpp:530
virtual ~BandedContainer()
Destructor (declared virtual for memory safety of derived classes).
Definition Ifpack2_BandedContainer_def.hpp:79
virtual void setParameters(const Teuchos::ParameterList &List) override
Set all necessary parameters (super- and sub-diagonal bandwidth)
Definition Ifpack2_BandedContainer_def.hpp:83
static std::string getName()
Get the name of this container type for Details::constructContainer()
Definition Ifpack2_BandedContainer_def.hpp:582
virtual std::string description() const override
A one-line description of this object.
Definition Ifpack2_BandedContainer_def.hpp:541
void computeBandwidth()
Definition Ifpack2_BandedContainer_def.hpp:101
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const override
Print the object with some verbosity level to the given FancyOStream.
Definition Ifpack2_BandedContainer_def.hpp:563
The implementation of the numerical features of Container (Jacobi, Gauss-Seidel, SGS)....
Definition Ifpack2_Container_decl.hpp:344
typename Kokkos::Details::ArithTraits< SC >::val_type ISC
Internal representation of Scalar in Kokkos::View.
Definition Ifpack2_Container_decl.hpp:135
typename mv_type::dual_view_type::t_host HostView
Definition Ifpack2_Container_decl.hpp:139
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:74