/usr/include/trilinos/LOCA_StatusTest_MaxIters.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 | // $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 LOCA_STATUS_MAXITERS_H
#define LOCA_STATUS_MAXITERS_H
#include "LOCA_StatusTest_Abstract.H"
#include "Teuchos_RCP.hpp"
#include "LOCA_GlobalData.H"
namespace LOCA {
namespace StatusTest {
// TODO Update documentation.
//! Failure test based on the maximum number of continuation steps.
/*!
Let \f$k\f$ denote the current number of iterations (accessed via \c
LOCA::Stepper::getNumTotalSteps) and \f$k_{\max}\f$ denote the
tolerance set in the constructor of this status test.
This test returns LOCA::StatusTest::Failed if
\f$
k \geq k_{\rm max}.
\f$
Otherwise, it returns LOCA::StatusTest::NotFinished.
\note If checkStatus is called with the type set to
LOCA::StatusTest::None, it then the status is set to to
LOCA::Status::Unevaluated and returned. (Also #niters is set to -1.)
*/
class MaxIters : public Abstract {
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,
bool return_failed_on_max_steps = true,
const Teuchos::RCP<const LOCA::GlobalData> globalData = Teuchos::null);
//! Destructor.
virtual ~MaxIters();
virtual LOCA::StatusTest::StatusType
checkStatus(const LOCA::Stepper& stepper,
LOCA::StatusTest::CheckType status);
virtual LOCA::StatusTest::StatusType getStatus() const;
virtual ostream& print(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;
//! Determines if LOCA::StatusTest::Failed or LOCA::StatusTest::Finished
//! if returned when the \c maxiters has been reached.
bool return_failed_on_max_steps_;
//! Current number of iterations (if known)
int niters;
//! %Status
LOCA::StatusTest::StatusType status;
//! Ostream used to print errors
Teuchos::RCP<const LOCA::GlobalData> globalDataPtr_;
};
} // namespace Status
} // namespace LOCA
#endif
|