symmetryPlanePolyPatch.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) 2013-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::symmetryPlanePolyPatch
 
Description
    Symmetry-plane patch.
 
SourceFiles
    symmetryPlanePolyPatch.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef symmetryPlanePolyPatch_H
#define symmetryPlanePolyPatch_H
 
#include "polyPatch.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                   Class symmetryPlanePolyPatch Declaration
\*---------------------------------------------------------------------------*/
 
class symmetryPlanePolyPatch
:
    public polyPatch
{
    // Private Data
 
        //- Symmetry plane normal
        vector n_;
 
 
protected:
 
    // Protected Member Functions
 
        //- Calculate the patch geometry
        virtual void calcGeometry(PstreamBuffers&);
 
 
public:
 
    //- Runtime type information
    TypeName("symmetryPlane");
 
 
    // Constructors
 
        //- Construct from components
        symmetryPlanePolyPatch
        (
            const word& name,
            const label size,
            const label start,
            const label index,
            const polyBoundaryMesh& bm
        );
 
        //- Construct from dictionary
        symmetryPlanePolyPatch
        (
            const word& name,
            const dictionary& dict,
            const label index,
            const polyBoundaryMesh& bm
        );
 
        //- Construct as copy, resetting the boundary mesh
        symmetryPlanePolyPatch
        (
            const symmetryPlanePolyPatch&,
            const polyBoundaryMesh&
        );
 
        //- Construct given the original patch and resetting the
        //  face list and boundary mesh information
        symmetryPlanePolyPatch
        (
            const symmetryPlanePolyPatch& 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 symmetryPlanePolyPatch(*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 symmetryPlanePolyPatch(*this, bm, index, newSize, newStart)
            );
        }
 
 
    // Member Functions
 
        //- Return true as this patch is a constraint type
        virtual bool constraint() const
        {
            return true;
        }
 
        //- Return symmetry plane normal
        const vector& n() const
        {
            return n_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //