cyclicFvPatch.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-2026 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::cyclicFvPatch
 
Description
    Cyclic-plane patch.
 
SourceFiles
    cyclicFvPatch.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef cyclicFvPatch_H
#define cyclicFvPatch_H
 
#include "coupledFvPatch.H"
#include "cyclicLduInterface.H"
#include "cyclicPolyPatch.H"
#include "fvBoundaryMesh.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class cyclicFvPatch Declaration
\*---------------------------------------------------------------------------*/
 
class cyclicFvPatch
:
    public coupledFvPatch,
    public cyclicLduInterface
{
    // Private Data
 
        //- Reference to the corresponding cyclicPolyPatch
        const cyclicPolyPatch& cyclicPoly_;
 
 
protected:
 
    // Protected Member functions
 
        //- Make patch weighting factors
        void makeWeights(scalarField&) const;
 
 
public:
 
    //- Runtime type information
    TypeName(cyclicPolyPatch::typeName_());
 
 
    // Constructors
 
        //- Construct from polyPatch
        cyclicFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm)
        :
            coupledFvPatch(patch, bm),
            cyclicPoly_(refCast<const cyclicPolyPatch>(patch))
        {}
 
 
    // Member Functions
 
        // Access
 
            //- Return neighbour
            virtual label nbrPatchIndex() const
            {
                return cyclicPoly_.nbrPatchIndex();
            }
 
            virtual bool owner() const
            {
                return cyclicPoly_.owner();
            }
 
            //- Return processor number
            virtual const cyclicFvPatch& nbrPatch() const
            {
                return refCast<const cyclicFvPatch>
                (
                    this->boundaryMesh()[cyclicPoly_.nbrPatchIndex()]
                );
            }
 
            //- Return transformation between the coupled patches
            virtual const transformer& transform() const
            {
                return cyclicPoly_.transform();
            }
 
            const cyclicFvPatch& neighbFvPatch() const
            {
                return refCast<const cyclicFvPatch>
                (
                    this->boundaryMesh()[cyclicPoly_.nbrPatchIndex()]
                );
            }
 
 
            //- Return delta (P to N) vectors across coupled patch
            virtual tmp<vectorField> delta() const;
 
 
        // Interface transfer functions
 
            //- Return the values of the given internal data adjacent to
            //  the interface as a field
            virtual tmp<labelField> interfaceInternalField
            (
                const labelUList& internalData
            ) const;
 
            //- Return neighbour field
            virtual tmp<labelField> internalFieldTransfer
            (
                const Pstream::commsTypes commsType,
                const labelUList& internalData
            ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //