limitedSnGrad.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) 2011-2022 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::fv::limitedSnGrad
 
Description
    Run-time selected snGrad scheme with limited non-orthogonal correction.
 
    The limiter is controlled by a coefficient with a value between 0 and 1
    which when 0 switches the correction off and the scheme behaves as
    uncorrectedSnGrad, when set to 1 the full correction of the selected scheme
    is used and when set to 0.5 the limiter is calculated such that the
    non-orthogonal contribution does not exceed the orthogonal part.
 
    Format:
        limited <corrected scheme> <coefficient>;
 
        or
 
        limited <coefficient>;  // Backward compatibility
 
SourceFiles
    limitedSnGrad.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef limitedSnGrad_H
#define limitedSnGrad_H
 
#include "correctedSnGrad.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace fv
{
 
/*---------------------------------------------------------------------------*\
                        Class limitedSnGrad Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class limitedSnGrad
:
    public snGradScheme<Type>
{
    // Private Data
 
        tmp<snGradScheme<Type>> correctedScheme_;
 
        scalar limitCoeff_;
 
 
    // Private Member Functions
 
        //- Lookup function for the corrected to support backward compatibility
        //  of dictionary specification
        tmp<snGradScheme<Type>> lookupCorrectedScheme(Istream& schemeData)
        {
            token nextToken(schemeData);
 
            if (nextToken.isNumber())
            {
                limitCoeff_ = nextToken.number();
                return tmp<snGradScheme<Type>>
                (
                    new correctedSnGrad<Type>(this->mesh())
                );
            }
            else
            {
                schemeData.putBack(nextToken);
                tmp<snGradScheme<Type>> tcorrectedScheme
                (
                    fv::snGradScheme<Type>::New(this->mesh(), schemeData)
                );
 
                schemeData >> limitCoeff_;
 
                return tcorrectedScheme;
            }
        }
 
 
public:
 
    //- Runtime type information
    TypeName("limited");
 
 
    // Constructors
 
        //- Construct from mesh
        limitedSnGrad(const fvMesh& mesh);
 
        //- Construct from mesh and data stream
        limitedSnGrad(const fvMesh& mesh, Istream& schemeData);
 
 
    //- Destructor
    virtual ~limitedSnGrad();
 
 
    // Member Functions
 
        //- Return the interpolation weighting factors for the given field
        virtual tmp<surfaceScalarField> deltaCoeffs
        (
            const VolField<Type>&
        ) const;
 
        //- Return true if this scheme uses an explicit correction
        virtual bool corrected() const
        {
            return true;
        }
 
        //- Return the explicit correction to the limitedSnGrad
        //  for the given field
        virtual tmp<SurfaceField<Type>>
        correction(const VolField<Type>&) const;
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const limitedSnGrad&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace fv
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "limitedSnGrad.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //