/usr/include/trilinos/fei_Matrix_Local.hpp 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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | /*--------------------------------------------------------------------*/
/* Copyright 2007 Sandia Corporation. */
/* Under the 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. Export of this program may require */
/* a license from the United States Government. */
/*--------------------------------------------------------------------*/
#ifndef _fei_Matrix_Local_hpp_
#define _fei_Matrix_Local_hpp_
#include <fei_SharedPtr.hpp>
#include <fei_MatrixGraph.hpp>
#include <fei_Matrix.hpp>
#include <fei_SparseRowGraph.hpp>
#include <vector>
namespace fei {
class Matrix_Local : public fei::Matrix {
public:
Matrix_Local(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
fei::SharedPtr<fei::SparseRowGraph> sparseRowGraph);
virtual ~Matrix_Local();
static fei::SharedPtr<fei::Matrix>
create_Matrix_Local(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
bool blockEntry);
const char* typeName();
/** Method for supplying parameters
*/
int parameters(const fei::ParameterSet& paramset);
/** Method for supplying parameters
*/
int parameters(int numParams, const char* const* paramStrings);
/** Obtain the fei::MatrixGraph associated with this matrix */
fei::SharedPtr<fei::MatrixGraph> getMatrixGraph() const;
/** Set the fei::MatrixGraph associated with this matrix */
void setMatrixGraph(fei::SharedPtr<fei::MatrixGraph> matrixGraph);
/** Get the global number of rows in the matrix.
*/
int getGlobalNumRows() const;
/** Get the local number of rows in the matrix.
*/
int getLocalNumRows() const;
/** Get the length of a row of the matrix.
@param row Global 0-based equation number
@param length Output. Length of the row.
@return error-code non-zero if any error occurs.
*/
int getRowLength(int row, int& length) const;
/** Set a specified scalar throughout the matrix. */
int putScalar(double scalar);
/** Obtain a copy of the coefficients and indices for a row of the matrix.
@param row Global 0-based equation number
@param coefs Caller-allocated array, length 'len', to be filled with
coefficients
@param indices Caller-allocated array, length 'len', to be filled with
indices. (These indices will be global 0-based equation numbers.)
@param len Length of the caller-allocated coefs and indices arrays
@return error-code non-zero if any error occurs.
*/
int copyOutRow(int row, int len, double* coefs, int* indices) const;
/** Sum coefficients into the matrix, adding them to any coefficients that
may already exist at the specified row/column locations.
@param numRows
@param rows
@param numCols
@param cols
@param values
@param format For compatibility with old FEI elemFormat...
0 means row-wise or row-major, 3 means column-major.
Others not recognized
*/
int sumIn(int numRows, const int* rows,
int numCols, const int* cols,
const double* const* values,
int format=0);
/** Copy coefficients into the matrix, overwriting any coefficients that
may already exist at the specified row/column locations.
@param numRows
@param rows
@param numCols
@param cols
@param values
@param format For compatibility with old FEI elemFormat...
0 means row-wise or row-major, 3 means column-major.
Others not recognized
*/
int copyIn(int numRows, const int* rows,
int numCols, const int* cols,
const double* const* values,
int format=0);
/** Sum coefficients into the matrix, specifying row/column locations by
identifier/fieldID pairs.
@param fieldID Input. field-identifier for which data is being input.
@param idType Input. The identifier-type of the identifiers.
@param rowID Input. Identifier in row-space, for which data is being
input.
@param colID Input. Identifier in column-space, for which data is being
input.
@param data Input. C-style table of data. num-rows is the field-size
(i.e., number of scalar components that make up the field) of 'fieldID',
as is num-columns.
@param format For compatibility with old FEI elemFormat...
0 means row-wise or row-major, 3 means column-major. Others not recognized
@return error-code 0 if successful
*/
int sumInFieldData(int fieldID,
int idType,
int rowID,
int colID,
const double* const* data,
int format=0);
/** Sum coefficients into the matrix, specifying row/column locations by
identifier/fieldID pairs.
@param fieldID Input. field-identifier for which data is being input.
@param idType Input. The identifier-type of the identifiers.
@param rowID Input. Identifier in row-space, for which data is being
input.
@param colID Input. Identifier in column-space, for which data is being
input.
@param data Input. 1-D list representing a packed table of data. Data may
be backed in row-major or column-major order and this may be specified with
the 'format' argument. The "table" of data is of size num-rows X num-columns
and num-rows is the field-size (i.e., number of scalar components that
make up the field) of 'fieldID', as is num-columns.
@param format For compatibility with old FEI elemFormat...
0 means row-wise or row-major, 3 means column-major. Others not recognized
@return error-code 0 if successful
*/
int sumInFieldData(int fieldID,
int idType,
int rowID,
int colID,
const double* data,
int format=0);
/** Sum coefficients, associated with a connectivity-block that was
initialized on the MatrixGraph object, into this matrix.
@param blockID
@param connectivityID
@param values
@param format For compatibility with old FEI elemFormat...
0 means row-wise or row-major, 3 means column-major. Others not recognized
*/
int sumIn(int blockID, int connectivityID,
const double* const* values,
int format=0);
/** Perform any necessary internal communications/synchronizations or other
operations appropriate at end of data input. For some implementations this
will be a no-op.
*/
int globalAssemble();
/** Form a matrix-vector product y = 'this' * x
*/
int multiply(fei::Vector* x,
fei::Vector* y);
/** After local overlapping data has been input, (e.g., element-data for a
finite-element application) call this method to have data that
corresponds to shared identifiers be communicated from sharing-but-not-
owning processors, to owning processors.
*/
int gatherFromOverlap(bool accumulate = true);
/** Write the matrix contents into the specified file.
@param filename Text name of the file to be created or overwritten.
If in a parallel environment, each processor will take turns writing
into the file.
@param matrixMarketFormat Optional argument, defaults to true. If true
the contents of the file will be MatrixMarket real array format. If not
true, the contents of the file will contain the matrix global
dimensions on the first line, and all following lines will contain a
space-separated triple with global row index first, global column index
second and coefficient value third.
Note also that if matrixMarketFormat is true, indices will be output in
1-based form, but if not true, indices will be 0-based.
@return error-code 0 if successful, -1 if some error occurs such as
failure to open file.
*/
int writeToFile(const char* filename,
bool matrixMarketFormat=true);
/** Write the matrix contents into the specified ostream.
@param ostrm ostream to be written to.
@param matrixMarketFormat Optional argument, defaults to true. If true
the data will be written in MatrixMarket real array format. If not
true, the stream will receive the matrix global
dimensions on the first line, and all following lines will contain a
space-separated triple with global row index first, global column index
second and coefficient value third.
Note also that if matrixMarketFormat is true, indices will be output in
1-based form, but if not true, indices will be 0-based.
@return error-code 0 if successful, -1 if some error occurs.
*/
int writeToStream(FEI_OSTREAM& ostrm,
bool matrixMarketFormat=true);
/** Query whether the underlying matrix object is a block-entry matrix.
*/
bool usingBlockEntryStorage();
/** Set a "mark" point on the current state of the matrix, so that later
a query can be made to see if the matrix has changed since this mark
was set.
*/
void markState();
/** Query whether the matrix has changed since markState() was called. If
markState() hasn't been called since the matrix was constructed, then
this query will return true.
*/
bool changedSinceMark();
const std::vector<int>& getRowNumbers() const;
const std::vector<int>& getRowOffsets() const;
const std::vector<int>& getColumnIndices() const;
const std::vector<double>& getCoefs() const;
private:
int getRowIndex(int rowNumber) const;
int giveToMatrix(int numRows, const int* rows,
int numCols, const int* cols,
const double* const* values,
bool sumInto, int format);
fei::SharedPtr<fei::MatrixGraph> matrixGraph_;
fei::SharedPtr<fei::SparseRowGraph> sparseRowGraph_;
std::vector<double> coefs_;
bool stateChanged_;
std::vector<double> work_data1D_;
std::vector<const double*> work_data2D_;
};//class Matrix_Local
}//namespace fei
#endif
|