wedgeFaPatch.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) 2016-2017 Wikki Ltd
    Copyright (C) 2019-2022 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::wedgeFaPatch
 
Description
    Wedge front and back plane patch.
 
Author
    Zeljko Tukovic, FMENA
    Hrvoje Jasak, Wikki Ltd.
 
SourceFiles
    wedgeFaPatch.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_wedgeFaPatch_H
#define Foam_wedgeFaPatch_H
 
#include "faPatch.H"
#include "wedgePolyPatch.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class wedgeFaPatch Declaration
\*---------------------------------------------------------------------------*/
 
class wedgeFaPatch
:
    public faPatch
{
    // Private Data
 
        const wedgePolyPatch* wedgePolyPatchPtr_;
 
        //- Axis point label
        mutable label axisPoint_;
 
        //- Is it axis point looked for?
        mutable bool axisPointChecked_;
 
        //- Find axis point
        void findAxisPoint() const;
 
 
public:
 
    //- Runtime type information
    TypeName("wedge");
 
    //- Construct from dictionary.
    //  Fatal if ngbPolyPatchIndex is not defined
    //  or does not correspond to a wedgePolyPatch
    wedgeFaPatch
    (
        const word& name,
        const dictionary& dict,
        const label index,
        const faBoundaryMesh& bm,
        const word& patchType
    );
 
 
    //- Destructor
    virtual ~wedgeFaPatch() = default;
 
 
    // Member Functions
 
        // Access
 
            //- Return axis of the wedge
            const vector& axis() const noexcept
            {
                return wedgePolyPatchPtr_->axis();
            }
 
            //- Return plane normal between the wedge boundaries
            const vector& centreNormal() const noexcept
            {
                return wedgePolyPatchPtr_->centreNormal();
            }
 
            //- Return face transformation tensor
            const tensor& edgeT() const noexcept
            {
                return wedgePolyPatchPtr_->faceT();
            }
 
            //- Return neighbour-cell transformation tensor
            const tensor& faceT() const noexcept
            {
                return wedgePolyPatchPtr_->cellT();
            }
 
            //- Return axis point label
            label axisPoint() const
            {
                if (axisPoint_ == -1 && !axisPointChecked_)
                {
                    findAxisPoint();
                }
 
                return axisPoint_;
            }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //