Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
00030 #define THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
00031 
00032 #include "Thyra_ModelEvaluatorDelegatorBase.hpp"
00033 #include "Thyra_DirectionalFiniteDiffCalculator.hpp"
00034 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00035 #include "Teuchos_StandardCompositionMacros.hpp"
00036 
00037 
00038 namespace Thyra {
00039 
00040 
00048 template<class Scalar>
00049 class DefaultFiniteDifferenceModelEvaluator
00050   : virtual public ModelEvaluatorDelegatorBase<Scalar>
00051 {
00052 public:
00053 
00056 
00058   STANDARD_COMPOSITION_MEMBERS(
00059     DirectionalFiniteDiffCalculator<Scalar>, direcFiniteDiffCalculator );
00060 
00062   DefaultFiniteDifferenceModelEvaluator();
00063 
00065   void initialize(
00066     const RCP<ModelEvaluator<Scalar> > &thyraModel
00067     ,const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
00068     );
00069 
00071 
00074 
00076   std::string description() const;
00077 
00079 
00080 private:
00081 
00084 
00086   ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
00088   void evalModelImpl(
00089     const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
00090     const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
00091     ) const;
00092 
00094  
00095 };
00096 
00097 
00102 template<class Scalar>
00103 RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> >
00104 defaultFiniteDifferenceModelEvaluator()
00105 {
00106   return Teuchos::rcp(new DefaultFiniteDifferenceModelEvaluator<Scalar>());
00107 }
00108 
00109 
00114 template<class Scalar>
00115 RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> >
00116 defaultFiniteDifferenceModelEvaluator(
00117   const RCP<ModelEvaluator<Scalar> > &thyraModel,
00118   const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
00119   )
00120 {
00121   RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> > fdModel =
00122     defaultFiniteDifferenceModelEvaluator<Scalar>();
00123   fdModel->initialize(thyraModel, direcFiniteDiffCalculator);
00124   return fdModel;
00125 }
00126 
00127 
00128 } // namespace Thyra
00129 
00130 
00131 #endif // THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines