surfaceToPoint.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-2015 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::surfaceToPoint
 
Description
    A topoSetPointSource to select points based on relation to surface.
 
    Select based on:
    - distance to surface
    - inside/outside status to surface
      (Uses normal of nearest surface triangle so requires valid surface
      topology!)
 
    \heading Dictionary parameters
    \table
        Property    | Description                       | Required  | Default
        file        | The surface "filename"            | yes   |
        scale       | surface scaling factor            | no    | -1
        nearDistance   | Near distance to the surface   | yes   |
        includeInside  | Include inside cells (bool)    | yes   |
        includeOutside | Include outside cells (bool)   | yes   |
    \endtable
 
SourceFiles
    surfaceToPoint.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef surfaceToPoint_H
#define surfaceToPoint_H
 
#include "topoSetPointSource.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declarations
class triSurfaceSearch;
 
/*---------------------------------------------------------------------------*\
                           Class surfaceToPoint Declaration
\*---------------------------------------------------------------------------*/
 
class surfaceToPoint
:
    public topoSetPointSource
{
 
    // Private data
 
        //- Add usage string
        static addToUsageTable usage_;
 
        //- Name of surface file
        const fileName surfName_;
 
        //- Optional scaling for surface
        const scalar scale_;
 
        //- If > 0 : include points with distance to surface less than nearDist.
        const scalar nearDist_;
 
        //- Include all points on opposite sign of normal on nearest surface.
        const bool includeInside_;
 
        //- Include all points on this sign of normal on nearest surface.
        const bool includeOutside_;
 
 
    // Private Member Functions
 
        //- Depending on surface add to or delete from pointSet.
        void combine(topoSet& set, const bool add) const;
 
        //- Check settings at construction time.
        void checkSettings() const;
 
public:
 
    //- Runtime type information
    TypeName("surfaceToPoint");
 
    // Constructors
 
        //- Construct from components
        surfaceToPoint
        (
            const polyMesh& mesh,
            const fileName& surfName,
            const scalar nearDist,
            const bool includeInside,
            const bool includeOutside
        );
 
        //- Construct from dictionary
        surfaceToPoint(const polyMesh& mesh, const dictionary& dict);
 
        //- Construct from Istream
        surfaceToPoint(const polyMesh& mesh, Istream& is);
 
 
    //- Destructor
    virtual ~surfaceToPoint() = default;
 
 
    // Member Functions
 
        virtual void applyToSet
        (
            const topoSetSource::setAction action,
            topoSet& set
        ) const;
 
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //