Rythmos_ForwardSensitivityStepperTester_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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 //@HEADER
00028 
00029 #ifndef Rythmos_FORWARD_SENSITIVITY_STEPPER_TESTER_DECL_H
00030 #define Rythmos_FORWARD_SENSITIVITY_STEPPER_TESTER_DECL_H
00031 
00032 
00033 #include "Rythmos_StepperSupportTypes.hpp"
00034 #include "Rythmos_IntegratorBase.hpp"
00035 #include "Thyra_ModelEvaluator.hpp"
00036 #include "Teuchos_VerboseObject.hpp"
00037 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00038 
00039 
00040 namespace Rythmos {
00041 
00042 
00043 template<class Scalar> class ForwardSensitivityStepperTester;
00044 
00045 
00046 namespace ForwardSensitivityStepperTesterUtils {
00047 
00048 const std::string FdCalc_name = "FD Calc";
00049 
00050 const std::string ErrorTol_name = "Error Tol";
00051 const double ErrorTol_default = 1e-6;
00052 
00053 } // namespace ForwardSensitivityStepperTesterUtils
00054 
00055 
00060 template<class Scalar>
00061 RCP<ForwardSensitivityStepperTester<Scalar> >
00062 forwardSensitivityStepperTester();
00063 
00064 
00069 template<class Scalar>
00070 RCP<ForwardSensitivityStepperTester<Scalar> >
00071 forwardSensitivityStepperTester(const RCP<ParameterList> &paramList);
00072 
00073 
00078 template<class Scalar> 
00079 class ForwardSensitivityStepperTester
00080   : virtual public Teuchos::VerboseObject<ForwardSensitivityStepperTester<Scalar> >,
00081     virtual public Teuchos::ParameterListAcceptorDefaultBase
00082 {
00083 public:
00084 
00085   typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
00086 
00089 
00091   void setParameterList(RCP<ParameterList> const& paramList);
00093   RCP<const ParameterList> getValidParameters() const;
00094 
00096 
00099 
00102   bool testForwardSens(
00103     const Ptr<IntegratorBase<Scalar> > &fwdSensIntegrator
00104     );
00105 
00107 
00108 #ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED
00109 
00112 
00114   friend RCP< ForwardSensitivityStepperTester<Scalar> >
00115   forwardSensitivityStepperTester<>();
00116 
00118 
00119 #endif // TEMPLATE_FRIENDS_NOT_SUPPORTED
00120   
00121 
00122 #ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED
00123 private:
00124 #endif // TEMPLATE_FRIENDS_NOT_SUPPORTED
00125 
00126   ForwardSensitivityStepperTester(); // Note defined and not to be called
00127 
00128 private:
00129 
00130   ScalarMag errorTol_;
00131 
00132 };
00133 
00134 
00135 } // namespace Rythmos
00136 
00137 
00138 #endif //Rythmos_FORWARD_SENSITIVITY_STEPPER_TESTER_DECL_H

Generated on Wed May 12 21:25:43 2010 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.4.7