Thyra Version of the Day
Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
00043 #define THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
00044 
00045 #include "Thyra_ModelEvaluatorDelegatorBase.hpp"
00046 #include "Thyra_DirectionalFiniteDiffCalculator.hpp"
00047 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00048 #include "Teuchos_StandardCompositionMacros.hpp"
00049 
00050 
00051 namespace Thyra {
00052 
00053 
00061 template<class Scalar>
00062 class DefaultFiniteDifferenceModelEvaluator
00063   : virtual public ModelEvaluatorDelegatorBase<Scalar>
00064 {
00065 public:
00066 
00069 
00071   STANDARD_COMPOSITION_MEMBERS(
00072     DirectionalFiniteDiffCalculator<Scalar>, direcFiniteDiffCalculator );
00073 
00075   DefaultFiniteDifferenceModelEvaluator();
00076 
00078   void initialize(
00079     const RCP<ModelEvaluator<Scalar> > &thyraModel
00080     ,const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
00081     );
00082 
00084 
00087 
00089   std::string description() const;
00090 
00092 
00093 private:
00094 
00097 
00099   ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
00101   void evalModelImpl(
00102     const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
00103     const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
00104     ) const;
00105 
00107  
00108 };
00109 
00110 
00115 template<class Scalar>
00116 RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> >
00117 defaultFiniteDifferenceModelEvaluator()
00118 {
00119   return Teuchos::rcp(new DefaultFiniteDifferenceModelEvaluator<Scalar>());
00120 }
00121 
00122 
00127 template<class Scalar>
00128 RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> >
00129 defaultFiniteDifferenceModelEvaluator(
00130   const RCP<ModelEvaluator<Scalar> > &thyraModel,
00131   const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
00132   )
00133 {
00134   RCP<DefaultFiniteDifferenceModelEvaluator<Scalar> > fdModel =
00135     defaultFiniteDifferenceModelEvaluator<Scalar>();
00136   fdModel->initialize(thyraModel, direcFiniteDiffCalculator);
00137   return fdModel;
00138 }
00139 
00140 
00141 } // namespace Thyra
00142 
00143 
00144 #endif // THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines