src/surfMesh/surfaceRegistry/surfaceRegistry.H

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