uniformInterpolate.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) 2012-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 #include "GeometricField.H"
29 #include "HashPtrTable.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 // * * * * * * * * * * * * * * * Global functions * * * * * * * * * * * * * //
37 
38 //- Interpolate selected fields (given by indices and corresponding weights)
39 // (boundary type becomes calculated). Fields stored per index. Field gets name
40 // "uniformInterpolate(" + fld.name() + ')'.
41 template<class GeoField>
42 tmp<GeoField> uniformInterpolate
43 (
44  const HashPtrTable<GeoField, label, Hash<label>>& fields,
45  const labelList& indices,
46  const scalarField& weights
47 );
48 
49 //- Interpolate fields. fieldsCache contains per timeName all loaded fields.
50 // Resulting field gets properties according to fieldIO
51 template<class GeoField>
52 tmp<GeoField> uniformInterpolate
53 (
54  const IOobject& fieldIO,
55  const word& fieldName,
56  const wordList& times,
57  const scalarField& weights,
58  const objectRegistry& fieldsCache
59 );
60 
61 //- Interpolate fields. fieldsCache contains per timeName all loaded fields.
62 // Resulting field gets properties according to fieldIO
63 template<class GeoField>
64 tmp<GeoField> uniformInterpolate
65 (
66  const IOobject& fieldIO,
67  const word& fieldName,
68  const wordList& times,
69  const scalarField& weights,
70  const word& registryName = "fieldsCache"
71 );
72 
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 } // End namespace Foam
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #ifdef NoRepository
82  #include "uniformInterpolate.C"
83 #endif
84 
85 // ************************************************************************* //
Foam::labelList
List< label > labelList
A List of labels.
Definition: List.H:67
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:52
Foam::wordList
List< word > wordList
A List of words.
Definition: fileName.H:62
uniformInterpolate.C
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
GeometricField.H
Foam::uniformInterpolate
tmp< GeoField > uniformInterpolate(const HashPtrTable< GeoField, label, Hash< label >> &fields, const labelList &indices, const scalarField &weights)
Interpolate selected fields (given by indices and corresponding weights)
HashPtrTable.H
fields
multivariateSurfaceInterpolationScheme< scalar >::fieldTable fields
Definition: createFields.H:97