Rythmos - Transient Integration for Differential Equations Version of the Day
Rythmos_BasicDiscreteAdjointStepperTester_decl.hpp
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //                           Rythmos Package
00005 //                 Copyright (2006) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
00023 // USA
00024 // Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 //@HEADER
00028 
00029 #ifndef Rythmos_BASIC_DISCRETE_ADJOINT_STEPPER_TESTER_DECL_H
00030 #define Rythmos_BASIC_DISCRETE_ADJOINT_STEPPER_TESTER_DECL_H
00031 
00032 
00033 #include "Rythmos_AdjointModelEvaluator.hpp"
00034 #include "Rythmos_IntegratorBase.hpp"
00035 #include "Teuchos_VerboseObject.hpp"
00036 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00037 
00038 
00039 namespace Rythmos {
00040 
00041 
00042 template<class Scalar> class BasicDiscreteAdjointStepperTester;
00043 
00044 
00045 namespace BasicDiscreteAdjointStepperTesterUtils {
00046 
00047 const std::string ErrorTol_name = "Error Tol";
00048 const double ErrorTol_default = 1e-6;
00049 
00050 } // namespace BasicDiscreteAdjointStepperTesterUtils
00051 
00052 
00057 template<class Scalar>
00058 RCP<BasicDiscreteAdjointStepperTester<Scalar> >
00059 basicDiscreteAdjointStepperTester();
00060 
00061 
00066 template<class Scalar>
00067 RCP<BasicDiscreteAdjointStepperTester<Scalar> >
00068 basicDiscreteAdjointStepperTester(const RCP<ParameterList> &paramList);
00069 
00070 
00139 template<class Scalar> 
00140 class BasicDiscreteAdjointStepperTester
00141   : virtual public Teuchos::VerboseObject<BasicDiscreteAdjointStepperTester<Scalar> >,
00142     virtual public Teuchos::ParameterListAcceptorDefaultBase
00143 {
00144 public:
00145 
00146   typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
00147 
00150 
00152   void setParameterList(RCP<ParameterList> const& paramList);
00154   RCP<const ParameterList> getValidParameters() const;
00155 
00157 
00160 
00178   bool testAdjointStepper(
00179     Thyra::ModelEvaluator<Scalar>& adjointModel,
00180     const Ptr<IntegratorBase<Scalar> >& forwardIntegrator
00181     );
00182 
00184 
00185 #ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED
00186 
00189 
00191   friend RCP< BasicDiscreteAdjointStepperTester<Scalar> >
00192   basicDiscreteAdjointStepperTester<>();
00193 
00195 
00196 #endif // TEMPLATE_FRIENDS_NOT_SUPPORTED
00197   
00198 
00199 #ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED
00200 private:
00201 #endif // TEMPLATE_FRIENDS_NOT_SUPPORTED
00202 
00203   BasicDiscreteAdjointStepperTester(); // Note defined and not to be called
00204 
00205 private:
00206 
00207   ScalarMag errorTol_;
00208 
00209 };
00210 
00211 
00212 } // namespace Rythmos
00213 
00214 
00215 #endif //Rythmos_BASIC_DISCRETE_ADJOINT_STEPPER_TESTER_DECL_H
 All Classes Functions Variables Typedefs Friends