Files
OpenFOAM-12/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
Will Bainbridge 1a6b662b41 surfaceInterpolate: Made consistent with other function objects
The surfaceInterpolate function object is now a field expression. This
means it works in the same way as mag, grad, etc... It also now has a
packaged configuration and has been included into the postProcessing
test case.

It can be used in the following ways. On the command line:

   postProcess -func "surfaceInterpolate(rho, result=rhof)"

   rhoPimpleFoam -postProcess -func "surfaceInterpolate(thermo:rho, result=rhof)"

In the controlDict:

   functions
   {
       #includeFunc surfaceInterpolate(rho, result=rhof)
   }

By running:

   foamGet surfaceInterpolate

Then editing the resulting system/surfaceInterpolate file and then
running postProcess or adding an #includeFunc entry without arguments.
2021-10-08 09:10:27 +01:00

111 lines
3.1 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 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::functionObjects::surfaceInterpolate
Description
Calculates the surface interpolation of a field.
The operation can be applied to any volume field and will generate a
surface field.
See also
Foam::functionObjects::fvMeshFunctionObject
SourceFiles
surfaceInterpolate.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_surfaceInterpolate_H
#define functionObjects_surfaceInterpolate_H
#include "fieldExpression.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class surfaceInterpolate Declaration
\*---------------------------------------------------------------------------*/
class surfaceInterpolate
:
public fieldExpression
{
// Private Member Functions
//- Calculate the surface interpolation of the field and register the
// result
template<class Type>
bool calcSurfaceInterpolate();
//- Calculate the surface interpolation of the field and return true if
// successful
virtual bool calc();
public:
//- Runtime type information
TypeName("surfaceInterpolate");
// Constructors
//- Construct from Time and dictionary
surfaceInterpolate
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~surfaceInterpolate();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "surfaceInterpolateTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //