/usr/include/trilinos/LOCA_Eigensolver_AbstractStrategy.H is in libtrilinos-nox-dev 12.10.1-3.
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 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// 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.
//
// 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 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
|