FreeFOAM The Cross-Platform CFD Toolkit
surfaceInterpolate.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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 InNamespace
25  Foam::fvc
26 
27 Description
28  Surface Interpolation
29 
30 SourceFiles
31  surfaceInterpolate.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfaceInterpolate_H
36 #define surfaceInterpolate_H
37 
38 #include <OpenFOAM/tmp.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Namespace fvc functions Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 namespace fvc
53 {
54  //- Return weighting factors for scheme given from Istream
55  template<class Type>
56  static tmp<surfaceInterpolationScheme<Type> > scheme
57  (
58  const surfaceScalarField& faceFlux,
59  Istream& schemeData
60  );
61 
62  //- Return weighting factors for scheme given by name in dictionary
63  template<class Type>
64  static tmp<surfaceInterpolationScheme<Type> > scheme
65  (
66  const surfaceScalarField& faceFlux,
67  const word& name
68  );
69 
70 
71  //- Return weighting factors for scheme given from Istream
72  template<class Type>
73  static tmp<surfaceInterpolationScheme<Type> > scheme
74  (
75  const fvMesh& mesh,
76  Istream& schemeData
77  );
78 
79  //- Return weighting factors for scheme given by name in dictionary
80  template<class Type>
81  static tmp<surfaceInterpolationScheme<Type> > scheme
82  (
83  const fvMesh& mesh,
84  const word& name
85  );
86 
87 
88  //- Interpolate field onto faces using scheme given by Istream
89  template<class Type>
90  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
91  (
92  const GeometricField<Type, fvPatchField, volMesh>& tvf,
93  const surfaceScalarField& faceFlux,
94  Istream& schemeData
95  );
96 
97  //- Interpolate field onto faces using scheme given by name in fvSchemes
98  template<class Type>
99  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
100  (
101  const GeometricField<Type, fvPatchField, volMesh>& tvf,
102  const surfaceScalarField& faceFlux,
103  const word& name
104  );
105 
106  //- Interpolate field onto faces using scheme given by name in fvSchemes
107  template<class Type>
108  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
109  (
110  const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
111  const surfaceScalarField& faceFlux,
112  const word& name
113  );
114 
115  //- Interpolate field onto faces using scheme given by name in fvSchemes
116  template<class Type>
117  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
118  (
119  const GeometricField<Type, fvPatchField, volMesh>& tvf,
120  const tmp<surfaceScalarField>& faceFlux,
121  const word& name
122  );
123 
124  //- Interpolate field onto faces using scheme given by name in fvSchemes
125  template<class Type>
126  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
127  (
128  const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
129  const tmp<surfaceScalarField>& faceFlux,
130  const word& name
131  );
132 
133 
134  //- Interpolate field onto faces using scheme given by Istream
135  template<class Type>
136  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
137  (
138  const GeometricField<Type, fvPatchField, volMesh>& tvf,
139  Istream& schemeData
140  );
141 
142  //- Interpolate field onto faces using scheme given by name in fvSchemes
143  template<class Type>
144  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
145  (
146  const GeometricField<Type, fvPatchField, volMesh>& tvf,
147  const word& name
148  );
149 
150  //- Interpolate field onto faces using scheme given by name in fvSchemes
151  template<class Type>
152  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
153  (
154  const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
155  const word& name
156  );
157 
158 
159  //- Interpolate tmp field onto faces using central differencing
160  template<class Type>
161  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
162  (
163  const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
164  );
165 
166  //- Interpolate field onto faces using central differencing
167  template<class Type>
168  static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
169  (
170  const GeometricField<Type, fvPatchField, volMesh>& tvf
171  );
172 }
173 
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 } // End namespace Foam
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #ifdef NoRepository
183 #endif
184 
185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
186 
187 #endif
188 
189 // ************************ vim: set sw=4 sts=4 et: ************************ //