faceMDLimitedGrad.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::fv::faceMDLimitedGrad
26 
27 Description
28  faceMDLimitedGrad gradient scheme applied to a runTime selected
29  base gradient scheme.
30 
31  The scalar limiter based on limiting the extrapolated face values
32  between the face-neighbour cell values and is applied to the gradient
33  in each face direction separately.
34 
35 SourceFiles
36  faceMDLimitedGrad.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef faceMDLimitedGrad_H
41 #define faceMDLimitedGrad_H
42 
43 #include "gradScheme.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 namespace fv
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class faceMDLimitedGrad Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 template<class Type>
61 :
62  public fv::gradScheme<Type>
63 {
64  // Private Data
65 
66  tmp<fv::gradScheme<Type>> basicGradScheme_;
67 
68  //- Limiter coefficient
69  const scalar k_;
70 
71 
72  // Private Member Functions
73 
74  inline void limitFace
75  (
76  scalar& limiter,
77  const scalar maxDelta,
78  const scalar minDelta,
79  const scalar extrapolate
80  ) const;
81 
82 
83  //- Disallow default bitwise copy construction
84  faceMDLimitedGrad(const faceMDLimitedGrad&) = delete;
85 
86  //- Disallow default bitwise assignment
87  void operator=(const faceMDLimitedGrad&) = delete;
88 
89 
90 public:
91 
92  //- RunTime type information
93  TypeName("faceMDLimited");
94 
95 
96  // Constructors
97 
98  //- Construct from mesh and schemeData
99  faceMDLimitedGrad(const fvMesh& mesh, Istream& schemeData)
100  :
101  gradScheme<Type>(mesh),
102  basicGradScheme_(fv::gradScheme<Type>::New(mesh, schemeData)),
103  k_(readScalar(schemeData))
104  {
105  if (k_ < 0 || k_ > 1)
106  {
108  (
109  schemeData
110  ) << "coefficient = " << k_
111  << " should be >= 0 and <= 1"
112  << exit(FatalIOError);
113  }
114  }
115 
116 
117  // Member Functions
118 
119  //- Return the gradient of the given field to the gradScheme::grad
120  // for optional caching
121  virtual tmp
122  <
125  > calcGrad
126  (
128  const word& name
129  ) const;
130 };
131 
132 
133 // * * * * * * * * Template Member Function Specialisations * * * * * * * * //
134 
135 template<>
137 (
138  const volScalarField& vsf,
139  const word& name
140 ) const;
141 
142 
143 template<>
145 (
146  const volVectorField& vsf,
147  const word& name
148 ) const;
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace fv
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
TypeName("faceMDLimited")
RunTime type information.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
typeOfRank< typename pTraits< arg1 >::cmptType, direction(pTraits< arg1 >::rank)+direction(pTraits< arg2 >::rank) >::type type
Definition: products.H:90
Generic GeometricField class.
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:53
A class for handling words, derived from string.
Definition: word.H:59
labelList fv(nPoints)
void limiter(surfaceScalarField &lambda, const RdeltaTType &rDeltaT, const RhoType &rho, const volScalarField &psi, const surfaceScalarField &phiBD, const surfaceScalarField &phiCorr, const SpType &Sp, const SuType &Su, const PsiMaxType &psiMax, const PsiMinType &psiMin)
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if successful.
Definition: doubleScalar.H:75
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Abstract base class for gradient schemes.
Definition: gradScheme.H:60
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:318
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
static tmp< gradScheme< Type > > New(const fvMesh &mesh, Istream &schemeData)
Return a pointer to a new gradScheme created on freestore.
Definition: gradScheme.C:34
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad(const GeometricField< Type, fvPatchField, volMesh > &vsf, const word &name) const
Return the gradient of the given field to the gradScheme::grad.
faceMDLimitedGrad gradient scheme applied to a runTime selected base gradient scheme.
A class for managing temporary objects.
Definition: PtrList.H:53
const fvMesh & mesh() const
Return mesh reference.
Definition: gradScheme.H:122
Namespace for OpenFOAM.
IOerror FatalIOError