topoAction.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) 2011 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::topoAction
29 
30 Description
31  A virtual base class for topological actions
32 
33 SourceFiles
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef topoAction_H
38 #define topoAction_H
39 
40 #include "typeInfo.H"
41 #include "autoPtr.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class topoAction Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class topoAction
53 {
54 public:
55 
56  // Static data members
57 
58  //- Runtime type information
59  TypeName("topoAction");
60 
61 
62  // Constructors
63 
64  //- Construct null
65  topoAction()
66  {}
67 
68  //- Construct and return a clone
69  virtual autoPtr<topoAction> clone() const = 0;
70 
71 
72  //- Destructor
73  virtual ~topoAction() = default;
74 
75 };
76 
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 } // End namespace Foam
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 #endif
85 
86 // ************************************************************************* //
typeInfo.H
Foam::topoAction::topoAction
topoAction()
Construct null.
Definition: topoAction.H:64
Foam::topoAction::~topoAction
virtual ~topoAction()=default
Destructor.
Foam::topoAction::TypeName
TypeName("topoAction")
Runtime type information.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::topoAction
A virtual base class for topological actions.
Definition: topoAction.H:51
Foam::topoAction::clone
virtual autoPtr< topoAction > clone() const =0
Construct and return a clone.
autoPtr.H