/usr/include/trilinos/Rythmos_StepControlStrategyBase.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
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 | //@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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
//
// ***********************************************************************
//@HEADER
#ifndef RYTHMOS_STEP_CONTROL_STRATEGY_BASE_HPP
#define RYTHMOS_STEP_CONTROL_STRATEGY_BASE_HPP
#include "Rythmos_StepperBase.hpp"
namespace Rythmos {
/** \brief step control strategy interface to be used for evaluating steps and picking
* step-sizes & orders.
*
* ToDo: Finish documentation!
*/
/** \brief . */
enum AttemptedStepStatusFlag { PREDICT_AGAIN, CONTINUE_ANYWAY, REP_ERR_FAIL, REP_CONV_FAIL };
/** \brief . */
enum StepControlStrategyState { UNINITIALIZED, BEFORE_FIRST_STEP, MID_STEP, AFTER_CORRECTION, READY_FOR_NEXT_STEP };
/** \brief The member functions in the StepControlStrategyBase move you
* between these states in the following fashion:
*
* setRequestedStepSize: valid in UNINITIALIZED and BEFORE_FIRST_STEP and READY_FOR_NEXT_STEP
* changes state: UNINITIALIZED -> BEFORE_FIRST_STEP
*
* nextStepSize: valid in BEFORE_FIRST_STEP and READY_FOR_NEXT_STEP
* changes state: BEFORE_FIRST_STEP -> MID_STEP
* READY_FOR_NEXT_STEP -> MID_STEP
*
* setCorrection: valid in MID_STEP
* changes state: MID_STEP -> AFTER_CORRECTION
*
* acceptStep: valid in AFTER_CORRECTION
*
* completeStep: valid in AFTER_CORRECTION
* changes state: AFTER_CORRECTION -> READY_FOR_NEXT_STEP
*
* rejectStep: valid in AFTER_CORRECTION
* changes state: AFTER_CORRECTION -> READY_FOR_NEXT_STEP
*
*/
template<class Scalar>
class StepControlStrategyBase
: virtual public Teuchos::Describable
, virtual public Teuchos::ParameterListAcceptor
, virtual public Teuchos::VerboseObject<StepControlStrategyBase<Scalar> >
{
public:
/** \brief . */
virtual void initialize(const StepperBase<Scalar>& stepper) =0;
/** \brief . */
virtual void setRequestedStepSize(
const StepperBase<Scalar>& stepper
, const Scalar& stepSize
, const StepSizeType& stepSizeType
) = 0;
/** \brief . */
virtual void nextStepSize(
const StepperBase<Scalar>& stepper
, Scalar* stepSize
, StepSizeType* stepSizeType
, int* order
) = 0;
/** \brief . */
virtual void setCorrection(
const StepperBase<Scalar>& stepper
, const RCP<const Thyra::VectorBase<Scalar> >& soln
, const RCP<const Thyra::VectorBase<Scalar> >& ee
, int solveStatus
) = 0;
/** \brief . */
virtual bool acceptStep(
const StepperBase<Scalar>& stepper
,Scalar* LETValue
) = 0;
/** \brief . */
virtual void completeStep(
const StepperBase<Scalar>& stepper
) = 0;
/** \brief . */
virtual AttemptedStepStatusFlag rejectStep(
const StepperBase<Scalar>& stepper
) = 0;
/** \brief . */
virtual StepControlStrategyState getCurrentState() = 0;
/** \brief . */
virtual int getMaxOrder() const = 0;
/** \brief . */
virtual void setStepControlData(const StepperBase<Scalar>& stepper) = 0;
/** \brief . */
virtual bool supportsCloning() const;
/** \brief . */
virtual RCP<StepControlStrategyBase<Scalar> > cloneStepControlStrategyAlgorithm() const;
};
template<class Scalar>
bool StepControlStrategyBase<Scalar>::supportsCloning() const
{
return false;
}
template<class Scalar>
RCP<StepControlStrategyBase<Scalar> >
StepControlStrategyBase<Scalar>::cloneStepControlStrategyAlgorithm() const
{
return Teuchos::null;
}
} // namespace Rythmos
#endif // RYTHMOS_STEP_CONTROL_STRATEGY_BASE_HPP
|