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