UDictionary.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::UDictionary
28 
29 Description
30  Template dictionary class which does not manages the storage
31  associated with it.
32 
33  It is derived from DictionaryBase instantiated on a non-memory managed
34  form of intrusive doubly-linked list of <T>.
35 
36 SourceFiles
37  UDictionary.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef UDictionary_H
42 #define UDictionary_H
43 
44 #include "DictionaryBase.H"
45 #include "UIDLList.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class UDictionary Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class T>
57 class UDictionary
58 :
59  public DictionaryBase<UIDLList<T>, T>
60 {
61 
62 public:
63 
64  // Constructors
65 
66  //- Null constructor
67  UDictionary();
68 
69  //- Copy construct
70  UDictionary(const UDictionary&);
71 };
72 
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 } // End namespace Foam
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 #ifdef NoRepository
81  #include "UDictionary.C"
82 #endif
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 #endif
87 
88 // ************************************************************************* //
Foam::UDictionary::UDictionary
UDictionary()
Null constructor.
Definition: UDictionary.C:33
UIDLList.H
Intrusive doubly-linked list.
UDictionary.C
DictionaryBase.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::DictionaryBase
Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it...
Definition: DictionaryBase.H:64
Foam::UDictionary
Template dictionary class which does not manages the storage associated with it.
Definition: UDictionary.H:56