This file is indexed.

/usr/include/trilinos/NOX_Solver_PseudoTransient.hpp 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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
// $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_SOLVER_PSEUDO_TRANSIENT_HPP
#define NOX_SOLVER_PSEUDO_TRANSIENT_HPP

#include "NOX_Solver_Generic.H"             // base class
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp" // base class
#include "NOX_Solver_PrePostOperator.H"  // class data element
#include "Teuchos_ParameterList.hpp"             // class data element
#include "NOX_Utils.H"                 // class data element
#include "Teuchos_RCP.hpp"       // class data element

// Forward declarations
namespace NOX {
  class GlobalData;
  namespace LineSearch {
    class Generic;
  }
  namespace Direction {
    class Generic;
  }
  namespace Thyra {
    class Group;
  }
}

namespace Thyra {
  template <typename ScalarT> class VectorBase;
}

namespace NOX {
namespace Solver {

/*!
  \brief Pseudo-transient solver.

  Requires that the Thyra::ModelEvaluator implement transient support
  (uses alpha, beta, Jacobian evaluation and optionally x_dot in
  residual).

  Based on the 1998 Kelley Keyes paper, with minor modifications.
*/
  class PseudoTransient :
    public NOX::Solver::Generic,
    public Teuchos::ParameterListAcceptorDefaultBase
{

public:

  PseudoTransient(const Teuchos::RCP<NOX::Abstract::Group>& xGrp,
          const Teuchos::RCP<NOX::StatusTest::Generic>& tests,
          const Teuchos::RCP<Teuchos::ParameterList>& params);

  void setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& paramList);
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;

  void reset(const NOX::Abstract::Vector& initialGuess,
         const Teuchos::RCP<NOX::StatusTest::Generic>& tests);
  void reset(const NOX::Abstract::Vector& initialGuess);
  NOX::StatusTest::StatusType getStatus();
  NOX::StatusTest::StatusType step();
  NOX::StatusTest::StatusType solve();
  const NOX::Abstract::Group& getSolutionGroup() const;
  const NOX::Abstract::Group& getPreviousSolutionGroup() const;
  int getNumIterations() const;
  const Teuchos::ParameterList& getList() const;
  double getStepSize() const;

  Teuchos::RCP< const NOX::Abstract::Group > getSolutionGroupPtr() const;
  Teuchos::RCP< const NOX::Abstract::Group > getPreviousSolutionGroupPtr() const;
  Teuchos::RCP< const Teuchos::ParameterList > getListPtr() const;

protected:

  virtual void init();

  virtual void printUpdate();

protected:

  //! Pointer to the global data object.
  Teuchos::RCP<NOX::GlobalData> globalDataPtr;

  //! Utils
  Teuchos::RCP<NOX::Utils> utilsPtr;

  //! Current solution.
  Teuchos::RCP<NOX::Abstract::Group> solnPtr;

  //! Previous solution pointer.
  Teuchos::RCP<NOX::Abstract::Group> oldSolnPtr;

  //! Group used to evaluate a transient residual
  Teuchos::RCP<NOX::Abstract::Group> transientResidualGroup;

  //! Current search direction pointer.
  Teuchos::RCP<NOX::Abstract::Vector> dirPtr;

  //! Stopping test.
  Teuchos::RCP<NOX::StatusTest::Generic> testPtr;

  //! Input parameters.
  //Teuchos::RCP<Teuchos::ParameterList> paramsPtr;

  //! Linesearch.
  Teuchos::RCP<NOX::LineSearch::Generic> lineSearchPtr;

  //! %Search %Direction.
  Teuchos::RCP<NOX::Direction::Generic> directionPtr;

  //! Current step.
  double stepSize;

  //! Number of nonlinear iterations.
  int nIter;

  //! %Status of nonlinear solver.
  NOX::StatusTest::StatusType status;

  //! Type of check to use for status tests.  See NOX::StatusTest for more details.
  NOX::StatusTest::CheckType checkType;

  //! Pointer to a user defined NOX::Abstract::PrePostOperator object.
  NOX::Solver::PrePostOperator prePostOperator;




  //! Pointer to solnPtr casted back to a thyra group
  Teuchos::RCP<NOX::Thyra::Group> thyraSolnGroup;
  //! Pointer to oldSolnPtr casted back to a thyra group
  Teuchos::RCP<NOX::Thyra::Group> thyraOldSolnGroup;
  //! Group used to evaluate a transient residual
  Teuchos::RCP<NOX::Thyra::Group> thyraTransientResidualGroup;

  //! Step size for pseudo-transient stepping
  double delta;
  //! Inverse step size for pseudo-transient stepping
  double inv_delta;
  //! Initial step size
  double deltaInit;
  //! Maximum step size
  double deltaMax;
  //! Minimum step size
  double deltaMin;
  //! Step size from previous iteration
  double deltaOld;
  //! Pseudo-transient time
  double time;
  //! solution time derivative used for scaling operator V in pseudo-transient paper
  Teuchos::RCP< ::Thyra::VectorBase<double> > x_dot;

  //! If set to true, the candidate direction will use the transient residual instead of the steady-state residual.  This is a modification of the Kelley-Keyes paper.
  bool use_transient_residual;

  //! Maximum number of iterations before pseudo-transient is disabled and the algorithm switches to a line search-based direct to steady state solve.
  int max_pseudo_transient_iterations;

  //! Parameters that are valid for this solver
  mutable Teuchos::RCP<Teuchos::ParameterList> validParameters;
};
} // namespace Solver
} // namespace NOX

#endif