/usr/include/trilinos/NOX_Direction_SteepestDescent.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 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 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// NOX: An Object-Oriented Nonlinear Solver Package
// Copyright (2002) 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 NOX_DIRECTION_STEEPESTDESCENT_H
#define NOX_DIRECTION_STEEPESTDESCENT_H
#include "NOX_Direction_Generic.H" // base class
// Forward declaration
namespace NOX {
class Utils;
class GlobalData;
namespace MeritFunction {
class Generic;
}
}
namespace NOX {
namespace Direction {
//! %Calculates the steepest descent direction.
/*!
Calculates the direction
\f[
d = - \gamma \nabla f(x) = -\gamma J(x)^T F(x)
\f]
This is the (scaled) gradient of the function \f$f(x) = \frac{1}{2}
\|F(x)\|^2\f$. The valued of \f$\gamma\f$ depends on the choice of
"Scaling Type" below.
<B>Parameters</B>
"Direction":
<ul>
<li>"Method" = "Steepest Descent"
</ul>
"Direction"/"Steepest Descent":
<ul>
<li>"Scaling Type" can be either of:
<ul>
<li>"2-Norm" - \f$ \gamma = \displaystyle\frac{1}{\|d\|_2} \f$ [default]
<li>"Quadratic Model Min" - \f$ \gamma = \displaystyle\frac{\|d\|_2^2}{d^T J^T J d} \f$
<li>"F 2-Norm" - \f$ \gamma = \displaystyle\frac{1}{\|F(x)\|_2} \f$
<li>"None" - No scaling
</ul>
</ul>
*/
class SteepestDescent : public Generic {
public:
//! Scaling types
enum ScalingType {
//! Scale by the 2-norm of the gradient
TwoNorm,
//! Scale by the step that minimizes the 1-D quadratic
QuadMin,
//! Scale by the 2-norm of F
FunctionTwoNorm,
//! No scaling at all
None
};
//! Constructor
SteepestDescent(const Teuchos::RCP<NOX::GlobalData>& gd,
Teuchos::ParameterList& params);
//! Destructor
~SteepestDescent();
// derived
bool reset(const Teuchos::RCP<NOX::GlobalData>& gd,
Teuchos::ParameterList& params);
// derived
bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp,
const NOX::Solver::Generic& solver);
// derived
virtual bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp,
const NOX::Solver::LineSearchBased& solver);
private:
//! Print error message and throw error
void throwError(const std::string& functionName, const std::string& errorMsg);
private:
//! Global data pointer. Keep this so any stored parameter list remains valid.
Teuchos::RCP<NOX::GlobalData> globalDataPtr;
//! Printing Utils
Teuchos::RCP<NOX::Utils> utils;
//! Temporary vector used in Cauchy scaling factor calculation
Teuchos::RCP<NOX::Abstract::Vector> tmpVecPtr;
//! Type of scaling of the Cauchy direction
ScalingType scaleType;
//! Pointer to a user defined merit function
Teuchos::RCP<NOX::MeritFunction::Generic> meritFuncPtr;
};
} // namespace Direction
} // namespace NOX
#endif
|