cubic.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-2025 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::cubic
 
Description
    Cubic interpolation scheme class derived from linear and returns
    linear weighting factors but also applies an explicit correction.
 
SourceFiles
    cubic.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef cubic_H
#define cubic_H
 
#include "linear.H"
#include "gradScheme.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                            Class cubic Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class cubic
:
    public linear<Type>
{
    // Private Data
 
        word gradSchemeName_;
 
 
public:
 
    //- Runtime type information
    TypeName("cubic");
 
 
    // Constructors
 
        //- Construct from mesh
        cubic(const fvMesh& mesh)
        :
            linear<Type>(mesh),
            gradSchemeName_("grad")
        {}
 
        //- Construct from mesh and Istream
        cubic
        (
            const fvMesh& mesh,
            Istream& schemeData
        )
        :
            linear<Type>(mesh),
            gradSchemeName_(schemeData)
        {}
 
        //- Construct from mesh, faceFlux and Istream
        cubic
        (
            const fvMesh& mesh,
            const surfaceScalarField&,
            Istream& schemeData
        )
        :
            linear<Type>(mesh),
            gradSchemeName_(schemeData)
        {}
 
        //- Disallow default bitwise copy construction
        cubic(const cubic&) = delete;
 
 
    // Member Functions
 
        //- Return true if this scheme uses an explicit correction
        virtual bool corrected() const
        {
            return true;
        }
 
        //- Return the explicit correction to the face-interpolate
        virtual tmp<SurfaceField<Type>>
        correction
        (
            const VolField<Type>& vf
        ) const
        {
            const fvMesh& mesh = this->mesh();
 
            // calculate the appropriate interpolation factors
            const surfaceScalarField& lambda = mesh.weights();
 
            const surfaceScalarField kSc
            (
                lambda*(scalar(1) - lambda*(scalar(3) - scalar(2)*lambda))
            );
 
            const surfaceScalarField kVecN(-sqr(scalar(1) - lambda)*lambda);
            const surfaceScalarField kVecP(sqr(lambda)*(scalar(1) - lambda));
 
            tmp<SurfaceField<Type>> tsfCorr
            (
                SurfaceField<Type>::New
                (
                    "cubic::correction(" + vf.name() +')',
                    surfaceInterpolationScheme<Type>::interpolate(vf, -kSc, kSc)
                )
            );
            SurfaceField<Type>& sfCorr =
                tsfCorr.ref();
 
            for (direction cmpt=0; cmpt<pTraits<Type>::nComponents; cmpt++)
            {
                sfCorr.replace
                (
                    cmpt,
                    sfCorr.component(cmpt)
                  + (
                        surfaceInterpolationScheme
                        <
                            typename outerProduct
                            <
                                vector,
                                typename pTraits<Type>::cmptType
                            >::type
                        >::interpolate
                        (
                            fv::gradScheme<typename pTraits<Type>::cmptType>::
                            New
                            (
                                mesh,
                                mesh.schemes().grad(gradSchemeName_)
                            )().grad(vf.component(cmpt)),
                            kVecP,
                            kVecN
                        ) & mesh.delta()
                    )
                );
            }
 
            typename SurfaceField<Type>::
                Boundary& sfCorrbf = sfCorr.boundaryFieldRef();
 
            forAll(sfCorrbf, pi)
            {
                if (!sfCorrbf[pi].coupled())
                {
                    sfCorrbf[pi] = Zero;
                }
            }
 
            return tsfCorr;
        }
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const cubic&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //