All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fileDiffusivity.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-2019 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::fileDiffusivity
26 
27 Description
28  Motion diffusivity read from given file name.
29 
30 SourceFiles
31  fileDiffusivity.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fileDiffusivity_H
36 #define fileDiffusivity_H
37 
38 #include "motionDiffusivity.H"
39 #include "surfaceFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class fileDiffusivity Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class fileDiffusivity
51 :
52  public motionDiffusivity
53 {
54 protected:
55 
56  // Protected data
57 
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("file");
65 
66 
67  // Constructors
68 
69  //- Construct for the given fvMesh and data Istream
70  fileDiffusivity(const fvMesh& mesh, Istream& mdData);
71 
72  //- Disallow default bitwise copy construction
73  fileDiffusivity(const fileDiffusivity&) = delete;
74 
75 
76  //- Destructor
77  virtual ~fileDiffusivity();
78 
79 
80  // Member Functions
81 
82  //- Do not correct the motion diffusivity
83  virtual void correct()
84  {}
85 
86 
87  // Member Operators
88 
89  //- Disallow default bitwise assignment
90  void operator=(const fileDiffusivity&) = delete;
91 
92  //- Return diffusivity field
93  virtual tmp<surfaceScalarField> operator()() const
94  {
95  return faceDiffusivity_;
96  }
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
Foam::surfaceFields.
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
Motion diffusivity read from given file name.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual void correct()
Do not correct the motion diffusivity.
fileDiffusivity(const fvMesh &mesh, Istream &mdData)
Construct for the given fvMesh and data Istream.
TypeName("file")
Runtime type information.
void operator=(const fileDiffusivity &)=delete
Disallow default bitwise assignment.
Abstract base class for cell-centre mesh motion diffusivity.
const fvMesh & mesh() const
Return reference to the mesh.
virtual ~fileDiffusivity()
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
surfaceScalarField faceDiffusivity_
Namespace for OpenFOAM.