patchSummaryTemplates.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-2023 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 \*---------------------------------------------------------------------------*/
25 
26 #ifndef patchSummaryTemplates_H
27 #define patchSummaryTemplates_H
28 
29 #include "volFields.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  template<class PatchField>
36  word patchFieldType(const PatchField& pf);
37 
38  template<class GeoField>
40  (
41  PtrList<GeoField>& fieldList,
42  const IOobject& obj,
43  const label fieldi,
44  const typename GeoField::Mesh& mesh
45  );
46 
47  template<class GeoField>
49  (
50  const PtrList<GeoField>& fieldList,
51  const label patchi
52  );
53 
54  template<class GeoField>
56  (
57  const PtrList<GeoField>& fieldList,
58  const label patchi,
59  HashTable<word>& fieldToType
60  );
61 } // End namespace Foam
62 
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 #ifdef NoRepository
67  #include "patchSummaryTemplates.C"
68 #endif
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #endif
73 
74 // ************************************************************************* //
An STL-conforming hash table.
Definition: HashTable.H:127
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: PtrList.H:75
A class for handling words, derived from string.
Definition: word.H:62
label patchi
Namespace for OpenFOAM.
void addToFieldList(PtrList< GeoField > &fieldList, const IOobject &obj, const label fieldi, const typename GeoField::Mesh &mesh)
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void collectFieldList(const PtrList< GeoField > &fieldList, const label patchi, HashTable< word > &fieldToType)
word patchFieldType(const PatchField &pf)
void outputFieldList(const PtrList< GeoField > &fieldList, const label patchi)