LUST.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-2020 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::LUST
26 
27 Description
28  LUST: Linear-upwind stabilised transport.
29 
30  Interpolation scheme class derived from linearUpwind which returns blended
31  linear/linear-upwind weighting factors and also applies a explicit
32  gradient-based correction obtained from the linearUpwind scheme. The
33  blending-factor is set to 0.75 linear which optimises the balance between
34  accuracy and stability on a range of LES cases with a range of mesh quality.
35 
36 SourceFiles
37  LUST.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef LUST_H
42 #define LUST_H
43 
44 #include "linearUpwind.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class LUST Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
56 class LUST
57 :
58  public linearUpwind<Type>
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("LUST");
65 
66 
67  // Constructors
68 
69  //- Construct from mesh and Istream
71  (
72  const fvMesh& mesh,
73  Istream& schemeData
74  )
75  :
76  linearUpwind<Type>(mesh, schemeData)
77  {}
78 
79  //- Construct from mesh, faceFlux and Istream
81  (
82  const fvMesh& mesh,
83  const surfaceScalarField& faceFlux,
84  Istream& schemeData
85  )
86  :
87  linearUpwind<Type>(mesh, faceFlux, schemeData)
88  {}
89 
90  //- Disallow default bitwise copy construction
91  LUST(const LUST&) = delete;
92 
93 
94  // Member Functions
95 
96  //- Return the interpolation weighting factors
98  (
100  ) const
101  {
102  return
103  0.75*this->mesh().surfaceInterpolation::weights()
105  }
106 
107  //- Return true if this scheme uses an explicit correction
108  virtual bool corrected() const
109  {
110  return true;
111  }
112 
113  //- Return the explicit correction to the face-interpolate
116  (
118  ) const
119  {
120  return 0.25*linearUpwind<Type>::correction(vf);
121  }
122 
123 
124  // Member Operators
125 
126  //- Disallow default bitwise assignment
127  void operator=(const LUST&) = delete;
128 };
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
LUST(const fvMesh &mesh, Istream &schemeData)
Construct from mesh and Istream.
Definition: LUST.H:70
tmp< surfaceScalarField > weights() const
Return the interpolation weighting factors.
Definition: upwind.H:115
void operator=(const LUST &)=delete
Disallow default bitwise assignment.
TypeName("LUST")
Runtime type information.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
const fvMesh & mesh() const
Return mesh reference.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction(const GeometricField< Type, fvPatchField, volMesh > &vf) const
Return the explicit correction to the face-interpolate.
Definition: LUST.H:115
virtual bool corrected() const
Return true if this scheme uses an explicit correction.
Definition: LUST.H:107
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
linearUpwind interpolation scheme class derived from upwind and returns upwind weighting factors and ...
Definition: linearUpwind.H:52
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the explicit correction to the face-interpolate.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.
LUST: Linear-upwind stabilised transport.
Definition: LUST.H:55