blockMeshTools.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) 2016-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 Namespace
25  Foam::blockMeshTools
26 
27 Description
28  Tools for parsing label(List) with dictionary lookup.
29 
30 SourceFiles
31  blockMeshTools.C
32  blockMeshToolsTemplates.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef blockMeshTools_H
37 #define blockMeshTools_H
38 
39 #include "dictionary.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace blockMeshTools
46 {
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50  //- In-place read with dictionary lookup
51  void read(Istream&, label&, const dictionary&);
52 
53  //- In-place read with dictionary lookup
54  template<class T>
55  void read(Istream&, List<T>&, const dictionary&);
56 
57  //- Return-read with dictionary lookup
58  label read(Istream&, const dictionary&);
59 
60  //- Return-read with dictionary lookup
61  template<class T>
62  List<T> read(Istream& is, const dictionary&);
63 
64  //- Write with dictionary lookup
65  void write(Ostream&, const label, const dictionary&);
66 
67  //- Linear search for label entry
68  const keyType& findEntry(const dictionary&, const label);
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 } // End namespace blockMeshTools
73 } // End namespace Foam
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 #ifdef NoRepository
78  #include "blockMeshToolsTemplates.C"
79 #endif
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
FvWallInfoData< WallInfo, label > label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
void write(Ostream &, const label, const dictionary &)
Write with dictionary lookup.
const keyType & findEntry(const dictionary &, const label)
Linear search for label entry.
Namespace for OpenFOAM.