smoothDelta.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-2020,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::smoothDelta
 
Description
    Smoothed delta which takes a given simple geometric delta and applies
    smoothing to it such that the ratio of deltas between two cells is no
    larger than a specified amount, typically 1.15.
 
SourceFiles
    smoothDelta.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef smoothDelta_H
#define smoothDelta_H
 
#include "LESdelta.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace LESModels
{
 
/*---------------------------------------------------------------------------*\
                         Class smoothDelta Declaration
\*---------------------------------------------------------------------------*/
 
class smoothDelta
:
    public LESdelta
{
public:
 
    //- Public class used by mesh-wave to propagate the delta-ratio
    class deltaData
    {
        // Private Data
 
            scalar delta_;
 
 
        // Private Member Functions
 
            //- Update gets information from neighbouring face/cell and
            //- uses this to update itself (if necessary) and return true.
            template<class TrackingData>
            inline bool update
            (
                const deltaData& w2,
                const scalar scale,
                const scalar tol,
                TrackingData& td
            );
 
 
    public:
 
        // Constructors
 
            //- Default construct
            inline deltaData();
 
            //- Construct from delta value
            inline deltaData(const scalar delta);
 
 
        // Member Functions
 
            // Access
 
                scalar delta() const
                {
                    return delta_;
                }
 
 
            // Needed by FaceCellWave
 
                //- Changed or contains original (invalid) value
                template<class TrackingData>
                inline bool valid(TrackingData& td) const;
 
                //- Check for identical geometrical data (eg, cyclics checking)
                template<class TrackingData>
                inline bool sameGeometry
                (
                    const polyMesh&,
                    const deltaData&,
                    const scalar,
                    TrackingData& td
                ) const;
 
                //- Convert any absolute coordinates into relative to
                //- (patch)face centre
                template<class TrackingData>
                inline void leaveDomain
                (
                    const polyMesh&,
                    const polyPatch&,
                    const label patchFacei,
                    const point& faceCentre,
                    TrackingData& td
                );
 
                //- Reverse of leaveDomain
                template<class TrackingData>
                inline void enterDomain
                (
                    const polyMesh&,
                    const polyPatch&,
                    const label patchFacei,
                    const point& faceCentre,
                    TrackingData& td
                );
 
                //- Apply rotation matrix to any coordinates
                template<class TrackingData>
                inline void transform
                (
                    const polyMesh&,
                    const tensor&,
                    TrackingData& td
                );
 
                //- Influence of neighbouring face.
                template<class TrackingData>
                inline bool updateCell
                (
                    const polyMesh&,
                    const label thisCelli,
                    const label neighbourFacei,
                    const deltaData& neighbourInfo,
                    const scalar tol,
                    TrackingData& td
                );
 
                //- Influence of neighbouring cell.
                template<class TrackingData>
                inline bool updateFace
                (
                    const polyMesh&,
                    const label thisFacei,
                    const label neighbourCelli,
                    const deltaData& neighbourInfo,
                    const scalar tol,
                    TrackingData& td
                );
 
                //- Influence of different value on same face.
                template<class TrackingData>
                inline bool updateFace
                (
                    const polyMesh&,
                    const label thisFacei,
                    const deltaData& neighbourInfo,
                    const scalar tol,
                    TrackingData& td
                );
 
                //- Test for equality, with TrackingData
                template<class TrackingData>
                inline bool equal(const deltaData&, TrackingData& td) const;
 
                //- Interpolate between two values (lerp). Returns true if
                //- causes changes. Not sure if needs to be specialised between
                //- face and cell and what index is needed...
                template<class TrackingData>
                inline bool interpolate
                (
                    const polyMesh&,
                    const point& pt,
                    const label i0,
                    const deltaData& f0,
                    const label i1,
                    const deltaData& f1,
                    const scalar weight,
                    const scalar tol,
                    TrackingData& td
                );
 
 
        // Member Operators
 
            //- Test for equality
            inline bool operator==(const deltaData&) const;
 
            //- Test for inequality
            inline bool operator!=(const deltaData&) const;
 
 
        // IOstream Operators
 
            friend Ostream& operator<<(Ostream& os, const deltaData& rhs)
            {
                return os << rhs.delta_;
            }
 
            friend Istream& operator>>(Istream& is, deltaData& rhs)
            {
                return is >> rhs.delta_;
            }
    };
 
 
private:
 
    // Private Data
 
        autoPtr<LESdelta> geometricDelta_;
 
        scalar maxDeltaRatio_;
 
 
    // Private Member Functions
 
        //- No copy construct
        smoothDelta(const smoothDelta&) = delete;
 
        //- No copy assignment
        void operator=(const smoothDelta&) = delete;
 
        // Calculate the delta values
        void calcDelta();
 
        //- Fill changedFaces (with face labels) and changedFacesInfo
        //  (with delta).
        //  This is the initial set of faces from which to start the waves.
        //  Since there might be lots of places with delta jumps we can follow
        //  various strategies for this initial 'seed'.
        //  - start from single cell/face and let FaceCellWave pick up all
        //    others from there. might be quite a few waves before everything
        //    settles.
        //  - start from all faces. Lots of initial transfers.
        //  We do something in between:
        //  - start from all faces where there is a jump. Since we cannot easily
        //    determine this across coupled patches (cyclic, processor)
        //    introduce all faces of these and let FaceCellWave sort it out.
        void setChangedFaces
        (
            const polyMesh& mesh,
            const volScalarField& delta,
            DynamicList<label>& changedFaces,
            DynamicList<deltaData>& changedFacesInfo
        );
 
public:
 
    //- Declare type-name, virtual type (with debug switch)
    TypeName("smooth");
 
 
    // Constructors
 
        //- Construct from name, turbulenceModel and dictionary
        smoothDelta
        (
            const word& name,
            const turbulenceModel& turbulence,
            const dictionary&
        );
 
 
    //- Destructor
    virtual ~smoothDelta() = default;
 
 
    // Member Functions
 
        //- Read the LESdelta dictionary
        virtual void read(const dictionary& dict);
 
        // Correct values
        virtual void correct();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace LESModels
 
 
// * * * * * * * * * * * * * * * * * Traits  * * * * * * * * * * * * * * * * //
 
//- Contiguous data for deltaData
template<>
struct is_contiguous<LESModels::smoothDelta::deltaData> : std::true_type {};
 
//- Interpolation - used in e.g. cyclicAMI interpolation
inline LESModels::smoothDelta::deltaData lerp
(
    const LESModels::smoothDelta::deltaData& a,
    const LESModels::smoothDelta::deltaData& b,
    const scalar t
)
{
    return LESModels::smoothDelta::deltaData(lerp(a.delta(), b.delta(), t));
}
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "smoothDeltaDeltaDataI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //