/usr/include/trilinos/NOX_StatusTest_MaxIters.H is in libtrilinos-nox-dev 12.12.1-5.
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 | // $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_STATUS_MAXITERS_H
#define NOX_STATUS_MAXITERS_H
#include "NOX_StatusTest_Generic.H" // base class
#include "NOX_Utils.H" // class data element
namespace NOX {
namespace StatusTest {
//! Failure test based on the maximum number of nonlinear solver iterations.
/*!
Let \f$k\f$ denote the current number of iterations (accessed via
NOX::Solver::getNumIterations) and \f$k_{\max}\f$ denote the
tolerance set in the constructor of this status test.
This test returns NOX::StatusTest::Failed if
\f$
k \geq k_{\rm max}.
\f$
Otherwise, it returns NOX::StatusTest::Unconverged.
\note If checkStatus is called with the type set to
NOX::StatusTest::None, it then the status is set to to
NOX::Status::Unevaluated and returned. (Also #niters is set to -1.)
*/
class MaxIters : public Generic {
public:
//! Constructor. Specify the maximum number of nonlinear solver iterations, \f$k_{\max}\f$ ands optinally an error stream for printing errors.
MaxIters(int maxIterations, const NOX::Utils* u = NULL);
//! Destructor.
virtual ~MaxIters();
virtual NOX::StatusTest::StatusType
checkStatus(const NOX::Solver::Generic& problem,
NOX::StatusTest::CheckType checkType);
virtual NOX::StatusTest::StatusType getStatus() const;
virtual std::ostream& print(std::ostream& stream, int indent = 0) const;
//! Returns the Maximum number of iterations set in the constructor.
virtual int getMaxIters() const;
/*!
\brief Returns the current number of iterations taken by the solver.
Returns -1 if the status of this test is NOX::StatusTest::Unevaluated.
*/
virtual int getNumIters() const;
private:
//! Maximum number of iterations
int maxiters;
//! Current number of iterations (if known)
int niters;
//! %Status
NOX::StatusTest::StatusType status;
//! Ostream used to print errors
NOX::Utils utils;
};
} // namespace Status
} // namespace NOX
#endif
|