UDictionary.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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::UDictionary
26 
27 Description
28  Template dictionary class which does not manages the storage
29  associated with it.
30 
31  It is derived from DictionaryBase instantiated on a non-memory managed
32  form of intrusive doubly-linked list of <T>.
33 
34 SourceFiles
35  UDictionary.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef UDictionary_H
40 #define UDictionary_H
41 
42 #include "DictionaryBase.H"
43 #include "UIDLList.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class UDictionary Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class T>
55 class UDictionary
56 :
57  public DictionaryBase<UIDLList<T>, T>
58 {
59 
60 public:
61 
62  // Constructors
63 
64  //- Null constructor
65  UDictionary();
66 
67  //- Copy construct
68  UDictionary(const UDictionary&);
69 };
70 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 } // End namespace Foam
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #ifdef NoRepository
79  #include "UDictionary.C"
80 #endif
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 #endif
85 
86 // ************************************************************************* //
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:61
UIDLList.H
Intrusive doubly-linked list.
Foam::UDictionary::UDictionary
UDictionary()
Null constructor.
Definition: UDictionary.C:31
Foam::UDictionary
Template dictionary class which does not manages the storage associated with it.
Definition: UDictionary.H:54
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:213