src/meshTools/coordinateSystems/coordinateSystems.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 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::coordinateSystems
  26
  27 Description
  28     Provides a centralized coordinateSystem collection.
  29
  30 Note
  31     Mixing normal constructors and the coordinateSystems::New constructor
  32     may yield unexpected results.
  33
  34 SourceFiles
  35     coordinateSystems.C
  36
  37 \*---------------------------------------------------------------------------*/
  38 #ifndef coordinateSystems_H
  39 #define coordinateSystems_H
  40
  41 #include "coordinateSystem.H"
  42 #include "IOPtrList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                      Class coordinateSystems Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class coordinateSystems
  54 :
  55     public IOPtrList<coordinateSystem>
  56 {
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         coordinateSystems(const coordinateSystems&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const coordinateSystems&);
  65
  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
  92     // Selectors
  93
  94         //- Return previously registered or read construct from "constant"
  95         static const coordinateSystems& New(const objectRegistry&);
  96
  97
  98     // Member Functions
  99
 100         //- Find and return indices for all matches
 101         labelList findIndices(const keyType& key) const;
 102
 103         //- Find and return index for the first match, return -1 if not found
 104         label findIndex(const keyType& key) const;
 105
 106         //- Find and return index for the first match, returns -1 if not found
 107         // \deprecated use findIndex() instead (deprecated Jul 2010)
 108         label find(const keyType& key) const;
 109
 110         //- Search for given key
 111         bool found(const keyType& key) const;
 112
 113         //- Return the table of contents (list of all keywords)
 114         wordList toc() const;
 115
 116         //- write data
 117         bool writeData(Ostream&, bool subDict=true) const;
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #endif
 128
 129 // ************************************************************************* //