/usr/include/trilinos/Rythmos_TimeStepNonlinearSolver_decl.hpp is in libtrilinos-rythmos-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 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 | //@HEADER
// ***********************************************************************
//
// Rythmos Package
// Copyright (2006) 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
//
// ***********************************************************************
//@HEADER
#ifndef RYTHMOS_TIME_STEP_NONLINEAR_SOLVER_DECL_HPP
#define RYTHMOS_TIME_STEP_NONLINEAR_SOLVER_DECL_HPP
#include "Rythmos_Types.hpp"
#include "Thyra_NonlinearSolverBase.hpp"
namespace Rythmos {
/** \brief Simple undampended Newton solver designed to solve time step
* equations in accurate times-tepping methods.
*
* ToDo: Finish documentation.
*
* 2007/05/18: rabartl: ToDo: Derive NonlinearSolverBase from
* ParameterListAcceptor and accept options through a validated
* parameter list! Then remove these STANDARD_MEMBER_COMPOSITION_MEMBERS()
* macros.
*/
template <class Scalar>
class TimeStepNonlinearSolver : public Thyra::NonlinearSolverBase<Scalar> {
public:
/** \brief. */
typedef Teuchos::ScalarTraits<Scalar> ST;
/** \brief. */
typedef typename ST::magnitudeType ScalarMag;
/** \brief. */
typedef Teuchos::ScalarTraits<ScalarMag> SMT;
/** @name Constructors/Intializers/Misc */
//@{
/** \brief Sets parameter defaults . */
TimeStepNonlinearSolver();
//@}
/** @name Overridden from ParameterListAcceptor */
//@{
/** \brief . */
void setParameterList(RCP<ParameterList> const& paramList);
/** \brief . */
RCP<ParameterList> getNonconstParameterList();
/** \brief . */
RCP<ParameterList> unsetParameterList();
/** \brief . */
RCP<const ParameterList> getParameterList() const;
/** \brief . */
RCP<const ParameterList> getValidParameters() const;
//@}
/** @name Overridden from NonlinearSolverBase */
//@{
/** \brief . */
void setModel(
const RCP<const Thyra::ModelEvaluator<Scalar> > &model
);
/** \brief . */
RCP<const Thyra::ModelEvaluator<Scalar> > getModel() const;
/** \brief . */
Thyra::SolveStatus<Scalar> solve(
Thyra::VectorBase<Scalar> *x,
const Thyra::SolveCriteria<Scalar> *solveCriteria,
Thyra::VectorBase<Scalar> *delta = NULL
);
/** \brief . */
bool supportsCloning() const;
/** \brief . */
RCP<Thyra::NonlinearSolverBase<Scalar> >
cloneNonlinearSolver() const;
/** \brief . */
RCP<const Thyra::VectorBase<Scalar> > get_current_x() const;
/** \brief . */
bool is_W_current() const;
/** \brief . */
RCP<Thyra::LinearOpWithSolveBase<Scalar> >
get_nonconst_W(const bool forceUpToDate);
/** \brief . */
RCP<const Thyra::LinearOpWithSolveBase<Scalar> > get_W() const;
/** \brief . */
void set_W_is_current(bool W_is_current);
//@}
private:
// private object data members
RCP<ParameterList> paramList_;
RCP<const Thyra::ModelEvaluator<Scalar> > model_;
RCP<Thyra::LinearOpWithSolveBase<Scalar> > J_;
RCP<Thyra::VectorBase<Scalar> > current_x_;
bool J_is_current_;
double defaultTol_;
int defaultMaxIters_;
double nonlinearSafetyFactor_;
double linearSafetyFactor_;
double RMinFraction_;
bool throwOnLinearSolveFailure_;
// static class data members
static const std::string DefaultTol_name_;
static const double DefaultTol_default_;
static const std::string DefaultMaxIters_name_;
static const int DefaultMaxIters_default_;
static const std::string NonlinearSafetyFactor_name_;
static const double NonlinearSafetyFactor_default_;
static const std::string LinearSafetyFactor_name_;
static const double LinearSafetyFactor_default_;
static const std::string RMinFraction_name_;
static const double RMinFraction_default_;
static const std::string ThrownOnLinearSolveFailure_name_;
static const bool ThrownOnLinearSolveFailure_default_;
};
/** \brief Nonmember constructor.
*
* \relates TimeStepNonlinearSolver
*/
template <class Scalar>
RCP<TimeStepNonlinearSolver<Scalar> > timeStepNonlinearSolver();
/** \brief Nonmember constructor.
*
* \relates TimeStepNonlinearSolver
*/
template <class Scalar>
RCP<TimeStepNonlinearSolver<Scalar> >
timeStepNonlinearSolver(const RCP<ParameterList> &pl);
} // namespace Rythmos
#endif // RYTHMOS_TIME_STEP_NONLINEAR_SOLVER_DECL_HPP
|