Tempus_Interpolator.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER

#ifndef Tempus_Interpolator_hpp
#define Tempus_Interpolator_hpp

// Teuchos
#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"

// Tempus
#include "Tempus_config.hpp"
#include "Tempus_SolutionState.hpp"

#include <vector>

namespace Tempus {

template <class Scalar>
class Interpolator
  : virtual public Teuchos::Describable,
    virtual public Teuchos::ParameterListAcceptor,
    virtual public Teuchos::VerboseObject<Interpolator<Scalar> > {
 public:
  virtual void setNodes(
      const Teuchos::RCP<
          const std::vector<Teuchos::RCP<SolutionState<Scalar> > > >&
          nodes) = 0;

  virtual void interpolate(const Scalar& t,
                           SolutionState<Scalar>* state_out) const = 0;

  virtual int order() const = 0;
};

template <class Scalar>
void interpolate(const Interpolator<Scalar>& interpolator, const Scalar& t,
                 SolutionState<Scalar>* state_out)
{
  interpolator.interpolate(t, state_out);
}

template <class Scalar>
void interpolate(
    Interpolator<Scalar>& interpolator,
    const Teuchos::RCP<
        const std::vector<Teuchos::RCP<SolutionState<Scalar> > > >& nodes,
    const Scalar& t, SolutionState<Scalar>* state_out)
{
  interpolator.setNodes(nodes);
  interpolator.interpolate(t, state_out);
}

template <typename Scalar>
bool floating_compare_equals(const Scalar& a, const Scalar& b,
                             const Scalar& scale)
{
  typedef Teuchos::ScalarTraits<Scalar> ST;
  typedef typename ST::magnitudeType mag_type;

  const mag_type tol  = ST::magnitude(scale) * ST::eps() * mag_type(1000.0);
  const mag_type diff = ST::magnitude(a - b);

  return diff <= tol || diff <= ST::sfmin();
}

}  // namespace Tempus

#endif  // Tempus_Interpolator_hpp