Rythmos_HermiteInterpolator_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_HERMITE_INTERPOLATOR_DECL_H
00030 #define Rythmos_HERMITE_INTERPOLATOR_DECL_H
00031 
00032 #include "Rythmos_InterpolatorBase.hpp"
00033 #include "Rythmos_Types.hpp"
00034 
00035 namespace Rythmos {
00053 template<class Scalar>
00054 class HermiteInterpolator : virtual public InterpolatorBase<Scalar>
00055 {
00056   public:
00057 
00059     ~HermiteInterpolator() {};
00060 
00062     HermiteInterpolator();
00063 
00064     void setNodes(
00065       const RCP<const typename DataStore<Scalar>::DataStoreVector_t> & nodes
00066       );
00067 
00069 
00076     void interpolate(
00077       const Array<Scalar> &t_values,
00078       typename DataStore<Scalar>::DataStoreVector_t *data_out
00079       ) const;
00080 
00082     int order() const; 
00083 
00085 
00086     std::string description() const;
00087 
00089     void describe(
00090       Teuchos::FancyOStream &out,
00091       const Teuchos::EVerbosityLevel verbLevel
00092       ) const;
00093 
00095 
00096     void setParameterList(RCP<ParameterList> const& paramList);
00097 
00099     RCP<ParameterList> getNonconstParameterList();
00100 
00102     RCP<ParameterList> unsetParameterList();
00103 
00105     RCP<const Teuchos::ParameterList> getValidParameters() const;
00106 
00107     void assertInterpolatePreconditions(
00108         const typename DataStore<Scalar>::DataStoreVector_t &data_in
00109         ,const Array<Scalar> &t_values
00110         ,typename DataStore<Scalar>::DataStoreVector_t *data_out
00111         ) const;
00112 
00113   private:
00114 
00115     RCP<const typename DataStore<Scalar>::DataStoreVector_t> nodes_;
00116 
00117     RCP<ParameterList> parameterList_;
00118 
00119 };
00120 
00121 // non-member constructor
00122 template<class Scalar>
00123 RCP<HermiteInterpolator<Scalar> > hermiteInterpolator();
00124 
00125 } // namespace Rythmos
00126 
00127 #endif // Rythmos_HERMITE_INTERPOLATOR_DECL_H

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