topoSetFaceZoneSource.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) 2020-2021 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::topoSetFaceZoneSource
 
Description
    The \c topoSetFaceZoneSource is a intermediate class
    for handling \c topoSet sources for selecting face zones.
 
    The class is not an executable \c topoSet itself,
    yet a provider for common entries to its derived \c topoSet.
 
SourceFiles
    topoSetFaceZoneSource.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef topoSetFaceZoneSource_H
#define topoSetFaceZoneSource_H
 
#include "topoSetSource.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class faceZoneSet;
 
/*---------------------------------------------------------------------------*\
                    Class topoSetFaceZoneSource Declaration
\*---------------------------------------------------------------------------*/
 
class topoSetFaceZoneSource
:
    public topoSetSource
{
public:
 
    // Declare run-time constructor selection table
 
        // For the dictionary constructor
        declareRunTimeSelectionTable
        (
            autoPtr,
            topoSetFaceZoneSource,
            word,
            (
                const polyMesh& mesh,
                const dictionary& dict
            ),
            (mesh, dict)
        );
 
        // For the Istream constructor
        declareRunTimeSelectionTable
        (
            autoPtr,
            topoSetFaceZoneSource,
            istream,
            (
                const polyMesh& mesh,
                Istream& is
            ),
            (mesh, is)
        );
 
 
    // Constructors
 
        //- Construct from mesh
        explicit topoSetFaceZoneSource(const polyMesh& mesh);
 
        //- Construct from mesh, use "verbose" entry if present
        topoSetFaceZoneSource(const polyMesh& mesh, const dictionary& dict);
 
 
        //- Clone (disallowed)
        autoPtr<topoSetFaceZoneSource> clone() const
        {
            NotImplemented;
            return nullptr;
        }
 
 
    // Selectors
 
        //- Return a reference to the selected source type
        static autoPtr<topoSetFaceZoneSource> New
        (
            const word& sourceType,
            const polyMesh& mesh,
            const dictionary& dict
        );
 
        //- Return a reference to the selected source type
        static autoPtr<topoSetFaceZoneSource> New
        (
            const word& sourceType,
            const polyMesh& mesh,
            Istream& is
        );
 
 
    //- Destructor
    virtual ~topoSetFaceZoneSource() = default;
 
 
    // Member Functions
 
        //- The source category is a faceZone
        virtual topoSetSource::sourceType setType() const
        {
            return FACEZONE_SOURCE;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //