Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Rythmos_HermiteInterpolator_decl.hpp
1//@HEADER
2// ***********************************************************************
3//
4// Rythmos Package
5// Copyright (2006) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// This library is free software; you can redistribute it and/or modify
11// it under the terms of the GNU Lesser General Public License as
12// published by the Free Software Foundation; either version 2.1 of the
13// License, or (at your option) any later version.
14//
15// This library is distributed in the hope that it will be useful, but
16// WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18// Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public
21// License along with this library; if not, write to the Free Software
22// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23// USA
24// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
25//
26// ***********************************************************************
27//@HEADER
28
29#ifndef Rythmos_HERMITE_INTERPOLATOR_DECL_H
30#define Rythmos_HERMITE_INTERPOLATOR_DECL_H
31
32#include "Rythmos_InterpolatorBase.hpp"
33#include "Rythmos_Types.hpp"
34
35namespace Rythmos {
53template<class Scalar>
54class HermiteInterpolator : virtual public InterpolatorBase<Scalar>
55{
56 public:
57
60
63
64 void setNodes(
65 const RCP<const typename DataStore<Scalar>::DataStoreVector_t> & nodes
66 );
67
69
76 void interpolate(
77 const Array<Scalar> &t_values,
78 typename DataStore<Scalar>::DataStoreVector_t *data_out
79 ) const;
80
82 int order() const;
83
85
86 std::string description() const;
87
89 void describe(
90 Teuchos::FancyOStream &out,
91 const Teuchos::EVerbosityLevel verbLevel
92 ) const;
93
95
96 void setParameterList(RCP<ParameterList> const& paramList);
97
99 RCP<ParameterList> getNonconstParameterList();
100
102 RCP<ParameterList> unsetParameterList();
103
105 RCP<const Teuchos::ParameterList> getValidParameters() const;
106
107 void assertInterpolatePreconditions(
108 const typename DataStore<Scalar>::DataStoreVector_t &data_in
109 ,const Array<Scalar> &t_values
110 ,typename DataStore<Scalar>::DataStoreVector_t *data_out
111 ) const;
112
113 private:
114
115 RCP<const typename DataStore<Scalar>::DataStoreVector_t> nodes_;
116
117 RCP<ParameterList> parameterList_;
118
119};
120
121// non-member constructor
122template<class Scalar>
123RCP<HermiteInterpolator<Scalar> > hermiteInterpolator();
124
125} // namespace Rythmos
126
127#endif // Rythmos_HERMITE_INTERPOLATOR_DECL_H
int order() const
Order of interpolation:
RCP< const Teuchos::ParameterList > getValidParameters() const
void setParameterList(RCP< ParameterList > const &paramList)
Redefined from ParameterListAcceptor.
void setNodes(const RCP< const typename DataStore< Scalar >::DataStoreVector_t > &nodes)
Store pointer to interpolation nodes.
std::string description() const
Inherited from Teuchos::Describable.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
void interpolate(const Array< Scalar > &t_values, typename DataStore< Scalar >::DataStoreVector_t *data_out) const
Interpolation:
Base strategy class for interpolation functionality.