exponentialDiffusivity.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2012 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::exponentialDiffusivity
28 
29 Description
30  Mesh motion diffusivity maipulator which returns the exp(-alpha/D)
31  of the given diffusivity D.
32 
33 SourceFiles
34  exponentialDiffusivity.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef exponentialDiffusivity_H
39 #define exponentialDiffusivity_H
40 
41 #include "motionDiffusivity.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class exponentialDiffusivity Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public motionDiffusivity
55 {
56  // Private data
57 
58  scalar alpha_;
59  autoPtr<motionDiffusivity> basicDiffusivityPtr_;
60 
61 
62  // Private Member Functions
63 
64  //- No copy construct
66 
67  //- No copy assignment
68  void operator=(const exponentialDiffusivity&) = delete;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("exponential");
75 
76 
77  // Constructors
78 
79  //- Construct for the given fvMesh and data Istream
80  exponentialDiffusivity(const fvMesh& mesh, Istream& mdData);
81 
82 
83  //- Destructor
84  virtual ~exponentialDiffusivity();
85 
86 
87  // Member Functions
88 
89  //- Return diffusivity field
90  virtual tmp<surfaceScalarField> operator()() const;
91 
92  //- Correct the motion diffusivity
93  virtual void correct();
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
Foam::exponentialDiffusivity::~exponentialDiffusivity
virtual ~exponentialDiffusivity()
Destructor.
Definition: exponentialDiffusivity.C:63
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::motionDiffusivity
Abstract base class for cell-centre mesh motion diffusivity.
Definition: motionDiffusivity.H:51
Foam::motionDiffusivity::mesh
const fvMesh & mesh() const
Return reference to the mesh.
Definition: motionDiffusivity.H:102
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::exponentialDiffusivity::correct
virtual void correct()
Correct the motion diffusivity.
Definition: exponentialDiffusivity.C:76
Foam::exponentialDiffusivity
Mesh motion diffusivity maipulator which returns the exp(-alpha/D) of the given diffusivity D.
Definition: exponentialDiffusivity.H:51
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
motionDiffusivity.H
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::exponentialDiffusivity::operator()
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
Definition: exponentialDiffusivity.C:70
Foam::exponentialDiffusivity::TypeName
TypeName("exponential")
Runtime type information.