steadyParticleTracksTemplates.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 -------------------------------------------------------------------------------
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 \*---------------------------------------------------------------------------*/
27 
28 #ifndef steadyParticleTracksTemplates_H
29 #define steadyParticleTracksTemplates_H
30 
31 #include "OFstream.H"
32 #include "SortableList.H"
33 #include "IOobjectList.H"
34 #include "PtrList.H"
35 #include "Field.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 template<class Type>
45 bool fieldOk(const IOobjectList& cloudObjs, const word& name);
46 
47 template<class Type>
48 tmp<Field<Type>> readParticleField
49 (
50  const word& name,
51  const IOobjectList cloudObjs
52 );
53 
54 template<class Type>
55 void readFields
56 (
57  PtrList<List<Type>>& values,
58  const List<word>& fields,
59  const IOobjectList& cloudObjs
60 );
61 
62 template<class Type>
63 void writeVTK(OFstream& os, const Type& value);
64 
65 template<class Type>
66 void writeVTKFields
67 (
68  OFstream& os,
69  const PtrList<List<Type>>& values,
70  const List<List<label>>& addr,
71  const List<word>& fieldNames
72 );
73 
74 template<class Type>
75 void processFields
76 (
77  OFstream& os,
78  const List<List<label>>& addr,
79  const List<word>& userFieldNames,
80  const IOobjectList& cloudObjs
81 );
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #ifdef NoRepository
91 #endif
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Foam::HashTableOps::values
List< T > values(const HashTable< T, Key, Hash > &tbl, const bool doSort=false)
List of values from HashTable, optionally sorted.
Definition: HashOps.H:149
IOobjectList.H
Foam::readParticleField
tmp< Field< Type > > readParticleField(const word &name, const IOobjectList cloudObjs)
Foam::writeVTK
void writeVTK(OFstream &os, const Type &value)
OFstream.H
SortableList.H
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Field.H
steadyParticleTracksTemplates.C
Foam::writeVTKFields
void writeVTKFields(OFstream &os, const PtrList< List< Type >> &values, const List< List< label >> &addr, const List< word > &fieldNames)
Foam::fieldOk
bool fieldOk(const IOobjectList &cloudObjs, const word &name)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::readFields
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
Definition: ReadFieldsTemplates.C:312
PtrList.H
fields
multivariateSurfaceInterpolationScheme< scalar >::fieldTable fields
Definition: createFields.H:97
Foam::processFields
void processFields(OFstream &os, const List< List< label >> &addr, const List< word > &userFieldNames, const IOobjectList &cloudObjs)