/usr/include/trilinos/NOX_StatusTest_Divergence.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 128 129 130 131 132 133 134 135 136 137 138 139 | //@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_STATUS_DIVERGENCE_H
#define NOX_STATUS_DIVERGENCE_H
#include "NOX_StatusTest_Generic.H" // base class
// Forward declarations
namespace NOX {
namespace Solver {
class Generic;
}
}
namespace NOX {
namespace StatusTest {
//! Failure test based on a threshold value of the norm of F.
/*!
This status test returns NOX::StatusTest::Failed if the norm of F exceeds
a threshold value for n \e consecutive iterations, i.e.
\f[ \| F \| > {\rm threshold}\f]
for n \e consecutive iterations, the status is set to
NOX::StatusTest::Failed and returned. Otherwise, the status is set
to NOX::StatusTest::Uncoverged and returned. Both n and the
threshold are specified in the constructor, by \c n and \c thresh,
respectively. While a value for \c thresh must be provided, a default
value of \c n = 1 is assumed.
*/
class Divergence : public Generic {
public:
//! Constructor.
/*!
\param thresh - Threshold for divergence test
\param n - Number of consecutive nonlinear iterations
*/
Divergence(double thresh, int n = 1);
//! Destructor.
virtual ~Divergence();
/*!
\brief Tests the stopping criterion.
\note
The nature of this test is such that it \e must be executed at
every nonlinear iteration, so we don't use the checkType argument.
*/
virtual NOX::StatusTest::StatusType
checkStatus(const NOX::Solver::Generic& problem,
NOX::StatusTest::CheckType checkType);
virtual NOX::StatusTest::StatusType getStatus() const;
virtual ostream& print(ostream& stream, int indent = 0) const;
/*!
\brief Returns the user-specified number of steps that can
consecutively fail the threshold test before the test returns a
failed status.
*/
virtual int getMaxNumSteps() const;
//! Returns the current number of steps that have consecutively failed the threshold test.
virtual int getCurrentNumSteps() const;
//! Returns the user-specified threshold.
virtual double getThreshold() const;
private:
//! User supplied value of n.
int maxSteps;
//! Current number of consecutive nonlinear iterations that have failed the specified threshold.
int numSteps;
//! The last nonlinear iteration index.
/*! This is used to prevent counting a step multiple times if by chance
the status test is called multiple times between iterations.
*/
int lastIteration;
//! User specified threshold.
double threshold;
//! %Status
NOX::StatusTest::StatusType status;
};
} // namespace Status
} // namespace NOX
#endif
|