/usr/include/trilinos/Rythmos_SimpleStepControlStrategy_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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | //@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_SIMPLE_STEP_CONTROL_STRATEGY_DECL_H
#define Rythmos_SIMPLE_STEP_CONTROL_STRATEGY_DECL_H
#include "Rythmos_StepControlStrategyBase.hpp"
namespace Rythmos {
// Step Control Strategy object for SimpleStepControlStrategy
//
// Order of calls:
// setRequestedStepSize()
// nextStepSize()
// optional: nextStepOrder()
// setCorrection
// acceptStep
// completeStep or rejectStep
// repeat
//
template<class Scalar>
class SimpleStepControlStrategy
: virtual public StepControlStrategyBase<Scalar>
{
public:
typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
/** \name Overridden from StepControlStrategyBase */
//@{
/** \brief . */
void setRequestedStepSize(const StepperBase<Scalar>& stepper,
const Scalar& stepSize, const StepSizeType& stepSizeType);
/** \brief . */
void nextStepSize(const StepperBase<Scalar>& stepper, Scalar* stepSize,
StepSizeType* stepSizeType, int* order);
/** \brief . */
void setCorrection(
const StepperBase<Scalar>& stepper
,const RCP<const Thyra::VectorBase<Scalar> >& soln
,const RCP<const Thyra::VectorBase<Scalar> >& ee
,int solveStatus
);
/** \brief . */
bool acceptStep(const StepperBase<Scalar>& stepper, Scalar* LETValue);
/** \brief . */
void completeStep(const StepperBase<Scalar>& stepper);
/** \brief . */
AttemptedStepStatusFlag rejectStep(const StepperBase<Scalar>& stepper);
/** \brief . */
StepControlStrategyState getCurrentState();
/** \brief . */
int getMaxOrder() const;
/** \brief . */
void setStepControlData(const StepperBase<Scalar>& stepper);
/** \brief . */
bool supportsCloning() const;
/** \brief . */
RCP<StepControlStrategyBase<Scalar> > cloneStepControlStrategyAlgorithm() const;
//@}
SimpleStepControlStrategy();
/** \name Overridden from Teuchos::Describable */
//@{
/** \brief . */
void describe(
Teuchos::FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel
) const;
//@}
/** \name Overridden from ParameterListAcceptor */
//@{
/** \brief . */
void setParameterList(RCP<Teuchos::ParameterList> const& paramList);
/** \brief . */
RCP<Teuchos::ParameterList> getNonconstParameterList();
/** \brief . */
RCP<Teuchos::ParameterList> unsetParameterList();
/** \brief . */
RCP<const Teuchos::ParameterList> getValidParameters() const;
//@}
void initialize(const StepperBase<Scalar>& stepper);
private:
// Private data members
void defaultInitializeAllData_();
StepControlStrategyState stepControlState_;
RCP<Teuchos::ParameterList> parameterList_;
Scalar initialStepSize_;
Scalar requestedStepSize_;
Scalar currentStepSize_;
Scalar nextStepSize_;
StepSizeType stepSizeType_;
Scalar minStepSize_;
Scalar maxStepSize_;
Scalar stepSizeIncreaseFactor_;
Scalar stepSizeDecreaseFactor_;
int numStepFailures_;
int maxStepFailures_;
int maxOrder_;
Scalar dxRelativeTolerance_;
Scalar dxAbsoluteTolerance_;
int solveStatus_;
RCP<const Thyra::VectorBase<Scalar> > x_;
RCP<const Thyra::VectorBase<Scalar> > dx_;
static const std::string initialStepSizeName_;
static const double initialStepSizeDefault_;
static const std::string minStepSizeName_;
static const double minStepSizeDefault_;
static const std::string maxStepSizeName_;
static const double maxStepSizeDefault_;
static const std::string stepSizeIncreaseFactorName_;
static const double stepSizeIncreaseFactorDefault_;
static const std::string stepSizeDecreaseFactorName_;
static const double stepSizeDecreaseFactorDefault_;
static const std::string maxStepFailuresName_;
static const int maxStepFailuresDefault_;
static const std::string dxRelativeToleranceName_;
static const double dxRelativeToleranceDefault_;
static const std::string dxAbsoluteToleranceName_;
static const double dxAbsoluteToleranceDefault_;
// Private member functions
void setStepControlState_(StepControlStrategyState state);
};
} // namespace Rythmos
#endif // Rythmos_SIMPLE_STEP_CONTROL_STRATEGY_DECL_H
|