Files
openfoam/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.H
Henry Weller 56bfc75949 Rationalize the "pos" function
"pos" now returns 1 if the argument is greater than 0, otherwise it returns 0.
This is consistent with the common mathematical definition of the "pos" function:

https://en.wikipedia.org/wiki/Sign_(mathematics)

However the previous implementation in which 1 was also returned for a 0
argument is useful in many situations so the "pos0" has been added which returns
1 if the argument is greater or equal to 0.  Additionally the "neg0" has been
added which returns 1 if if the argument is less than or equal to 0.
2017-06-22 14:32:18 +01:00

160 lines
4.3 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 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::upwind
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Upwind differencing scheme class.
SourceFiles
upwind.C
\*---------------------------------------------------------------------------*/
#ifndef upwind_H
#define upwind_H
#include "limitedSurfaceInterpolationScheme.H"
#include "volFields.H"
#include "surfaceFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class upwind Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class upwind
:
public limitedSurfaceInterpolationScheme<Type>
{
// Private Member Functions
//- Disallow default bitwise assignment
void operator=(const upwind&);
public:
//- Runtime type information
TypeName("upwind");
// Constructors
//- Construct from faceFlux
upwind
(
const fvMesh& mesh,
const surfaceScalarField& faceFlux
)
:
limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
{}
//- Construct from Istream.
// The name of the flux field is read from the Istream and looked-up
// from the mesh objectRegistry
upwind
(
const fvMesh& mesh,
Istream& is
)
:
limitedSurfaceInterpolationScheme<Type>(mesh, is)
{}
//- Construct from faceFlux and Istream
upwind
(
const fvMesh& mesh,
const surfaceScalarField& faceFlux,
Istream&
)
:
limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
{}
// Member Functions
//- Return the interpolation limiter
virtual tmp<surfaceScalarField> limiter
(
const GeometricField<Type, fvPatchField, volMesh>&
) const
{
return tmp<surfaceScalarField>
(
new surfaceScalarField
(
IOobject
(
"upwindLimiter",
this->mesh().time().timeName(),
this->mesh(),
IOobject::NO_READ,
IOobject::NO_WRITE,
false
),
this->mesh(),
dimensionedScalar("upwindLimiter", dimless, 0.0)
)
);
}
//- Return the interpolation weighting factors
tmp<surfaceScalarField> weights() const
{
return pos0(this->faceFlux_);
}
//- Return the interpolation weighting factors
virtual tmp<surfaceScalarField> weights
(
const GeometricField<Type, fvPatchField, volMesh>&
) const
{
return weights();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //