Rythmos_LinearInterpolator_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_LINEAR_INTERPOLATOR_DECL_H
00030 #define Rythmos_LINEAR_INTERPOLATOR_DECL_H
00031 
00032 #include "Rythmos_InterpolatorBase.hpp"
00033 #include "Rythmos_Types.hpp"
00034 
00035 namespace Rythmos {
00036 
00037 
00041 template<class Scalar>
00042 class LinearInterpolator : virtual public InterpolatorBase<Scalar>
00043 {
00044 public:
00045 
00047   ~LinearInterpolator() {};
00048 
00050   LinearInterpolator();
00051 
00053   bool supportsCloning() const;
00054 
00056   RCP<InterpolatorBase<Scalar> > cloneInterpolator() const;
00057 
00059   void setNodes(
00060     const RCP<const typename DataStore<Scalar>::DataStoreVector_t> & nodes
00061     );
00062 
00064   void interpolate(
00065     const Array<Scalar> &t_values,
00066     typename DataStore<Scalar>::DataStoreVector_t *data_out
00067     ) const;
00068 
00070   int order() const; 
00071 
00073   std::string description() const;
00074 
00076   void describe(
00077     FancyOStream &out,
00078     const Teuchos::EVerbosityLevel verbLevel
00079     ) const;
00080 
00082   void setParameterList(RCP<ParameterList> const& paramList);
00083 
00085   RCP<ParameterList> getNonconstParameterList();
00086 
00088   RCP<ParameterList> unsetParameterList();
00089 
00091   RCP<const Teuchos::ParameterList> getValidParameters() const;
00092 
00093 private:
00094 
00095   RCP<const typename DataStore<Scalar>::DataStoreVector_t> nodes_;
00096 
00097   RCP<ParameterList> parameterList_;
00098 
00099 };
00100 
00101 // non-member constructor
00102 template<class Scalar>
00103 RCP<LinearInterpolator<Scalar> > linearInterpolator();
00104 
00105 
00106 } // namespace Rythmos
00107 
00108 
00109 #endif // Rythmos_LINEAR_INTERPOLATOR_DECL_H

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