src/surfMesh/surfaceRegistry/surfaceRegistry.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2010 OpenCFD Ltd.
   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::surfaceRegistry
  26
  27 Description
  28     Wraps the normal objectRegistry with a local instance for %surfaces.
  29
  30 SourceFiles
  31     surfaceRegistry.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef surfaceRegistry_H
  36 #define surfaceRegistry_H
  37
  38 #include "objectRegistry.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class surfaceRegistry Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class surfaceRegistry
  50 :
  51     public objectRegistry
  52 {
  53
  54     // Private Member Functions
  55
  56         //- Disallow default bitwise copy construct
  57         surfaceRegistry(const surfaceRegistry&);
  58
  59         //- Disallow default bitwise assignment
  60         void operator=(const surfaceRegistry&);
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("surfaceRegistry");
  67
  68         //- The prefix to local: %surfaces
  69         static const word prefix;
  70
  71         //- The default surface name: %default
  72         static word defaultName;
  73
  74
  75     // Constructors
  76
  77         //- Construct for the given objectRegistry and named surface
  78         surfaceRegistry(const objectRegistry&, const word& surfName = "");
  79
  80
  81     //- Destructor
  82     virtual ~surfaceRegistry();
  83 };
  84
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 } // End namespace Foam
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 #endif
  93
  94 // ************************************************************************* //