/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2018 OpenCFD Ltd.
     \\/     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::patchToCell

Description
    A topoSetCellSource to select cells associated with patches.

    \heading Dictionary parameters
    \table
        Property    | Description                           | Required | Default
        patches     | The patch names or regexs             | possibly |
        patch       | The patch name or regex               | possibly |
    \endtable

Note
    Must specify "patches" or "patch" (highest to lowest precedence).

SourceFiles
    patchToCell.C

\*---------------------------------------------------------------------------*/

#ifndef patchToCell_H
#define patchToCell_H

#include "topoSetCellSource.H"
#include "wordRes.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                        Class patchToCell Declaration
\*---------------------------------------------------------------------------*/

class patchToCell
:
    public topoSetCellSource
{
    // Private Data

        //- Add usage string
        static addToUsageTable usage_;

        //- Matcher for patches
        wordRes selectedPatches_;


    // Private Member Functions

        void combine(topoSet& set, const bool add) const;


public:

    //- Runtime type information
    TypeName("patchToCell");

    // Constructors

        //- Construct from components
        patchToCell(const polyMesh& mesh, const wordRe& patchName);

        //- Construct from dictionary
        patchToCell(const polyMesh& mesh, const dictionary& dict);

        //- Construct from Istream
        patchToCell(const polyMesh& mesh, Istream& is);


    //- Destructor
    virtual ~patchToCell() = default;


    // Member Functions

        virtual void applyToSet
        (
            const topoSetSource::setAction action,
            topoSet& set
        ) const;

};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //