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 | Copyright (C) 2011 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::topoAction
26 
27 Description
28  A virtual base class for topological actions
29 
30 SourceFiles
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef topoAction_H
35 #define topoAction_H
36 
37 #include "typeInfo.H"
38 #include "autoPtr.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class topoAction Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class topoAction
50 {
51 public:
52 
53  // Static data members
54 
55  //- Runtime type information
56  TypeName("topoAction");
57 
58 
59  // Constructors
60 
61  //- Construct null
62  topoAction()
63  {}
64 
65  //- Construct and return a clone
66  virtual autoPtr<topoAction> clone() const = 0;
67 
68 
69  //- Destructor
70  virtual ~topoAction()
71  {}
72 
73 };
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 } // End namespace Foam
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
virtual autoPtr< topoAction > clone() const =0
Construct and return a clone.
TypeName("topoAction")
Runtime type information.
A virtual base class for topological actions.
Definition: topoAction.H:48
virtual ~topoAction()
Destructor.
Definition: topoAction.H:69
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
topoAction()
Construct null.
Definition: topoAction.H:61
Namespace for OpenFOAM.