Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / surfMesh / surfaceRegistry / surfaceRegistry.H
blob0af3cb73a6227bd41150d0951e8eb1aa4ef52240
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::surfaceRegistry
27 Description
28     Wraps the normal objectRegistry with a local instance for %surfaces.
30 SourceFiles
31     surfaceRegistry.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef surfaceRegistry_H
36 #define surfaceRegistry_H
38 #include "objectRegistry.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                        Class surfaceRegistry Declaration
47 \*---------------------------------------------------------------------------*/
49 class surfaceRegistry
51     public objectRegistry
54     // Private Member Functions
56         //- Disallow default bitwise copy construct
57         surfaceRegistry(const surfaceRegistry&);
59         //- Disallow default bitwise assignment
60         void operator=(const surfaceRegistry&);
63 public:
65     //- Runtime type information
66     TypeName("surfaceRegistry");
68         //- The prefix to local: %surfaces
69         static const word prefix;
71         //- The default surface name: %default
72         static word defaultName;
75     // Constructors
77         //- Construct for the given objectRegistry and named surface
78         surfaceRegistry(const objectRegistry&, const word& surfName = "");
81     // Destructor
83         virtual ~surfaceRegistry();
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 } // End namespace Foam
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 #endif
95 // ************************************************************************* //