Rythmos - Transient Integration for Differential Equations Version of the Day
Rythmos_ForwardSensitivityModelEvaluatorBase.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_FORWARD_SENSITIVITY_MODEL_EVALUATOR_BASE_HPP
00030 #define RYTHMOS_FORWARD_SENSITIVITY_MODEL_EVALUATOR_BASE_HPP
00031 
00032 
00033 #include "Rythmos_IntegratorBase.hpp"
00034 #include "Thyra_ModelEvaluator.hpp" // Interface
00035 #include "Thyra_StateFuncModelEvaluatorBase.hpp" // Implementation
00036 #include "Thyra_DefaultProductVectorSpace.hpp"
00037 #include "Thyra_PhysicallyBlockedLinearOpWithSolveBase.hpp" // Interface
00038 #include "Thyra_DefaultBlockedTriangularLinearOpWithSolve.hpp" // Implementation
00039 #include "Thyra_ModelEvaluatorDelegatorBase.hpp"
00040 #include "Thyra_ModelEvaluatorHelpers.hpp"
00041 #include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
00042 #include "Thyra_DefaultMultiVectorProductVector.hpp"
00043 #include "Thyra_DefaultMultiVectorLinearOpWithSolve.hpp"
00044 #include "Teuchos_implicit_cast.hpp"
00045 #include "Teuchos_Assert.hpp"
00046 
00047 
00048 namespace Rythmos {
00049 
00050 
00060 template<class Scalar>
00061 class ForwardSensitivityModelEvaluatorBase
00062   : virtual public Thyra::StateFuncModelEvaluatorBase<Scalar>
00063 {
00064 public:
00065 
00080   virtual void initializeStructure(
00081     const RCP<const Thyra::ModelEvaluator<Scalar> > &stateModel,
00082     const int p_index
00083     ) = 0;
00084 
00100   virtual void initializeStructureInitCondOnly(
00101     const RCP<const Thyra::ModelEvaluator<Scalar> >& stateModel,
00102     const RCP<const Thyra::VectorSpaceBase<Scalar> >& p_space
00103     ) = 0;
00104   
00106   virtual RCP<const Thyra::ModelEvaluator<Scalar> >
00107   getStateModel() const =0;
00108 
00110   virtual RCP<Thyra::ModelEvaluator<Scalar> >
00111   getNonconstStateModel() const =0;
00112   
00114   virtual int get_p_index() const = 0;
00115   
00117   virtual RCP<const Thyra::DefaultMultiVectorProductVectorSpace<Scalar> >
00118   get_s_bar_space() const = 0;
00119   
00121   virtual RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_sens_space() const = 0;
00122 
00124   virtual void initializePointState(
00125       Ptr<StepperBase<Scalar> > stateStepper,
00126       bool forceUpToDateW
00127       ) =0;
00128 
00129 };
00130 
00131 
00135 template<class Scalar>
00136 RCP<const Thyra::VectorBase<Scalar> > create_s_bar_given_S(
00137   const ForwardSensitivityModelEvaluatorBase<Scalar> &fwdSensModel,
00138   const RCP<Thyra::MultiVectorBase<Scalar> > &S
00139   )
00140 {
00141   return Thyra::multiVectorProductVector(fwdSensModel.get_s_bar_space(), S); 
00142 }
00143 
00144 
00148 template<class Scalar>
00149 RCP<const Thyra::VectorBase<Scalar> > create_s_bar_given_S(
00150   const ForwardSensitivityModelEvaluatorBase<Scalar> &fwdSensModel,
00151   const RCP<const Thyra::MultiVectorBase<Scalar> > &S
00152   )
00153 {
00154   return Thyra::multiVectorProductVector(fwdSensModel.get_s_bar_space(), S); 
00155 }
00156 
00157 
00158 } // namespace Rythmos
00159 
00160 
00161 #endif // RYTHMOS_FORWARD_SENSITIVITY_MODEL_EVALUATOR_BASE_HPP
 All Classes Functions Variables Typedefs Friends