/usr/include/trilinos/Rythmos_RampingIntegrationControlStrategy_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 | //@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_RAMPING_INTEGRATION_CONTROL_STRATEGY_DECL_HPP
#define RYTHMOS_RAMPING_INTEGRATION_CONTROL_STRATEGY_DECL_HPP
#include "Rythmos_IntegrationControlStrategyBase.hpp"
#include "Rythmos_StepperBase.hpp"
#include "Rythmos_StepControlInfo.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
namespace Rythmos {
/** \brief Controls inital ramping at a fixed or incrementing time step size
*
* This integration control strategy starts a run by taking a fixed step size for a number of time steps (can optionally ramp the size). It then turns over control to a variable time stepper.
*/
template<class Scalar>
class RampingIntegrationControlStrategy
: virtual public IntegrationControlStrategyBase<Scalar>,
virtual public Teuchos::ParameterListAcceptorDefaultBase
{
public:
/** \brief Constructors/Initializers. */
//@{
/** \brief . */
RampingIntegrationControlStrategy();
//@}
/** \name Overridden from ParameterListAcceptor */
//@{
/** \brief . */
void setParameterList(RCP<ParameterList> const& paramList);
/** \brief . */
RCP<const ParameterList> getValidParameters() const;
//@}
/** \brief Overridden from IntegrationControlStrategyBase */
//@{
/** \brief . */
bool handlesFailedTimeSteps() const;
/** \brief . */
RCP<IntegrationControlStrategyBase<Scalar> >
cloneIntegrationControlStrategy() const;
/** \brief . */
void resetIntegrationControlStrategy(
const TimeRange<Scalar> &integrationTimeDomain
);
/** \brief . */
StepControlInfo<Scalar>
getNextStepControlInfo(
const StepperBase<Scalar> &stepper,
const StepControlInfo<Scalar> &stepCtrlInfoLast,
const int timeStepIter
);
/** \brief . */
bool resetForFailedTimeStep(
const StepperBase<Scalar> &stepper,
const StepControlInfo<Scalar> &stepCtrlInfoLast,
const int timeStepIter,
const StepControlInfo<Scalar> &stepCtrlInfo
);
//@}
private:
bool take_variable_steps_;
int num_constant_steps_;
int num_ramping_steps_;
Scalar initial_dt_;
Scalar min_dt_;
Scalar max_dt_;
Scalar ramping_factor_;
int num_step_failures_;
int max_step_failures_;
Scalar current_dt_;
TimeRange<Scalar> integrationTimeDomain_;
static const std::string take_variable_steps_name_;
static const bool take_variable_steps_default_;
static const std::string num_constant_steps_name_;
static const int num_constant_steps_default_;
static const std::string num_ramping_steps_name_;
static const int num_ramping_steps_default_;
static const std::string initial_dt_name_;
static const double initial_dt_default_;
static const std::string min_dt_name_;
static const double min_dt_default_;
static const std::string max_dt_name_;
static const double max_dt_default_;
static const std::string ramping_factor_name_;
static const double ramping_factor_default_;
static const std::string max_step_failures_name_;
static const int max_step_failures_default_;
};
/** \brief .
*
* \relates RampingIntegrationControlStrategy
*/
template<class Scalar>
RCP<RampingIntegrationControlStrategy<Scalar> >
rampingIntegrationControlStrategy();
/** \brief .
*
* \relates RampingIntegrationControlStrategy
*/
template<class Scalar>
RCP<RampingIntegrationControlStrategy<Scalar> >
rampingIntegrationControlStrategy( const RCP<ParameterList> ¶mList );
} // namespace Rythmos
#endif // RYTHMOS_RAMPING_INTEGRATION_CONTROL_STRATEGY_DECL_HPP
|