blockMeshTools.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) 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 Namespace
27  Foam::blockMeshTools
28 
29 Description
30  Tools for parsing label(List) with dictionary lookup.
31 
32 SourceFiles
33  blockMeshTools.C
34  blockMeshToolsTemplates.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef blockMeshTools_H
39 #define blockMeshTools_H
40 
41 #include "dictionary.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace blockMeshTools
48 {
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52  //- In-place read with dictionary lookup
53  void read(Istream&, label& val, const dictionary&);
54 
55  //- In-place read with dictionary lookup
56  template<class T>
57  void read(Istream&, List<T>& list, const dictionary&);
58 
59  //- Return-read with dictionary lookup
60  label read(Istream&, const dictionary&);
61 
62  //- Return-read with dictionary lookup
63  template<class T>
64  List<T> read(Istream& is, const dictionary&);
65 
66  //- Write with dictionary lookup
67  void write(Ostream&, const label val, const dictionary&);
68 
69  //- Linear search for labelled entry, nullptr if not found
70  const entry* findEntry(const dictionary& dict, const label val);
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 } // End namespace blockMeshTools
75 } // End namespace Foam
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 #ifdef NoRepository
80  #include "blockMeshToolsTemplates.C"
81 #endif
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
Foam::blockMeshTools::write
void write(Ostream &, const label val, const dictionary &)
Write with dictionary lookup.
Definition: blockMeshTools.C:112
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
dict
dictionary dict
Definition: searchingEngine.H:14
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::blockMeshTools::findEntry
const entry * findEntry(const dictionary &dict, const label val)
Linear search for labelled entry, nullptr if not found.
Definition: blockMeshTools.C:132
dictionary.H
blockMeshToolsTemplates.C