/usr/include/trilinos/LOCA_Eigensolver_AbstractStrategy.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 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// NOX: An Object-Oriented Nonlinear Solver Package
// Copyright (2002) Sandia Corporation
//
// LOCA: Library of Continuation Algorithms Package
// Copyright (2005) 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 Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
// CVS Information
// $Source$
// $Author$
// $Date$
// $Revision$
// ************************************************************************
//@HEADER
#ifndef LOCA_EIGENSOLVER_ABSTRACTSTRATEGY_H
#define LOCA_EIGENSOLVER_ABSTRACTSTRATEGY_H
#include "Teuchos_RCP.hpp"
#include "NOX_Abstract_Group.H" // for ReturnType
namespace LOCA {
//! Collection of eigensolver strategies
namespace Eigensolver {
//! Abstract interface class for Eigensolver strategies
/*!
* AbstractStrategy defines an abstract interface for eigensolver
* strategies. It is used by LOCA::Stepper to compute eigenvalues of
* the steady-state solution after each continuation step.
*
* The interface currently defines one pure virtual method,
* computeEigenvalues(), to compute the eigenvalues. Derived classes
* should implement this method for a particular eigensolver strategy.
* Constructors for derived classes should be of the form:
*
* \code
* class Derived : public AbstractStrategy {
* public:
* Derived(
* const Teuchos::RCP<LOCA::GlobalData>& global_data,
* const Teuchos::RCP<LOCA::Parameter::SublistParser>& topParams,
const Teuchos::RCP<Teuchos::ParameterList>& eigenParams);
* ...
* };
* \endcode
*
* where \c global_data is the LOCA global data object, \c topParams is
* the parsed top-level parameter list, and \c eigenParams
* is a parameter list of eigensolver parameters.
*
* This class and its children follow the Strategy pattern as defined
* in Erich Gamma, et al. "Design Patterns: Elements of Reusable
* Object-Oriented Software." Addison Wesley, Boston, MA, 1995.
*/
class AbstractStrategy {
public:
//! Constructor
AbstractStrategy() {}
//! Destructor
virtual ~AbstractStrategy() {}
//! Compute eigenvalues/eigenvectors in group \c group
/*!
* \param group [in] NOX Group to compute eigenvalues of
* \param evals_r [out] Real eigenvalues
* \param evals_i [out] Imaginary eigenvalues
* \param evecs_r [out] Real eigenvectors
* \param evecs_i [out] Imaginary eigenvectors
* \returns ReturnType code indicating success or failure
*/
virtual NOX::Abstract::Group::ReturnType
computeEigenvalues(
NOX::Abstract::Group& group,
Teuchos::RCP< std::vector<double> >& evals_r,
Teuchos::RCP< std::vector<double> >& evals_i,
Teuchos::RCP< NOX::Abstract::MultiVector >& evecs_r,
Teuchos::RCP< NOX::Abstract::MultiVector >& evecs_i) = 0;
private:
//! Private to prohibit copying
AbstractStrategy(const AbstractStrategy&);
//! Private to prohibit copying
AbstractStrategy& operator = (const AbstractStrategy&);
}; // Class AbstractStrategy
} // Namespace Eigensolver
} // Namespace LOCA
#endif // LOCA_EIGENSOLVER_ABSTRACTSTRATEGY_H
|