/usr/include/trilinos/NOX_Direction_Generic.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 126 127 | // $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 NOX_DIRECTION_GENERIC_H
#define NOX_DIRECTION_GENERIC_H
#include "Teuchos_RCP.hpp"
// Forward declarations
namespace Teuchos {
class ParameterList;
}
namespace NOX {
class GlobalData;
namespace Abstract {
class Vector;
class Group;
}
namespace Solver {
class Generic;
class LineSearchBased;
}
}
namespace NOX {
//! Search direction strategies
/*!
The Generic class spells out the interface. The Manager class can
instantiate any other concrete implementation. The remaining classes
are concrete implementations.
*/
namespace Direction {
//! %Generic direction interface
/*!
%Generic interface for calculating a search direction, \f$d\f$, to
be used in updating the iterate.
*/
class Generic {
public:
//! Constructor.
/*!
Constructors of derived objects should look like reset().
*/
Generic() {};
//! Destructor
virtual ~Generic() {};
//! Reset direction based on possibly new parameters.
virtual bool reset(const Teuchos::RCP<NOX::GlobalData>& gd,
Teuchos::ParameterList& params) = 0;
/*!
\brief Compute the direction vector, \c dir, for a specific method given
the current group, \c grp.
The \c grp is not const so that we can compute the F vector, the
Jacobian matrix, the %Newton vector, and so on.
Const access to the solver is used for getting additional
information such as the past solution, the iteration number, and
so on.
*/
virtual bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp,
const NOX::Solver::Generic& solver) = 0;
/*!
\brief Same as compute(NOX::Abstract::Vector&,
NOX::Abstract::Group&, const NOX::Solver::Generic&)
Enables direct support for line search based solvers for the
purpose of efficiency since the LineSearchBased object has a
getStep() function that some directions require.
If it is not redefined in the derived class, it will just call the
compute with the NOX::Solver::Generic argument.
*/
virtual bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp,
const NOX::Solver::LineSearchBased& solver);
};
} // namespace Direction
} // namespace NOX
#endif
|