/usr/include/trilinos/Ifpack_Utils.h is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
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 167 168 169 170 171 172 173 174 175 176 | /*@HEADER
// ***********************************************************************
//
// Ifpack: Object-Oriented Algebraic Preconditioner Package
// Copyright (2002) 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.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/
#ifndef IFPACK_UTILS_H
#define IFPACK_UTILS_H
#include "Ifpack_ConfigDefs.h"
#include "Epetra_Comm.h"
#if !( defined(_WIN32) )
# include "unistd.h" // Not a standard header file!
#endif
class Epetra_RowMatrix;
class Epetra_CrsMatrix;
class Epetra_CrsGraph;
class Epetra_RowMatrix;
class Epetra_MultiVector;
class Epetra_Vector;
/*! \file Ifpack_Utils.h
*/
//! Prints a line of `=' on cout
void Ifpack_PrintLine();
//! Stops the execution of code, so that a debugger can be attached.
void Ifpack_BreakForDebugger(Epetra_Comm& Comm);
//! Creates an overlapping Epetra_CrsMatrix. Returns 0 if OverlappingLevel is 0.
Epetra_CrsMatrix* Ifpack_CreateOverlappingCrsMatrix(const Epetra_RowMatrix* Matrix,
const int OverlappingLevel);
//! Creates an overlapping Epetra_CrsGraph. Returns 0 if OverlappingLevel is 0.
Epetra_CrsGraph* Ifpack_CreateOverlappingCrsMatrix(const Epetra_CrsGraph* Graph,
const int OverlappingLevel);
//! Convertes an integer to string.
string Ifpack_toString(const int& x);
//! Convertes a double to string.
string Ifpack_toString(const double& x);
//! Prints on cout the true residual.
int Ifpack_PrintResidual(char* Label, const Epetra_RowMatrix& A,
const Epetra_MultiVector& X, const Epetra_MultiVector&Y);
int Ifpack_PrintResidual(const int iter, const Epetra_RowMatrix& A,
const Epetra_MultiVector& X, const Epetra_MultiVector&Y);
void Ifpack_PrintSparsity_Simple(const Epetra_RowMatrix& A);
//! Analyzes the basic properties of the input matrix A; see \ref ifp_analyze.
int Ifpack_Analyze(const Epetra_RowMatrix& A, const bool Cheap = false,
const int NumPDEEqns = 1);
//! Analyzes the distribution of values of the input matrix A.
/*!
\param A - (In) matrix to be analyzed.
\param abs - (In) if \c true, the function will analyze matrix
B, whose elements are defined as \f$ B_{i,i} = | A_{i,i}| \f$.
\param steps - (In) number of intervals for the analysis.
An example of output is reported \ref ifp_matrix.
*/
int Ifpack_AnalyzeMatrixElements(const Epetra_RowMatrix& A,
const bool abs = false,
const int steps = 10);
//! Analyzes the distribution of values of the input vector Diagonal.
/*!
\param Diagonal - (In) Vector to be analyzed.
\param abs - (In) if \c true, the function will analyze vector
B, whose elements are defined as \f$ B_{i} = | D_{i}| \f$.
\param steps - (In) number of intervals for the analysis.
An example of output is reported \ref ifp_vector.
*/
int Ifpack_AnalyzeVectorElements(const Epetra_Vector& Diagonal,
const bool abs = false,
const int steps = 10);
//! Plots the sparsity pattern of an Epetra_RowMatrix into a PS file.
/*!
\param A (In) - Epetra_RowMatrix whose sparsity pattern will be plotted.
\param FileName (In) - char string containing the filename.
If 0, then the matrix label is used as file name,
after appending .ps.
\param NumPDEEqns (In) - number of PDE equations. The function will plot
the block structure of the matrix if NumPDEEqns > 1
\name Largely inspired from Yousef Saad's SPARSKIT plot function.
*/
int Ifpack_PrintSparsity(const Epetra_RowMatrix& A, const char* FileName = 0,
const int NumPDEEqns = 1);
//==============================================================================
class Ifpack_Element {
public:
Ifpack_Element() {};
Ifpack_Element(const Ifpack_Element& rhs) {
i_ = rhs.Index();
val_ = rhs.Value();
aval_ = rhs.AbsValue();
}
inline int Index() const {
return(i_);
}
inline double Value() const {
return(val_);
}
inline double AbsValue() const {
return(aval_);
}
inline void SetIndex(const int i)
{
i_ = i;
}
inline void SetValue(const double val)
{
val_ = val;
aval_ = IFPACK_ABS(val_);
}
inline bool operator <(const Ifpack_Element& rhs) const
{
if (rhs.AbsValue() > AbsValue())
return(false);
else if (rhs.AbsValue() < AbsValue())
return(true);
else if (rhs.Index() < Index())
return(true);
return(false);
}
private:
int i_;
double val_;
double aval_;
};
#endif // IFPACK_UTILS_H
|