searchableSurfaceModifier.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2014 OpenFOAM Foundation
9 Copyright (C) 2016 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::searchableSurfaceModifier
29
30Description
31 Changing a surface
32
33SourceFiles
34 searchableSurfaceModifier.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef searchableSurfaceModifier_H
39#define searchableSurfaceModifier_H
40
41#include "dictionary.H"
42#include "typeInfo.H"
44#include "autoPtr.H"
45#include "labelList.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52// Forward declaration of classes
53class triSurface;
54class searchableSurface;
55class searchableSurfaces;
56
57/*---------------------------------------------------------------------------*\
58 Class searchableSurfaceModifier Declaration
59\*---------------------------------------------------------------------------*/
62{
63protected:
64
65 // Protected data
68
69 //- Input dictionary
70 const dictionary dict_;
71
72public:
73
74 //- Runtime type information
75 TypeName("searchableSurfaceModifier");
76
77
78 // Declare run-time constructor selection table
81 (
82 autoPtr,
85 (
86 const searchableSurfaces& geometry,
87 const dictionary& dict
88 ),
89 (geometry, dict)
90 );
91
92
93 // Constructors
94
95 //- Construct from dictionary
97
98 //- Clone
100 {
102 return nullptr;
103 }
104
105
106 // Selectors
107
108 //- Return a reference to the selected searchableSurfaceModifier
110 (
111 const word& type,
112 const searchableSurfaces&,
113 const dictionary& dict
114 );
115
116
117 //- Destructor
119
120
121 // Member Functions
122
123 //- Do any operation on surface. Return true if anything changed
124 virtual bool modify(const labelList&, searchableSurface&) const = 0;
125
126};
127
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131} // End namespace Foam
132
133// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134
135#endif
136
137// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
static autoPtr< searchableSurfaceModifier > New(const word &type, const searchableSurfaces &, const dictionary &dict)
Return a reference to the selected searchableSurfaceModifier.
searchableSurfaceModifier(const searchableSurfaces &, const dictionary &)
Construct from dictionary.
virtual ~searchableSurfaceModifier()
Destructor.
autoPtr< searchableSurfaceModifier > clone() const
Clone.
const searchableSurfaces & geometry_
const dictionary dict_
Input dictionary.
declareRunTimeSelectionTable(autoPtr, searchableSurfaceModifier, dictionary,(const searchableSurfaces &geometry, const dictionary &dict),(geometry, dict))
TypeName("searchableSurfaceModifier")
Runtime type information.
virtual bool modify(const labelList &, searchableSurface &) const =0
Do any operation on surface. Return true if anything changed.
Base class of (analytical or triangulated) surface. Encapsulates all the search routines....
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
Namespace for OpenFOAM.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73