/usr/include/trilinos/Ifpack2_Details_CanChangeMatrix.hpp is in libtrilinos-ifpack2-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | /*@HEADER
// ***********************************************************************
//
// Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
// Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/
#ifndef IFPACK2_DETAILS_CANCHANGEMATRIX_HPP
#define IFPACK2_DETAILS_CANCHANGEMATRIX_HPP
/// \file Ifpack2_Details_CanChangeMatrix.hpp
/// \brief Declaration of interface for preconditioners that can
/// change their matrix after construction
///
/// \warning This file is an implementation detail of Ifpack2. Users
/// must not depend on this file's name or contents.
#include <Ifpack2_ConfigDefs.hpp>
#include <Tpetra_RowMatrix_decl.hpp>
namespace Ifpack2 {
namespace Details {
/// \class CanChangeMatrix
/// \brief Mix-in interface for preconditioners that can change
/// their matrix after construction
/// \tparam RowMatrixType Specialization of Tpetra::RowMatrix
///
/// \warning This class is an implementation detail of Ifpack2.
/// Users must not depend on this class.
///
/// An Ifpack2 preconditioner (a subclass of
/// Ifpack2::Preconditioner) may inherit from this interface in
/// order to express that users can change its matrix (the matrix
/// that it preconditions) after construction.
///
/// We introduced this class to facilitate gradual porting of
/// Ifpack2 preconditioners to support this feature. Originally,
/// Ifpack2 preconditioners did not provide an interface to change
/// their matrix after construction. If a preconditioner (a
/// subclass of Ifpack2::Preconditioner) inherits from this
/// interface, that tells other Ifpack2 classes that the
/// preconditioner accepts matrix changes. This is particularly
/// useful for preconditioners that implement NestedPreconditioner,
/// since changing the inner preconditioner requires the
/// NestedPreconditioner to give its new inner preconditioner the
/// "inner matrix." The inner matrix depends on the particular
/// nested preconditioner. For example, with AdditiveSchwarz, it is
/// the result of LocalFilter on an overlap matrix.
///
/// Changing the matrix puts the preconditioner back in an
/// "pre-initialized" state. You must first call initialize(), then
/// compute(), before you may call apply() on this preconditioner.
/// Depending on the implementation, it may be legal to set the
/// matrix to null. In that case, you may not call initialize() or
/// compute() until you have subsequently set a nonnull matrix.
template<class RowMatrixType>
class CanChangeMatrix {
public:
/// \brief Set the new matrix.
///
/// \param A [in] The new matrix. This is const by Ifpack2
/// convention, for the same reason that the input matrix to any
/// Ifpack2 preconditioner's constructor is always const.
///
/// Calling this method with a matrix different than the
/// preconditioner's current matrix resets the preconditioner's
/// state. After calling this method with a nonnull input, you
/// must first call initialize() and compute() (in that order)
/// before you may call apply().
///
/// You may call this method with a null input. If A is null, then
/// you may not call initialize() or compute() until you first call
/// this method again with a nonnull input. This method invalidates
/// any previous factorization whether or not A is null, so calling
/// setMatrix() with a null input is one way to clear the
/// preconditioner's state (and free any memory that it may be
/// using).
///
/// The new matrix A need not necessarily have the same Maps or even
/// the same communicator as the original matrix.
virtual void
setMatrix (const Teuchos::RCP<const RowMatrixType>& A) = 0;
//! Destructor
virtual ~CanChangeMatrix () {}
};
} // namespace Details
} // namespace Ifpack2
#endif // IFPACK2_DETAILS_CANCHANGEMATRIX_HPP
|