stepInterpolationWeights.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2023 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::stepInterpolationWeights
 
Description
    Generates the weight for step-wise interpolation and integration
 
    The step transitions are at the end of each interval.
 
SourceFiles
    stepInterpolationWeights.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef stepInterpolationWeights_H
#define stepInterpolationWeights_H
 
#include "interpolationWeights.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                 Class stepInterpolationWeights Declaration
\*---------------------------------------------------------------------------*/
 
class stepInterpolationWeights
:
    public interpolationWeights
{
    // Private Data
 
        //- Cached index in samples from previous invocation
        mutable label index_;
 
 
public:
 
    //- Runtime type information
    TypeName("step");
 
 
    // Constructors
 
        //- Construct from components
        stepInterpolationWeights
        (
            const scalarField& samples
        );
 
 
    //- Destructor
    virtual ~stepInterpolationWeights()
    {}
 
 
    // Member Functions
 
        //- Calculate weights and indices to calculate t from samples.
        //  Returns true if indices changed.
        virtual bool valueWeights
        (
            const scalar t,
            labelList& indices,
            scalarField& weights
        ) const;
 
        //- Calculate weights and indices to calculate integrand of t1..t2
        //  from samples. Returns true if indices changed.
        virtual bool integrationWeights
        (
            scalar t1,
            scalar t2,
            labelList& indices,
            scalarField& weights
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //