probes.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) 2016-2025 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::probes
 
Group
    grpUtilitiesFunctionObjects
 
Description
    Function object to sample fields at specified internal-mesh locations and
    write to file.
 
Usage
    Minimal example by using \c system/controlDict.functions:
    \verbatim
    probes
    {
        // Mandatory entries
        type            probes;
        libs            (sampling);
 
        fields          (<wordRes>);
        probeLocations  (<vectorList>);
 
        // Optional entries
        verbose         <bool>;
        sampleOnExecute <bool>;
        fixedLocations  <bool>;
        includeOutOfBounds <bool>;
        interpolationScheme <word>;
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      Property     | Description                           | Type | Reqd | Deflt
      type         | Type name: probes                     | word |  yes  | -
      libs         | Library name: sampling                | word |  yes  | -
      fields       | Names of fields to probe              | wordRes | yes | -
      probeLocations | Locations of probes              | vectorList | yes | -
      verbose      | Enable/disable verbose output         | bool | no | false
      sampleOnExecute | Sample on execution and store results | bool | no <!--
                   -->                                               | false
      fixedLocations | Do not recalculate cells if mesh moves | bool | no | true
      includeOutOfBounds | Include out-of-bounds locations | bool | no | true
      interpolationScheme | Scheme to obtain values at the points | word <!--
                   -->                                            | no | cell
    \endtable
 
    The inherited entries are elaborated in:
     - \link fvMeshFunctionObject.H \endlink
     - \link Probes.H \endlink
     - \link internalFieldProbe.H \endlink
     - \link probeModel.H \endlink
 
Note
  - The \c includeOutOfBounds filters out points that haven't been found.
    Default is to include them (with value \c -VGREAT).
 
SourceFiles
    probes.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_probes_H
#define Foam_probes_H
 
#include "Probes.H"
#include "internalFieldProbe.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                          Class probes Declaration
\*---------------------------------------------------------------------------*/
 
class probes
:
    public Probes<internalFieldProbe>
{
    // Private Data
 
        //- Use simpler synonym for the base type
        using Base = Probes<internalFieldProbe>;
 
 
public:
 
    //- Runtime type information
    TypeName("probes");
 
 
    // Constructors
 
        //- Construct from Time and dictionary
        probes
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict,
            const bool loadFromFiles = false,
            const bool readFields = true
        );
 
 
    //- Destructor
    virtual ~probes() = default;
 
 
    // Member Functions
 
        //- Bring Base::probeModel into this class's public scope.
        using Base::probeModel;
 
        //- Read the settings from the dictionary
        virtual bool read(const dictionary&);
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //