fvBoundaryMesh.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) 2018-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::fvBoundaryMesh
 
Description
    A fvBoundaryMesh is a fvPatch list with
    a reference to the associated fvMesh,
    with additional search methods etc.
 
SourceFiles
    fvBoundaryMesh.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_fvBoundaryMesh_H
#define Foam_fvBoundaryMesh_H
 
#include "fvPatch.H"
#include "lduInterfacePtrsList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class fvMesh;
class polyBoundaryMesh;
class wordRes;
 
/*---------------------------------------------------------------------------*\
                       Class fvBoundaryMesh Declaration
\*---------------------------------------------------------------------------*/
 
class fvBoundaryMesh
:
    public fvPatchList
{
    // Private Data
 
        //- Reference to mesh
        const fvMesh& mesh_;
 
 
    // Private Member Functions
 
        //- Assign fvPatches corresponding to the given polyBoundaryMesh
        void addPatches(const polyBoundaryMesh& pbm);
 
protected:
 
        //- Update boundary based on new polyBoundaryMesh
        void readUpdate(const polyBoundaryMesh&);
 
 
public:
 
    //- Declare friendship with fvMesh
    friend class fvMesh;
 
 
    // Generated Methods
 
        //- No copy construct
        fvBoundaryMesh(const fvBoundaryMesh&) = delete;
 
        //- No copy assignment
        void operator=(const fvBoundaryMesh&) = delete;
 
 
    // Constructors
 
        //- Construct zero size with mesh reference
        explicit fvBoundaryMesh(const fvMesh&);
 
        //- Construct from polyBoundaryMesh
        fvBoundaryMesh(const fvMesh&, const polyBoundaryMesh&);
 
 
    // Member Functions
 
        //- Return the mesh reference
        const fvMesh& mesh() const noexcept { return mesh_; }
 
        //- Return a list of faceCells for each patch
        UPtrList<const labelUList> faceCells() const;
 
        //- Return a list of pointers for each patch
        //- with only those pointing to interfaces being set
        lduInterfacePtrsList interfaces() const;
 
        //- The (sorted) patch indices for all matches,
        //- optionally matching patch groups.
        //  \returns an empty list for an empty matcher
        labelList indices(const wordRe& matcher, const bool useGroups) const;
 
        //- The (sorted) patch indices for all matches,
        //- optionally matching patch groups.
        //  \returns an empty list for an empty matcher
        labelList indices(const wordRes& matcher, const bool useGroups) const;
 
        //- The (sorted) patch indices: logic as per Foam::wordRes::filter,
        //- optionally matching patch groups.
        //
        //  An empty \em allow accepts everything not in \em deny.
        //  A literal \em allow match has higher priority than any \em deny.
        //  A regex \em allow match has lower priority than any \em deny.
        //
        //  \returns identity list when allow/deny are both empty.
        labelList indices
        (
            const wordRes& allow,
            const wordRes& deny,
            const bool useGroups  
        ) const;
 
        //- Find patch index given a name
        //  A no-op (returns -1) for an empty patchName
        label findPatchID(const word& patchName) const;
 
        //- Find patch by name and return const pointer.
        //- \returns nullptr if not found or for an empty patchName
        const fvPatch* cfindPatch(const word& patchName) const;
 
        //- Correct patches after moving points
        void movePoints();
 
 
    // Member Operators
 
        //- Return const and non-const reference to fvPatch by index.
        using fvPatchList::operator[];
 
        //- Return const reference to fvPatch by name.
        const fvPatch& operator[](const word& patchName) const;
 
        //- Return reference to fvPatch by name.
        fvPatch& operator[](const word& patchName);
 
 
    // Housekeeping
 
        //- Identical to the indices() method (AUG-2018)
        FOAM_DEPRECATED_FOR(2018-08, "indices() method")
        labelList findIndices(const wordRe& key, bool useGroups) const
        {
            return indices(key, useGroups);
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //