/usr/include/trilinos/NOX_StatusTest_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 | // $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_STATUSTEST_GENERIC_H
#define NOX_STATUSTEST_GENERIC_H
#include "NOX_Common.H" // for ostream
namespace NOX {
namespace Solver
{
class Generic; // forward declaration (included below)
}
//! %Status checkers.
namespace StatusTest {
//! Status type.
enum StatusType
{
//! Unevaluated
Unevaluated = -2,
//! Neither Converged nor Failed
Unconverged = 0,
//! Converged
Converged = 1,
//! Failed
Failed = -1
};
//! Type of check that should be done by checkStatus
enum CheckType
{
//! Evaluate every test and subtest
Complete,
//! Evaluate all tests and subtests that are necessary to determine the status
Minimal,
//! Evaluation is entirely optional
None
};
/*!
\brief %Generic status test to check for convergence or failure of
the nonlinear solver.
*/
class Generic {
public:
//! Constructor.
Generic() {};
//! Destructor.
virtual ~Generic() {};
//! %Test the stopping criterion
/*!
The test can (and should, if possible) be skipped if
checkType is NOX::StatusType::None. If the test is skipped, then
the status should be set to NOX::StatusTest::Unevaluated.
*/
virtual NOX::StatusTest::StatusType
checkStatus(const NOX::Solver::Generic& problem,
NOX::StatusTest::CheckType checkType) = 0;
//! Return the result of the most recent checkStatus call
virtual NOX::StatusTest::StatusType getStatus() const = 0;
//! Output formatted description of stopping test to output stream.
virtual ostream& print(ostream& stream, int indent = 0) const = 0;
};
ostream& operator<<(ostream& os, NOX::StatusTest::StatusType type);
} // namespace StatusTest
} // namespace NOX
#endif
|