All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
exponentialDiffusivity.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::exponentialDiffusivity
26 
27 Description
28  Mesh motion diffusivity maipulator which returns the exp(-alpha/D)
29  of the given diffusivity D.
30 
31 SourceFiles
32  exponentialDiffusivity.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef exponentialDiffusivity_H
37 #define exponentialDiffusivity_H
38 
39 #include "motionDiffusivity.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class exponentialDiffusivity Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public motionDiffusivity
53 {
54  // Private Data
55 
56  scalar alpha_;
57  autoPtr<motionDiffusivity> basicDiffusivityPtr_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("exponential");
64 
65 
66  // Constructors
67 
68  //- Construct for the given fvMesh and data Istream
69  exponentialDiffusivity(const fvMesh& mesh, Istream& mdData);
70 
71  //- Disallow default bitwise copy construction
73 
74 
75  //- Destructor
76  virtual ~exponentialDiffusivity();
77 
78 
79  // Member Functions
80 
81  //- Correct the motion diffusivity
82  virtual void correct();
83 
84 
85  // Member Operators
86 
87  //- Disallow default bitwise assignment
88  void operator=(const exponentialDiffusivity&) = delete;
89 
90  //- Return diffusivity field
91  virtual tmp<surfaceScalarField> operator()() const;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
TypeName("exponential")
Runtime type information.
virtual void correct()
Correct the motion diffusivity.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
void operator=(const exponentialDiffusivity &)=delete
Disallow default bitwise assignment.
exponentialDiffusivity(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.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Mesh motion diffusivity maipulator which returns the exp(-alpha/D) of the given diffusivity D...
virtual ~exponentialDiffusivity()
Destructor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.