inverseFaceDistanceDiffusivity.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::inverseFaceDistanceDiffusivity
26 
27 Description
28  Inverse distance to the given patches motion diffusivity.
29 
30 SourceFiles
31  inverseFaceDistanceDiffusivity.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef inverseFaceDistanceDiffusivity_H
36 #define inverseFaceDistanceDiffusivity_H
37 
38 #include "motionDiffusivity.H"
39 #include "wordReList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class inverseFaceDistanceDiffusivity Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public motionDiffusivity
53 {
54  // Private Data
55 
56  //- Patches selected to base the distance on
57  wordReList patchNames_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("inverseFaceDistance");
64 
65 
66  // Constructors
67 
68  //- Construct for the given fvMesh and data Istream
70 
71  //- Disallow default bitwise copy construction
73  (
75  ) = delete;
76 
77 
78  //- Destructor
80 
81 
82  // Member Operators
83 
84  //- Disallow default bitwise assignment
85  void operator=(const inverseFaceDistanceDiffusivity&) = delete;
86 
87  //- Return diffusivity field
88  virtual tmp<surfaceScalarField> operator()() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
inverseFaceDistanceDiffusivity(const fvMesh &mesh, Istream &mdData)
Construct for the given fvMesh and data Istream.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
Inverse distance to the given patches motion diffusivity.
void operator=(const inverseFaceDistanceDiffusivity &)=delete
Disallow default bitwise assignment.
Abstract base class for cell-centre mesh motion diffusivity.
const fvMesh & mesh() const
Return reference to the mesh.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("inverseFaceDistance")
Runtime type information.
Namespace for OpenFOAM.