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-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::exponentialDiffusivity
28
29Description
30 Mesh motion diffusivity maipulator which returns the exp(-alpha/D)
31 of the given diffusivity D.
32
33SourceFiles
34 exponentialDiffusivity.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef exponentialDiffusivity_H
39#define exponentialDiffusivity_H
40
41#include "motionDiffusivity.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Class exponentialDiffusivity Declaration
50\*---------------------------------------------------------------------------*/
53:
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
71public:
72
73 //- Runtime type information
74 TypeName("exponential");
75
76
77 // Constructors
78
79 //- Construct for the given fvMesh and data Istream
81
82
83 //- Destructor
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// ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
Mesh motion diffusivity maipulator which returns the exp(-alpha/D) of the given diffusivity D.
virtual void correct()
Correct the motion diffusivity.
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
TypeName("exponential")
Runtime type information.
virtual ~exponentialDiffusivity()
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Abstract base class for cell-centre mesh motion diffusivity.
const fvMesh & mesh() const
Return reference to the mesh.
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73