updateableSnGrad.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::updateableSnGrad
28 
29 Description
30  Helper class to fix pressure flux
31  for pressure-related boundary conditions.
32 
33 See also
34  - Foam::prghPermeableAlphaTotalPressureFvPatchScalarField
35 
36 SourceFiles
37  updateableSnGrad.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef updateableSnGrad_H
42 #define updateableSnGrad_H
43 
44 #include "primitiveFieldsFwd.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace updateablePatchTypes
51 {
52 /*---------------------------------------------------------------------------*\
53  Class updateableSnGrad declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class updateableSnGrad
57 {
58 public:
59 
60  // Public Member Functions
61 
62  //- Constructor
63  updateableSnGrad() = default;
64 
65  //- Destructor
66  virtual ~updateableSnGrad() = default;
67 
68 
69  // Member Functions
70 
71  //- Update snGrad
72  virtual void updateSnGrad(const scalarField& snGradp) = 0;
73 };
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 } // End namespace updateablePatchTypes
79 } // End namespace Foam
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 
84 #endif
85 
86 // ************************************************************************* //
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
Foam::updateablePatchTypes::updateableSnGrad
Definition: updateableSnGrad.H:55
Foam::updateablePatchTypes::updateableSnGrad::~updateableSnGrad
virtual ~updateableSnGrad()=default
Destructor.
Foam::Field< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::updateablePatchTypes::updateableSnGrad::updateableSnGrad
updateableSnGrad()=default
Constructor.
Foam::updateablePatchTypes::updateableSnGrad::updateSnGrad
virtual void updateSnGrad(const scalarField &snGradp)=0
Update snGrad.