pointFeatureEdgesTypes.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) 2012-2016 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::pointFeatureEdgesTypes
 
Description
    Holds information on the types of feature edges attached to feature points.
 
SourceFiles
    pointFeatureEdgesTypes.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef pointFeatureEdgesTypes_H
#define pointFeatureEdgesTypes_H
 
#include "HashTable.H"
#include "extendedFeatureEdgeMesh.H"
#include "List.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
 
class pointFeatureEdgesTypes;
 
Ostream& operator<<(Ostream&, const pointFeatureEdgesTypes&);
 
 
/*---------------------------------------------------------------------------*\
                   Class pointFeatureEdgesTypes Declaration
\*---------------------------------------------------------------------------*/
 
//- Hold the types of feature edges attached to the point.
class pointFeatureEdgesTypes
:
    public HashTable<label, extendedFeatureEdgeMesh::edgeStatus, Hash<label>>
{
    // Private data
 
        //- Reference to the feature edge mesh
        const extendedFeatureEdgeMesh& feMesh_;
 
        //- Label of the point
        label pointLabel_;
 
 
public:
 
    // Constructors
 
        //- Construct from components
        pointFeatureEdgesTypes
        (
            const extendedFeatureEdgeMesh& feMesh,
            const label pointLabel
        );
 
 
    //- Destructor
    ~pointFeatureEdgesTypes() = default;
 
 
    // Member Functions
 
        //- Fill the pointFeatureEdgesType class with the types of feature
        //  edges that are attached to the point.
        List<extendedFeatureEdgeMesh::edgeStatus> calcPointFeatureEdgesTypes();
 
 
    // Info
 
        friend Ostream& operator<<
        (
            Ostream& os,
            const pointFeatureEdgesTypes& p
        );
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //