src/OpenFOAM/coordinateSystems/coordinateSystems.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::coordinateSystems
  27
  28 Description
  29     Provides a centralized coordinateSystem collection.
  30
  31 Note
  32     Mixing normal constructors and the coordinateSystems::New constructor
  33     may yield unexpected results.
  34
  35 SourceFiles
  36     coordinateSystems.C
  37
  38 \*---------------------------------------------------------------------------*/
  39 #ifndef coordinateSystems_H
  40 #define coordinateSystems_H
  41
  42 #include "coordinateSystem.H"
  43 #include "IOPtrList.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                      Class coordinateSystems Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class coordinateSystems
  55 :
  56     public IOPtrList<coordinateSystem>
  57 {
  58
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise copy construct
  62         coordinateSystems(const coordinateSystems&);
  63
  64         //- Disallow default bitwise assignment
  65         void operator=(const coordinateSystems&);
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("coordinateSystems");
  71
  72     // Constructors
  73
  74         //- Read construct from IOobject
  75         explicit coordinateSystems(const IOobject&);
  76
  77         //- Construct from IOobject and a PtrList
  78         coordinateSystems
  79         (
  80             const IOobject&,
  81             const PtrList<coordinateSystem>&
  82         );
  83
  84         //- Construct from IOobject and transferring the PtrList contents
  85         coordinateSystems
  86         (
  87             const IOobject&,
  88             const Xfer<PtrList<coordinateSystem> >&
  89         );
  90
  91     // Selectors
  92
  93         //- Return previously registered or read construct from "constant"
  94         static const coordinateSystems& New(const objectRegistry&);
  95
  96     // Member Functions
  97
  98         //- Find and return index for a given keyword, returns -1 if not found
  99         label find(const word& key) const;
 100
 101         //- Search for given keyword
 102         bool found(const word& keyword) const;
 103
 104         //- Return the table of contents (list of all keywords)
 105         wordList toc() const;
 106
 107         //- write data
 108         bool writeData(Ostream&, bool subDict=true) const;
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //