FreeFOAM The Cross-Platform CFD Toolkit
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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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 
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  // Private Member Functions
61 
62  //- Disallow default bitwise copy construct
64 
65  //- Disallow default bitwise assignment
66  void operator=(const exponentialDiffusivity&);
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("exponential");
73 
74 
75  // Constructors
76 
77  //- Construct for the given fvMotionSolver and data Istream
79  (
80  const fvMotionSolver& mSolver,
81  Istream& mdData
82  );
83 
84 
85  // Destructor
86 
87  virtual ~exponentialDiffusivity();
88 
89 
90  // Member Functions
91 
92  //- Return diffusivity field
93  virtual tmp<surfaceScalarField> operator()() const;
94 
95  //- Correct the motion diffusivity
96  virtual void correct();
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************ vim: set sw=4 sts=4 et: ************************ //