motionDiffusivity.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::motionDiffusivity
26 
27 Description
28  Abstract base class for cell-centre mesh motion diffusivity.
29 
30 SourceFiles
31  motionDiffusivity.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef motionDiffusivity_H
36 #define motionDiffusivity_H
37 
38 #include "surfaceFieldsFwd.H"
39 #include "fvMesh.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class motionDiffusivity Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52  // Private Data
53 
54  //- Mesh reference
55  const fvMesh& mesh_;
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("motionDiffusivity");
61 
62 
63  // Declare run-time constructor selection tables
64 
66  (
67  autoPtr,
69  Istream,
70  (
71  const fvMesh& mesh,
72  Istream& mdData
73  ),
74  (mesh, mdData)
75  );
76 
77 
78  // Selectors
79 
80  //- Select null constructed
82  (
83  const fvMesh& mesh,
84  Istream& mdData
85  );
86 
87 
88  // Constructors
89 
90  //- Construct for the given fvMesh
91  motionDiffusivity(const fvMesh& mesh);
92 
93 
94  //- Destructor
95  virtual ~motionDiffusivity();
96 
97 
98  // Member Functions
99 
100  //- Return reference to the mesh
101  const fvMesh& mesh() const
102  {
103  return mesh_;
104  }
105 
106  //- Correct the motion diffusivity
107  virtual void correct()
108  {}
109 
110 
111  // Member Operators
112 
113  //- Return diffusivity field
114  virtual tmp<surfaceScalarField> operator()() const = 0;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
declareRunTimeSelectionTable(autoPtr, motionDiffusivity, Istream,(const fvMesh &mesh, Istream &mdData),(mesh, mdData))
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
TypeName("motionDiffusivity")
Runtime type information.
virtual tmp< surfaceScalarField > operator()() const =0
Return diffusivity field.
motionDiffusivity(const fvMesh &mesh)
Construct for the given fvMesh.
Abstract base class for cell-centre mesh motion diffusivity.
virtual ~motionDiffusivity()
Destructor.
const fvMesh & mesh() const
Return reference to the mesh.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual void correct()
Correct the motion diffusivity.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
static autoPtr< motionDiffusivity > New(const fvMesh &mesh, Istream &mdData)
Select null constructed.
Namespace for OpenFOAM.