processorPolyPatch.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-2023 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::processorPolyPatch
 
Description
    Neighbour processor patch.
 
    Note: morph patch face ordering tries to do a geometric ordering.
    (assumes faces coincident) Hence will have problems when cyclics
    are present.
 
SourceFiles
    processorPolyPatch.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef processorPolyPatch_H
#define processorPolyPatch_H
 
#include "coupledPolyPatch.H"
#include "polyBoundaryMesh.H"
#include "faceListFwd.H"
#include "polyMesh.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class processorPolyPatch Declaration
\*---------------------------------------------------------------------------*/
 
class processorPolyPatch
:
    public coupledPolyPatch
{
    // Private Data
 
        int myProcNo_;
        int neighbProcNo_;
 
        //- Processor-neighbour patch face centres
        vectorField neighbFaceCentres_;
 
        //- Processor-neighbour patch face areas
        vectorField neighbFaceAreas_;
 
        //- Processor-neighbour patch neighbour cell centres
        vectorField neighbFaceCellCentres_;
 
        //- Corresponding neighbouring local point label for every local point
        //  (so localPoints()[i] == neighb.localPoints()[nbrPoints_[i]])
        mutable autoPtr<labelList> nbrPointsPtr_;
 
        //- Corresponding neighbouring local edge label for every local edge
        //  (so edges()[i] == neighb.edges()[nbrEdges_[i]])
        mutable autoPtr<labelList> nbrEdgesPtr_;
 
protected:
 
    // Protected constructors
 
        //- Construct from components with specified name
        processorPolyPatch
        (
            const word& name,
            const label size,
            const label start,
            const label index,
            const polyBoundaryMesh& bm,
            const int myProcNo,
            const int neighbProcNo,
            const word& patchType = typeName
        );
 
 
    // Protected Member functions
 
        //- Initialise the calculation of the patch geometry
        void initCalcGeometry(PstreamBuffers&);
 
        //- Calculate the patch geometry
        void calcGeometry(PstreamBuffers&);
 
        //- Initialise the patches for moving points
        void initMovePoints(PstreamBuffers&, const pointField&);
 
        //- Correct patches after moving points
        void movePoints(PstreamBuffers&, const pointField&);
 
        //- Initialise the update of the patch topology
        virtual void initTopoChange(PstreamBuffers&);
 
        //- Update of the patch topology
        virtual void topoChange(PstreamBuffers&);
 
 
public:
 
    //- Runtime type information
    TypeName("processor");
 
 
    // Constructors
 
        //- Construct from components with automatically generated standard name
        processorPolyPatch
        (
            const label size,
            const label start,
            const label index,
            const polyBoundaryMesh& bm,
            const int myProcNo,
            const int neighbProcNo,
            const word& patchType = typeName
        );
 
        //- Construct from dictionary
        processorPolyPatch
        (
            const word& name,
            const dictionary& dict,
            const label index,
            const polyBoundaryMesh&,
            const word& patchType
        );
 
        //- Construct as copy, resetting the boundary mesh
        processorPolyPatch(const processorPolyPatch&, const polyBoundaryMesh&);
 
        //- Construct as given the original patch and resetting the
        //  face list and boundary mesh information
        processorPolyPatch
        (
            const processorPolyPatch& pp,
            const polyBoundaryMesh& bm,
            const label index,
            const label newSize,
            const label newStart
        );
 
        //- Construct and return a clone, resetting the boundary mesh
        virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
        {
            return autoPtr<polyPatch>(new processorPolyPatch(*this, bm));
        }
 
        //- Construct and return a clone, resetting the face list
        //  and boundary mesh
        virtual autoPtr<polyPatch> clone
        (
            const polyBoundaryMesh& bm,
            const label index,
            const label newSize,
            const label newStart
        ) const
        {
            return autoPtr<polyPatch>
            (
                new processorPolyPatch
                (
                    *this,
                    bm,
                    index,
                    newSize,
                    newStart
                )
            );
        }
 
 
    //- Destructor
    virtual ~processorPolyPatch();
 
 
    // Member Functions
 
        //- Return true only if this is a parallel run
        virtual bool coupled() const
        {
            if (Pstream::parRun())
            {
                return true;
            }
            else
            {
                return false;
            }
        }
 
        //- Return processor number
        int myProcNo() const
        {
            return myProcNo_;
        }
 
        //- Return neighbour processor number
        int neighbProcNo() const
        {
            return neighbProcNo_;
        }
 
        //- Does the processor own the patch ?
        virtual bool owner() const
        {
            return (myProcNo_ < neighbProcNo_);
        }
 
        //- Is the processor the patch neighbour ?
        bool neighbour() const
        {
            return !owner();
        }
 
        //- Return the name of a processorPolyPatch
        //  constructed from the processor IDs
        static word newName
        (
            const label myProcNo,
            const label neighbProcNo
        );
 
        //- Return processor-neighbour patch face centres
        const vectorField& neighbFaceCentres() const
        {
            return neighbFaceCentres_;
        }
 
        //- Return processor-neighbour patch face areas
        const vectorField& neighbFaceAreas() const
        {
            return neighbFaceAreas_;
        }
 
        //- Return processor-neighbour patch neighbour cell centres
        const vectorField& neighbFaceCellCentres() const
        {
            return neighbFaceCellCentres_;
        }
 
        //- Return neighbour point labels. WIP.
        const labelList& nbrPoints() const;
 
        //- Return neighbour edge labels. WIP.
        const labelList& nbrEdges() const;
 
        //- Return message tag to use for communication
        virtual int tag() const
        {
            return Pstream::msgType();
        }
 
        //- Return communicator used for communication
        virtual label comm() const
        {
            return boundaryMesh().mesh().comm();
        }
 
        //- Return null transform between processor patches
        virtual const transformer& transform() const
        {
            return transformer::null;
        }
 
        //- Initialise ordering for primitivePatch. Does not
        //  refer to *this (except for name() and type() etc.)
        virtual void initOrder(PstreamBuffers&, const primitivePatch&) const;
 
        //- Return new ordering for primitivePatch.
        //  Ordering is -faceMap: for every face
        //  index of the new face -rotation:for every new face the clockwise
        //  shift of the original face. Return false if nothing changes
        //  (faceMap is identity, rotation is 0), true otherwise.
        virtual bool order
        (
            PstreamBuffers&,
            const primitivePatch&,
            labelList& faceMap,
            labelList& rotation
        ) const;
 
 
        //- Write the polyPatch data as a dictionary
        virtual void write(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //