downwind.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-2022 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 Class
25  Foam::downwind
26 
27 Description
28  Downwind interpolation scheme class.
29 
30 SourceFiles
31  downwind.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef downwind_H
36 #define downwind_H
37 
39 #include "volFields.H"
40 #include "surfaceFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class downwind Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
52 class downwind
53 :
54  public surfaceInterpolationScheme<Type>
55 {
56  // Private Data
57 
58  const surfaceScalarField& faceFlux_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("downwind");
65 
66 
67  // Constructors
68 
69  //- Construct from faceFlux
70  downwind
71  (
72  const fvMesh& mesh,
73  const surfaceScalarField& faceFlux
74  )
75  :
77  faceFlux_(faceFlux)
78  {}
79 
80  //- Construct from Istream.
81  // The name of the flux field is read from the Istream and looked-up
82  // from the mesh objectRegistry
83  downwind
84  (
85  const fvMesh& mesh,
86  Istream& is
87  )
88  :
90  faceFlux_
91  (
92  mesh.lookupObject<surfaceScalarField>
93  (
94  word(is)
95  )
96  )
97  {}
98 
99  //- Construct from faceFlux and Istream
100  downwind
101  (
102  const fvMesh& mesh,
103  const surfaceScalarField& faceFlux,
104  Istream&
105  )
106  :
108  faceFlux_(faceFlux)
109  {}
110 
111 
112  // Member Functions
113 
114  //- Return the interpolation weighting factors
116  (
117  const VolField<Type>&
118  ) const
119  {
120  return neg(faceFlux_);
121  }
122 
123 
124  // Member Operators
125 
126  //- Disallow default bitwise assignment
127  void operator=(const downwind&) = delete;
128 };
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
Generic GeometricField class.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
Downwind interpolation scheme class.
Definition: downwind.H:54
void operator=(const downwind &)=delete
Disallow default bitwise assignment.
downwind(const fvMesh &mesh, const surfaceScalarField &faceFlux)
Construct from faceFlux.
Definition: downwind.H:70
TypeName("downwind")
Runtime type information.
virtual tmp< surfaceScalarField > weights(const VolField< Type > &) const
Return the interpolation weighting factors.
Definition: downwind.H:115
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Abstract base class for surface interpolation schemes.
const fvMesh & mesh() const
Return mesh reference.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
dimensionedScalar neg(const dimensionedScalar &ds)
Foam::surfaceFields.