filmFvPatch.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) 2023 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::filmFvPatch
26 
27 Description
28  Foam::filmFvPatch
29 
30 SourceFiles
31  filmFvPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef filmFvPatch_H
36 #define filmFvPatch_H
37 
38 #include "fvPatch.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class filmFvPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class filmFvPatch
50 :
51  public fvPatch
52 {
53  // Private member data
54 
55  mutable scalarField deltaCoeffs_;
56 
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("film");
62 
63 
64  // Constructors
65 
66  //- Construct from components
67  filmFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm)
68  :
69  fvPatch(patch, bm)
70  {}
71 
72 
73  // Member Functions
74 
75  // Access functions for demand driven data
76 
77  //- Return the face - cell distance coefficient
78  // except for coupled patches for which the cell-centre
79  // to coupled-cell-centre distance coefficient is returned
80  virtual const scalarField& deltaCoeffs() const;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Foam::filmFvPatch.
Definition: filmFvPatch.H:51
filmFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from components.
Definition: filmFvPatch.H:66
TypeName("film")
Runtime type information.
virtual const scalarField & deltaCoeffs() const
Return the face - cell distance coefficient.
Definition: filmFvPatch.C:40
Foam::fvBoundaryMesh.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:140
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:70
Namespace for OpenFOAM.