MappedFile.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) 2018-2024 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::PatchFunction1Types::MappedFile

Description
    Patch value mapping from a set of values stored in a file and
    a set of unstructured points using the following directory structure:

    \verbatim
        constant/boundaryData/<patchName>/points
        constant/boundaryData/<patchName>/<time>/<field>
    \endverbatim

    Options:
    \table
      Property  | Description                       | Type  | Reqd | Deflt
      mapMethod | Mapping method                    | word  | no   | planar
      offset    | Time-varying offset values to interpolated data  <!--
                -->                    | Function1<Type>  | no   | -
      fieldTable | Name of field data table         | word  | no   | field-name
      points   | Name of the points file            | word  | no   | points
      perturb  | Perturbation fraction of bounding box | scalar    | no  | 1e-5
      setAverage | Adjust mapped field to maintain average value   <!--
                -->                                 | scalar | no  | false
    \endtable

    Options for the \c mapMethod entry:
    \table
      Property    | Description
      nearest     | Use nearest points only (avoids triangulation)
      planar      | Interpolation using 2D Delaunay triangulation
    \endtable

    Options for reading and filtering:
    \table
      Property     | Description
      sampleFormat | The surfaceReader format (eg, ensight)
      sampleFile   | <case>/foo/bar/window.case
      filterRadius | Search radius [m] for median filter neighbours
      filterSweeps | Filter sweeps for median filter
      readOptions  | Format options for surfaceReader format (eg, ensight)
    \endtable

Note
    The MappedFile handling currently has two different reading types:
    a builtin boundaryData reader (default) and a surfaceReader
    (specified by sampleFormat and sampleFile keywords). The generic
    surfaceReader handling does \em not support field averaging.

SourceFiles
    MappedFile.C

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

#ifndef Foam_PatchFunction1Types_MappedFile_H
#define Foam_PatchFunction1Types_MappedFile_H

#include "PatchFunction1.H"
#include "Function1.H"
#include "Pair.H"
#include "instantList.H"
#include "surfaceReader.H"
#include "MappedFileFilterField.H"
#include "pointToPointPlanarInterpolation.H"

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

namespace Foam
{
namespace PatchFunction1Types
{

/*---------------------------------------------------------------------------*\
                     Class MappedFile Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class MappedFile
:
    public PatchFunction1<Type>
{
    // Private Data

        //- Whether constructed from dictionary
        const bool dictConstructed_;

        //- If true adjust the mapped field to maintain average value
        bool setAverage_;

        //- Fraction of perturbation (fraction of bounding box) to add
        scalar perturb_;

        //- Name of the field data table, defaults to the name of the field
        word fieldTableName_;

        //- Name of points file (default: "points")
        word pointsName_;

        //- Interpolation scheme to use (default is empty == "planar")
        word mapMethod_;

        //- Radius for filter
        scalar filterRadius_;

        //- Number of median filter sweeps
        label filterSweeps_;

        //- Median filtering (for input values)
        mutable autoPtr<FilterField> filterFieldPtr_;

        //- Format name for surfaceReader
        word readerFormat_;

        //- File name associated with surfaceReader
        fileName readerFile_;

        //- Meshed surface with fields (for input values)
        mutable autoPtr<surfaceReader> readerPtr_;

        //- 2D interpolation (for 'planar' mapMethod)
        mutable autoPtr<pointToPointPlanarInterpolation> mapperPtr_;

        //- List of boundaryData time directories
        mutable instantList sampleTimes_;

        //- The first/second sample indices in sampleTimes
        mutable labelPair sampleIndex_;

        //- The average values at first/second sampleIndex_ (if setAverage)
        mutable Pair<Type> sampleAverage_;

        //- The interpolated values at first/second sampleIndex_
        mutable Pair<Field<Type>> sampleValues_;

        //- Time varying offset values to interpolated data
        autoPtr<Function1<Type>> offset_;


    // Private Member Functions

        //- Find boundary data between time 't' and interpolate
        void checkTable(const scalar t) const;

        //- Update field and average value using interpolation at
        //- given instant index
        void updateSampledValues
        (
            const label sampleIndex,
            Field<Type>& field,
            Type& avg
        ) const;

        //- Construct from entry name and dictionary
        MappedFile
        (
            const bool dictConstructed,
            const polyPatch& pp,
            const word& entryName,
            const dictionary& dict,
            const word& fieldTableName,
            const bool faceValues
        );

public:

    //- Runtime type information
    TypeName("mappedFile");


    // Generated Methods

        //- No copy assignment
        void operator=(const MappedFile<Type>&) = delete;


    // Constructors

        //- Construct from entry name and dictionary
        MappedFile
        (
            const polyPatch& pp,
            const word& redirectType,
            const word& entryName,
            const dictionary& dict,
            const bool faceValues = true
        );

        //- Construct from entry name and dictionary
        MappedFile
        (
            const polyPatch& pp,
            const word& entryName,
            const dictionary& dict,
            const word& fieldTableName,
            const bool faceValues = true
        );

        //- Copy construct setting patch
        explicit MappedFile
        (
            const MappedFile<Type>& rhs,
            const polyPatch& pp
        );

        //- Copy construct
        explicit MappedFile(const MappedFile<Type>& rhs);

        //- Return a clone
        virtual tmp<PatchFunction1<Type>> clone() const
        {
            return PatchFunction1<Type>::Clone(*this, this->patch());
        }

        //- Return a clone, setting the patch
        virtual tmp<PatchFunction1<Type>> clone(const polyPatch& pp) const
        {
            return PatchFunction1<Type>::Clone(*this, pp);
        }


    //- Destructor
    virtual ~MappedFile() = default;


    // Member Functions

        //- Value is independent of x if there is only a single sample time
        virtual bool constant() const
        {
            return sampleTimes_.size() == 1;
        }

        //- Is value uniform (i.e. independent of coordinate)
        virtual inline bool uniform() const
        {
            return PatchFunction1<Type>::uniform();
        }


        // Evaluation

            //- Return MappedFile value
            virtual tmp<Field<Type>> value(const scalar) const;

            //- Integrate between two values
            virtual tmp<Field<Type>> integrate
            (
                const scalar x1,
                const scalar x2
            ) const;


        // Mapping

            //- Map (and resize as needed) from self given a mapping object
            virtual void autoMap(const FieldMapper& mapper);

            //- Reverse map the given PatchFunction1 onto this PatchFunction1
            virtual void rmap
            (
                const PatchFunction1<Type>& pf1,
                const labelList& addr
            );


        // I-O

            //- Write coefficient entries in dictionary format
            virtual void writeEntries(Ostream& os) const;

            //- Write in dictionary format
            virtual void writeData(Ostream& os) const;
};


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

} // End namespace PatchFunction1Types
} // End namespace Foam

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

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

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

#endif

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