cellToPoint.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 OpenFOAM Foundation
    Copyright (C) 2018 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::cellToPoint
 
Description
    A topoSetPointSource to select points based on usage in cells.
 
    \heading Dictionary parameters
    \table
        Property    | Description                       | Required  | Default
        sets        | The cellSet names to use          | possibly |
        set         | The cellSet name to use           | possibly |
        option      | Selection type (all)              | yes   |
    \endtable
 
Note
    Must specify "sets" or "set" (highest to lowest precedence).
 
SourceFiles
    cellToPoint.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef cellToPoint_H
#define cellToPoint_H
 
#include "topoSetPointSource.H"
#include "Enum.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class cellToPoint Declaration
\*---------------------------------------------------------------------------*/
 
class cellToPoint
:
    public topoSetPointSource
{
 
public:
        //- Enumeration defining the valid options
        enum cellAction
        {
            ALL
        };
 
private:
 
        //- Add usage string
        static addToUsageTable usage_;
 
        static const Enum<cellAction> cellActionNames_;
 
        //- Names of sets to use
        wordList names_;
 
        //- Option
        cellAction option_;
 
 
    // Private Member Functions
 
        //- Depending on face to cell option add to or delete from cellSet.
        void combine(topoSet& set, const bool add, const word& setName) const;
 
 
public:
 
    //- Runtime type information
    TypeName("cellToPoint");
 
    // Constructors
 
        //- Construct from components
        cellToPoint
        (
            const polyMesh& mesh,
            const word& setName,
            const cellAction option
        );
 
        //- Construct from dictionary
        cellToPoint(const polyMesh& mesh, const dictionary& dict);
 
        //- Construct from Istream
        cellToPoint(const polyMesh& mesh, Istream& is);
 
 
    //- Destructor
    virtual ~cellToPoint() = default;
 
 
    // Member Functions
 
        virtual void applyToSet
        (
            const topoSetSource::setAction action,
            topoSet& set
        ) const;
 
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //