interpolationTable.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2019-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM 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.

    OpenFOAM 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 OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::interpolationTable

Description
    An interpolation/look-up table of scalar vs <Type> values.
    The reference scalar values must be monotonically increasing.

    The handling of out-of-bounds values depends on the current setting
    of \c outOfBounds.

    If \c repeat is chosen for the out-of-bounds handling, the final time
    value is treated as being equivalent to time=0 for the following periods.

    The construct from dictionary reads a filename from a dictionary and
    has an optional readerType. Default is to read OpenFOAM format. The only
    other format is csv (comma separated values):

    Read csv format:
    \verbatim
        readerType          csv;
        file                "<constant>/p0vsTime.csv";
        hasHeaderLine       true;   // skip first line
        refColumn           0;      // reference (eg, time) is in column 0
        componentColumns    (1);    // component values starts in column 1
    \endverbatim

Note
    - Accessing an empty list results in an error.
    - Accessing a list with a single element always returns the same value.

SourceFiles
    interpolationTable.C

\*---------------------------------------------------------------------------*/

#ifndef interpolationTable_H
#define interpolationTable_H

#include "List.H"
#include "Tuple2.H"
#include "tableBounds.H"
#include "tableReader.H"
#include "autoPtr.H"
#include "Field.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                    Class interpolationTable Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class interpolationTable
:
    public List<Tuple2<scalar, Type>>
{
    // Private Data

        //- Handling for out-of-bound values
        bounds::repeatableBounding bounding_;

        //- File name
        fileName fileName_;

        //- Table reader
        autoPtr<tableReader<Type>> reader_;


    // Private Member Functions

        //- Read the table of data from file
        void readTable();


public:

    // Public Data Types

        //- The element data type
        typedef Tuple2<scalar, Type> value_type;

        //- The mapped data type
        typedef Type mapped_type;


    // Constructors

        //- Default construct
        interpolationTable();

        //- Construct from components
        interpolationTable
        (
            const List<Tuple2<scalar, Type>>& values,
            const bounds::repeatableBounding bounding,
            const fileName& fName
        );

        //- Construct given the name of the file containing the table of data
        explicit interpolationTable(const fileName& fName);

        //- Construct by reading file name and outOfBounds from dictionary
        //- and read the table from that file.
        //  This is a specialised constructor used by patchFields
        explicit interpolationTable(const dictionary& dict);

        //- Copy construct
        interpolationTable(const interpolationTable& tbl);


    // Member Functions

        //- Return an interpolated value in List
        static Type interpolateValue
        (
            const List<Tuple2<scalar, Type>>& list,
            scalar lookupValue,
            bounds::repeatableBounding = bounds::repeatableBounding::CLAMP
        );


        //- Check that list is monotonically increasing
        //  Exit with a FatalError if there is a problem
        void check() const;

        //- Write
        void write(Ostream& os) const;

        //- Return the rate of change at the interpolation location
        //- for the given lookup value
        Type rateOfChange(scalar lookupValue) const;

        //- Return an interpolated value
        Type interpolateValue(scalar lookupValue) const;

        //- Return multiple interpolated values
        tmp<Field<Type>> interpolateValues
        (
            const UList<scalar>& vals
        ) const;


    // Member Operators

        //- Copy assignment
        void operator=(const interpolationTable<Type>& rhs);

        //- Return an element of constant Tuple2<scalar, Type>
        const Tuple2<scalar, Type>& operator[](label idx) const;

        //- Return an interpolated value
        Type operator()(scalar lookupValue) const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
    #include "interpolationTable.C"
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //