/usr/include/trilinos/Pliris.h is in libtrilinos-pliris-dev 12.4.2-2.
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 | /*
//@HEADER
// ************************************************************************
//
// Pliris: Parallel Dense Solver Package
// Copyright 2004 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 Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
*/
#ifndef _PLIRIS_H_
#define _PLIRIS_H_
class Epetra_Comm;
class Epetra_BlockMap;
class Epetra_MultiVector;
#include "Epetra_LinearProblem.h"
#include "Epetra_Object.h"
#include "Epetra_Vector.h"
#include "Epetra_SerialDenseVector.h"
//! Pliris: An Obect-Oriented Interface to a Dense LU Solver.
/*! The Pliris class : Provides the functionality to interface to a dense LU
*/
class Pliris {
public:
Pliris(Epetra_Vector * A, Epetra_MultiVector * X, Epetra_MultiVector * B);
//! Pliris Default constructor.
Pliris ();
//! Pliris LHS Set
/*! Associates an already defined Epetra_MultiVector (or Epetra_Vector) as the initial guess
and location where the solution will be return.
*/
int SetLHS(Epetra_MultiVector * X);
//! Pliris RHS Set
/*! Associates an already defined Epetra_MultiVector (or Epetra_Vector) as the right-hand-side of
the linear system.
*/
int SetRHS(Epetra_MultiVector * B);
//! Pliris Matrix Set
/*! Associates an already defined Epetra_Vector as the matrix (column ordered) of
the linear system.
*/
int SetMatrix(Epetra_Vector * A);
//! Pliris Matrix Set
/*! Associates an already defined Epetra_SerialDenseVector as the matrix (column ordered) of
the linear system.
*/
int SetMatrix(Epetra_SerialDenseVector * A);
//! Pliris GetDistirbution
/*! Gives the distribution information that is required by the dense solver
*/
/*!
\param nprocs_row(In) - number of processors for a row
\param number_of_unknowns(In) - order of the dense matrix
\param nrhs(In) - number of right hand sides
\param my_rows(Out) - number of rows of the matrix on this processor
\param my_cols (Out) - number of columns of the matrix on this processor
\param my_first_row(Out) - first (global) row number on this processor (array starts at index 1)
\param my_first_col (Out) - first (global) column number on this processor (array starts at index 1)
\param my_rhs(Out) - number of Right hand sides on this processor
\param my_row(Out) - row number in processor mesh, 0 to the number of processors for a column -1
\param my_col(Out) - column number in processor mesh, 0 to the number of processors for a row -1
*/
int GetDistribution( int * nprocs_row,
int * number_of_unknowns,
int * nrhs,
int * my_rows,
int * my_cols,
int * my_first_row,
int * my_first_col,
int * my_rhs,
int * my_row,
int * my_col );
//! Pliris FactorSolve
/*! Factors and solves the dense matrix
*/
/*!
\param A(InOut) -- Epetra Vector that has the matrix and rhs packed( Note: matrix is overwritten)
\param my_rows(In) -- number of rows of the matrix on this processor
\param my_cols(In) -- number of columns of the matrix on this processor
\param matrix_size(In) -- order of the dense matrix
\param num_procsr(In) -- number of processors for a row
\param num_rhs(In) -- number of right hand sides
\param secs(Out) -- factor and solve time in seconds
*/
int FactorSolve( Epetra_Vector * A,
int my_rows,
int my_cols,
int* matrix_size,
int* num_procsr,
int* num_rhs,
double* secs);
//! Pliris FactorSolve
/*! Factors and solves the dense matrix
*/
/*!
\param AA(In) -- Epetra Serial Dense Vector that has the matrix and rhs packed
\param my_rows(In) -- number of rows of the matrix on this processor
\param my_cols(In) -- number of columns of the matrix on this processor
\param matrix_size(In) -- order of the dense matrix
\param num_procsr(In) -- number of processors for a row
\param num_rhs(In) -- number of right hand sides
\param secs(Out) -- factor and solve time in seconds
*/
int FactorSolve( Epetra_SerialDenseVector * AA,
int my_rows,
int my_cols,
int* matrix_size,
int* num_procsr,
int* num_rhs,
double* secs);
//! Pliris Factor
/*! Factors the dense matrix
*/
/*!
\param A(In) -- Epetra Vector that has the matrix packed
\param matrix_size(In) -- order of the dense matrix
\param num_procsr(In) -- number of processors for a row
\param permute(In) -- permutation matrix
\param secs(Out) -- factor and solve time in seconds
*/
int Factor( Epetra_Vector* A,
int* matrix_size,
int* num_procsr,
int* permute,
double* secs);
//! Pliris Solve
/*! Solves the previously factored dense matrix
*/
/*!
\param permute(In) -- permutation matrix
\param num_rhs(In) -- factor and solve time in seconds
\ Note that the matrix has been previously factored by Factor
\ The RHS has been set by SetRHS(Epetra_MultiVector * B)
\ On output the result is in the RHS
*/
int Solve(int* permute,
int* num_rhs);
//! Pliris Default Destructor.
/*! Completely deletes a Pliris object.
*/
virtual ~Pliris(void);
//@
protected:
double *x_;
double *a_;
double *b_;
int x_LDA_;
int b_LDA_;
bool inConstructor_;
Epetra_MultiVector * X_;
Epetra_MultiVector * B_;
Epetra_Vector * A_;
Epetra_SerialDenseVector * AA_;
};
#endif /* _PLIRIS_H_ */
|