/usr/include/trilinos/Rythmos_StepControlInfo.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 | #ifndef RYTHMOS_STEP_CONTROL_INFO_HPP
#define RYTHMOS_STEP_CONTROL_INFO_HPP
// disable clang warnings
#ifdef __clang__
#pragma clang system_header
#endif
#include "Rythmos_StepperSupportTypes.hpp"
namespace Rythmos {
/** \brief Simple struct to aggregate integration/stepper control information.
*/
template<class Scalar>
struct StepControlInfo {
/** \brief The size of the time step. */
Scalar stepSize;
/** \brief The type of time step. */
StepSizeType stepType;
/** \brief True if step size is limited by a breakpoint. */
bool limitedByBreakPoint;
/** \brief True if the time integrator should restart when passing
* over the breakpoint. */
EBreakPointType breakPointType;
/** \brief Initialize to invalid state. */
StepControlInfo()
:stepSize(-1.0), stepType(STEP_TYPE_FIXED),
limitedByBreakPoint(false),
breakPointType(BREAK_POINT_TYPE_SOFT)
{}
};
/** \brief . */
template<class Scalar>
std::ostream& operator<<(
std::ostream &out, const StepControlInfo<Scalar> &stepCtrlInfo
)
{
using std::endl;
out
<< "stepType = " << toString(stepCtrlInfo.stepType) << endl
<< "stepSize = " << stepCtrlInfo.stepSize << endl
<< "limitedByBreakPoint = " << stepCtrlInfo.limitedByBreakPoint << endl
<< "breakPointType = " << toString(stepCtrlInfo.breakPointType) << endl;
return out;
}
/** \brief Return a step control info object for a step actually taken.
*
* All integrator subclass implementations should use this function to update
* the step control info for a step actually taken.
*
* \relates StepControlInfo
*/
template<class Scalar>
StepControlInfo<Scalar>
stepCtrlInfoTaken(
const StepControlInfo<Scalar> &trialStepCtrlInfo,
const Scalar &stepSizeTaken
)
{
typedef Teuchos::ScalarTraits<Scalar> ST;
const Scalar zero = ST::zero();
StepControlInfo<Scalar> stepCtrlInfo = trialStepCtrlInfo;
stepCtrlInfo.stepSize = stepSizeTaken;
if ( trialStepCtrlInfo.stepSize > zero && stepSizeTaken > zero ) {
if (stepSizeTaken < trialStepCtrlInfo.stepSize) {
stepCtrlInfo.limitedByBreakPoint = false;
}
}
else {
stepCtrlInfo.limitedByBreakPoint = false;
}
return stepCtrlInfo;
}
// 2007/09/14: rabartl: ToDo: Above: Move this function into
// Rythmos_IntegratorBaseHelpers.hpp once created!
} // namespace Rythmos
#endif // RYTHMOS_STEP_CONTROL_INFO_HPP
|