gsl_spliner.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// Antioch - A Gas Dynamics Thermochemistry Library
//
// Copyright (C) 2014-2016 Paul T. Bauman, Benjamin S. Kirk,
//                         Sylvain Plessis, Roy H. Stonger
//
// Copyright (C) 2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#include "antioch_config.h" //only of we have GSL
#ifdef ANTIOCH_HAVE_GSL
#ifndef ANTIOCH_GSL_SPLINER_H
#define ANTIOCH_GSL_SPLINER_H

// Antioch
#include "antioch/antioch_asserts.h"
#include "antioch/metaprogramming_decl.h"
#include "antioch/gsl_spliner_shim.h"
#include "antioch/gsl_spliner_policy.h"

namespace Antioch
{

  class GSLSpliner
  {
  public:

    GSLSpliner(){};

    template <typename VectorCoeffType>
    GSLSpliner(const VectorCoeffType & data_x_point, const VectorCoeffType & data_y_point);


    ~GSLSpliner(){};


    template <typename VectorCoeffType>
    void spline_init(const VectorCoeffType & data_x_point, const VectorCoeffType & data_y_point);

    void spline_delete();


    template <typename StateType>
    StateType interpolated_value(const StateType & x) const;


    template <typename StateType>
    StateType dinterp_dx(const StateType & x) const;

  private:


    AntiochPrivate::GSLSplinerShim _gsl_shim;

  };

  template <typename VectorCoeffType>
  inline
  GSLSpliner::GSLSpliner(const VectorCoeffType & data_x_point, const VectorCoeffType & data_y_point)
  {
    this->spline_init(data_x_point, data_y_point);
  }

  inline
  void GSLSpliner::spline_delete()
  {
    _gsl_shim.spline_clear();
  }

  template <typename VectorCoeffType>
  inline
  void GSLSpliner::spline_init(const VectorCoeffType & data_x_point, const VectorCoeffType & data_y_point)
  {
     antioch_assert_equal_to(data_x_point.size(), data_y_point.size());

     // GSL only accepts doubles, so need to cast
     typedef typename rebind<VectorCoeffType,double>::type VectorGSLType;
     VectorGSLType gsl_x_point(data_x_point.size(),0);
     VectorGSLType gsl_y_point(data_y_point.size(),0);
     for(unsigned int i = 0; i < data_x_point.size(); i++)
     {
        gsl_x_point[i] = (const double)data_x_point[i];
        gsl_y_point[i] = (const double)data_y_point[i];
     }

     const double * x = &gsl_x_point[0];
     const double * y = &gsl_y_point[0];

     _gsl_shim.spline_init(x, y, data_x_point.size());
  }

  template <typename StateType>
  inline
  StateType GSLSpliner::interpolated_value(const StateType & x) const
  {
    return AntiochPrivate::GSLSplinerPolicy<has_size<StateType>::value>().interpolation(x, _gsl_shim);
  }

  template <typename StateType>
  inline
  StateType GSLSpliner::dinterp_dx(const StateType & x) const
  {
    return AntiochPrivate::GSLSplinerPolicy<has_size<StateType>::value>().dinterpolation(x, _gsl_shim);
  }

}

#endif // ANTIOCH_GSL_SPLINE

#endif// if ANTIOCH_HAVE_GSL