patchSummaryTemplates.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  Copyright (C) 2023 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #ifndef Foam_patchSummaryTemplates_H
30 #define Foam_patchSummaryTemplates_H
31 
32 #include "volFields.H"
33 #include "IOobjectList.H"
34 
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36 
37 namespace Foam
38 {
39 
40 template<class GeoField>
41 PtrList<GeoField> readFields
42 (
43  const IOobjectList& objects,
44  const typename GeoField::Mesh& mesh
45 );
46 
47 template<class GeoField>
48 void outputFieldList
49 (
50  const UPtrList<GeoField>& fieldList,
51  const label patchi
52 );
53 
54 template<class GeoField>
56 (
57  const UPtrList<GeoField>& fieldList,
58  const label patchi,
59  HashTable<word>& fieldToType
60 );
61 
62 } // End namespace Foam
63 
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 #ifdef NoRepository
68  #include "patchSummaryTemplates.C"
69 #endif
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 #endif
74 
75 // ************************************************************************* //
void outputFieldList(const UPtrList< GeoField > &fieldList, const label patchi)
dynamicFvMesh & mesh
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const NameMatchPredicate &selectedFields, DynamicList< regIOobject *> &storedObjects)
Read the selected GeometricFields of the templated type and store on the objectRegistry.
Namespace for OpenFOAM.
void collectFieldList(const UPtrList< GeoField > &fieldList, const label patchi, HashTable< word > &fieldToType)