/usr/include/trilinos/MueLu_BlockedDirectSolver_decl.hpp is in libtrilinos-muelu-dev 12.12.1-5.
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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | // @HEADER
//
// ***********************************************************************
//
// MueLu: A package for multigrid based preconditioning
// Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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
// Jonathan Hu (jhu@sandia.gov)
// Andrey Prokopenko (aprokop@sandia.gov)
// Ray Tuminaro (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
/*
* MueLu_BlockedDirectSolver_decl.hpp
*
* Created on: 09.02.2014
* Author: tobias
*/
#ifndef MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_
#define MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_
#include "MueLu_ConfigDefs.hpp"
#include <Teuchos_ParameterList.hpp>
#include <Xpetra_MapExtractor_fwd.hpp>
#include "MueLu_BlockedDirectSolver_fwd.hpp"
#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_DirectSolver_fwd.hpp"
#include "MueLu_MergedBlockedMatrixFactory_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_FactoryManagerBase_fwd.hpp"
#include "MueLu_SmootherBase_fwd.hpp"
#include "MueLu_Utilities_fwd.hpp"
namespace MueLu {
/*!
@class BlockedDirectSolver
@brief direct solver for nxn blocked matrices
The nxn block matrix A as input is automatically merged and then solved
by a direct solver.
*/
template <class Scalar = SmootherPrototype<>::scalar_type,
class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class BlockedDirectSolver : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
{
typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
#undef MUELU_BLOCKEDDIRECTSOLVER_SHORT
#include "MueLu_UseShortNames.hpp"
public:
//! @name Constructors / destructors
//@{
/*! @brief Constructor
*/
BlockedDirectSolver();
//! Destructor
virtual ~BlockedDirectSolver() { }
//@}
//! Input
//@{
RCP<const ParameterList> GetValidParameterList() const;
void DeclareInput(Level ¤tLevel) const;
//@}
//! @name Setup and Apply methods.
//@{
/*! @brief Setup routine
* Call the underlaying Setup routine of the nested direct solver once the input block matrix has been merged
*/
void Setup(Level ¤tLevel);
/*! @brief Apply the direct solver.
Solves the linear system <tt>AX=B</tt> using the constructed solver.
@param X initial guess
@param B right-hand side
@param InitialGuessIsZero This option has no effect.
*/
void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
//@}
RCP<SmootherPrototype> Copy() const;
//! @name Overridden from Teuchos::Describable
//@{
//! Return a simple one-line description of this object.
std::string description() const;
//! Print the object with some verbosity level to an FancyOStream object.
//using MueLu::Describable::describe; // overloading, not hiding
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
//! Get a rough estimate of cost per iteration
size_t getNodeSmootherComplexity() const;
//@}
private:
//! smoother type
std::string type_;
//! Factory to generate merged block matrix
RCP<MergedBlockedMatrixFactory> MergedAFact_;
//! Direct solver
RCP<DirectSolver> s_; // solver object
//! block operator
RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
}; // class BlockedDirectSolver
} // namespace MueLu
#define MUELU_BLOCKEDDIRECTSOLVER_SHORT
#endif /* MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_ */
|