/usr/include/trilinos/Amesos.h is in libtrilinos-amesos-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 | /*
// @HEADER
// ***********************************************************************
//
// Amesos: Direct Sparse Solver Package
// Copyright (2004) 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
*/
#ifndef _AMESOS_FACTORY_H_
#define _AMESOS_FACTORY_H_
#include "Amesos_BaseSolver.h"
/** \brief Factory for binding a third party direct solver to an
* Epetra_LinearProblem.
*
* Amesos creates an instance of a solver, binding a third party direct solver
* to an Epetra_LinearProblem, allowing access to the specified third party
* solver through the Amesos interface (i.e. Numeric Factorization
* SymbolicFactrozation(), Solve() and support functions.)
*/
class Amesos {
public:
/** \name Creation method for char* */
//@{
/** \brief Amesos Create method.
*
* Creates an instance of the Amesos_BaseSolver class specified by
* ClassType.
*
* <br \>Preconditions:<ul>
* <li>ClassType must be one of the recognized class types.
* Return 0 on failure.
* <li>ClassType must specify a third party solver that has been
* linked with this particular implementation. Return 0 on failure.
* <li>Epetra_LinearProblem may be empty. Although the linear problem is
* not checked at the time of construction, the operator must be an
* Epetra_RowMatrix, or derived from an Epetra_RowMatrix.
* </ul>
*
* <br \>Postconditions:<ul>
* <li>If Create() returns a non-null pointer, that pointer points to an
* Amesos solver.
* </ul>
*/
Amesos_BaseSolver *Create(const char *ClassType,
const Epetra_LinearProblem& LinearProblem );
/** \brief Creation method for string input. */
Amesos_BaseSolver *Create(const std::string CT,
const Epetra_LinearProblem& LinearProblem );
// @}
/** \name Query methods */
//@{
/** \brief Queries whether a given interface is available or not. */
bool Query(const char * ClassType);
/** \brief Queries whether a given interface is available or not. */
bool Query(const std::string CT);
/** \brief Get the list of valid parameters. */
static Teuchos::ParameterList GetValidParameters();
//@}
}; // End of class Amesos
#endif /* _AMESOS_FACTORY_H_ */
|