upwind.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::upwind
26 
27 Description
28  Upwind interpolation scheme class.
29 
30 SourceFiles
31  upwind.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef upwind_H
36 #define upwind_H
37 
39 #include "volFields.H"
40 #include "surfaceFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class upwind Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
52 class upwind
53 :
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("upwind");
61 
62 
63  // Constructors
64 
65  //- Construct from faceFlux
67  (
68  const fvMesh& mesh,
69  const surfaceScalarField& faceFlux
70  )
71  :
72  limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
73  {}
74 
75  //- Construct from Istream.
76  // The name of the flux field is read from the Istream and looked-up
77  // from the mesh objectRegistry
79  (
80  const fvMesh& mesh,
81  Istream& is
82  )
83  :
84  limitedSurfaceInterpolationScheme<Type>(mesh, is)
85  {}
86 
87  //- Construct from faceFlux and Istream
89  (
90  const fvMesh& mesh,
91  const surfaceScalarField& faceFlux,
92  Istream&
93  )
94  :
95  limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
96  {}
97 
98 
99  // Member Functions
100 
101  //- Return the interpolation limiter
103  (
105  ) const
106  {
108  (
109  "upwindLimiter",
110  this->mesh(),
112  );
113  }
114 
115  //- Return the interpolation weighting factors
117  {
118  return pos0(this->faceFlux_);
119  }
120 
121  //- Return the interpolation weighting factors
123  (
125  ) const
126  {
127  return weights();
128  }
129 
130 
131  // Member Operators
132 
133  //- Disallow default bitwise assignment
134  void operator=(const upwind&) = delete;
135 };
136 
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //
Foam::surfaceFields.
tmp< surfaceScalarField > weights() const
Return the interpolation weighting factors.
Definition: upwind.H:115
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
static tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > New(const word &name, const Internal &, const PtrList< fvsPatchField< scalar >> &)
Return a temporary field constructed from name,.
const dimensionSet dimless
const fvMesh & mesh() const
Return mesh reference.
virtual tmp< surfaceScalarField > limiter(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the interpolation limiter.
Definition: upwind.H:102
TypeName("upwind")
Runtime type information.
void operator=(const upwind &)=delete
Disallow default bitwise assignment.
dimensionedScalar pos0(const dimensionedScalar &ds)
upwind(const fvMesh &mesh, const surfaceScalarField &faceFlux)
Construct from faceFlux.
Definition: upwind.H:66
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Upwind interpolation scheme class.
Definition: upwind.H:51
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
Abstract base class for limited surface interpolation schemes.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.