fixedlengthspline_.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program is free software: you can redistribute it and/or modify    *
 *   it under the terms of the GNU General Public License as published by    *
 *   the Free Software Foundation, either version 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program 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 General Public License for more details.                            *
 *                                                                           *
 *   You should have received a copy of the GNU General Public License       *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_FIXED_LENGTH_SPLINE_HH
#define DUMUX_FIXED_LENGTH_SPLINE_HH
 
#include <dune/common/fvector.hh>
#include <dune/common/fmatrix.hh>
#include <dune/istl/btdmatrix.hh>
 
#include "splinecommon_.hh"
 
namespace Dumux {
 
template<class ScalarT, int nSamples>
class FixedLengthSpline_
    : public SplineCommon_<ScalarT,
                           FixedLengthSpline_<ScalarT, nSamples> >
{
    friend class SplineCommon_<ScalarT, FixedLengthSpline_<ScalarT, nSamples> >;
 
    using Scalar = ScalarT;
    using Vector = Dune::FieldVector<Scalar, nSamples>;
    using BlockVector = Dune::BlockVector<Dune::FieldVector<Scalar, 1> >;
    using BTDMatrix = Dune::BTDMatrix<Dune::FieldMatrix<Scalar, 1, 1> >;
 
protected:
    FixedLengthSpline_()
        : m_(nSamples)
    {};
 
public:
    int numSamples() const
    { return nSamples; }
 
    // Full splines                      //
 
    template <class ScalarArrayX, class ScalarArrayY>
    void setXYArrays(int numberSamples,
                     const ScalarArrayX &x,
                     const ScalarArrayY &y,
                     Scalar m0, Scalar m1)
    {
        assert(numberSamples == numSamples());
 
        for (int i = 0; i < numberSamples; ++i) {
            xPos_[i] = x[i];
            yPos_[i] = y[i];
        }
        makeFullSpline_(m0, m1);
    }
 
    template <class ScalarContainerX, class ScalarContainerY>
    void setXYContainers(const ScalarContainerX &x,
                         const ScalarContainerY &y,
                         Scalar m0, Scalar m1)
    {
        assert(x.size() == y.size());
        assert(x.size() == numSamples());
 
        std::copy(x.begin(), x.end(), xPos_.begin());
        std::copy(y.begin(), y.end(), yPos_.begin());
        makeFullSpline_(m0, m1);
    }
 
    template <class PointArray>
    void setArrayOfPoints(int numberSamples,
                          const PointArray &points,
                          Scalar m0,
                          Scalar m1)
    {
        // a spline with no or just one sampling points? what an
        // incredible bad idea!
        assert(numberSamples == numSamples());
 
        for (int i = 0; i < numberSamples; ++i) {
            xPos_[i] = points[i][0];
            yPos_[i] = points[i][1];
        }
        makeFullSpline_(m0, m1);
    }
 
    template <class XYContainer>
    void setContainerOfPoints(const XYContainer &points,
                              Scalar m0,
                              Scalar m1)
    {
        assert(points.size() == numSamples());
 
        typename XYContainer::const_iterator it = points.begin();
        typename XYContainer::const_iterator endIt = points.end();
        for (int i = 0; it != endIt; ++i, ++it) {
            xPos_[i] = (*it)[0];
            yPos_[i] = (*it)[1];
        }
 
        // make a full spline
        makeFullSpline_(m0, m1);
    }
 
    template <class XYContainer>
    void setContainerOfTuples(const XYContainer &points,
                              Scalar m0,
                              Scalar m1)
    {
        assert(points.size() == numSamples());
 
        typename XYContainer::const_iterator it = points.begin();
        typename XYContainer::const_iterator endIt = points.end();
        for (int i = 0; it != endIt; ++i, ++it) {
            xPos_[i] = std::get<0>(*it);
            yPos_[i] = std::get<1>(*it);
        }
 
        // make a full spline
        makeFullSpline_(m0, m1);
    }
 
    // Natural splines                   //
 
    template <class ScalarArrayX, class ScalarArrayY>
    void setXYArrays(int numberSamples,
                     const ScalarArrayX &x,
                     const ScalarArrayY &y)
    {
        assert(numberSamples == numSamples());
 
        for (int i = 0; i < numberSamples; ++i) {
            xPos_[i] = x[i];
            yPos_[i] = y[i];
        }
 
        makeNaturalSpline_();
    }
 
    template <class ScalarContainerX, class ScalarContainerY>
    void setXYContainers(const ScalarContainerX &x,
                         const ScalarContainerY &y)
    {
        assert(x.size() == y.size());
        assert(x.size() > 1);
 
        setNumSamples_(x.size());
        std::copy(x.begin(), x.end(), xPos_.begin());
        std::copy(y.begin(), y.end(), yPos_.begin());
        makeNaturalSpline_();
    }
 
 
    template <class PointArray>
    void setArrayOfPoints(int numberSamples,
                          const PointArray &points)
    {
        assert(numberSamples == numSamples());
 
        for (int i = 0; i < numberSamples; ++i) {
            xPos_[i] = points[i][0];
            yPos_[i] = points[i][1];
        }
        makeNaturalSpline_();
    }
 
    template <class XYContainer>
    void setContainerOfPoints(const XYContainer &points)
    {
        assert(points.size() == numSamples());
 
        typename XYContainer::const_iterator it = points.begin();
        typename XYContainer::const_iterator endIt = points.end();
        for (int i = 0; it != endIt; ++ i, ++it) {
            xPos_[i] = (*it)[0];
            yPos_[i] = (*it)[1];
        }
 
        // make a natural spline
        makeNaturalSpline_();
    }
 
    template <class XYContainer>
    void setContainerOfTuples(const XYContainer &points)
    {
        assert(points.size() == numSamples());
 
        typename XYContainer::const_iterator it = points.begin();
        typename XYContainer::const_iterator endIt = points.end();
        for (int i = 0; it != endIt; ++i, ++it) {
            xPos_[i] = std::get<0>(*it);
            yPos_[i] = std::get<1>(*it);
        }
 
        // make a natural spline
        makeNaturalSpline_();
    }
 
protected:
    void makeFullSpline_(Scalar m0, Scalar m1)
    {
        BTDMatrix M(numSamples());
        BlockVector d(numSamples());
 
        // create linear system of equations
        this->makeFullSystem_(M, d, m0, m1);
 
        // solve for the moments
        M.solve(m_, d);
    }
 
    void makeNaturalSpline_()
    {
        BTDMatrix M(numSamples());
        BlockVector d(numSamples());
 
        // create linear system of equations
        this->makeNaturalSystem_(M, d);
 
        // solve for the moments
        M.solve(m_, d);
    }
 
    Scalar x_(int i) const
    { return xPos_[i]; }
 
    Scalar y_(int i) const
    { return yPos_[i]; }
 
    Scalar moment_(int i) const
    { return m_[i]; }
 
    Vector xPos_;
    Vector yPos_;
    BlockVector m_;
};
 
} // end namespace Dumux
 
#endif