quadraticDiffusivity.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::quadraticDiffusivity
28 
29 Description
30  Mesh motion diffusivity maipulator which returns the sqr of the given
31  diffusivity.
32 
33 SourceFiles
34  quadraticDiffusivity.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef quadraticDiffusivity_H
39 #define quadraticDiffusivity_H
40 
41 #include "motionDiffusivity.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class quadraticDiffusivity Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public motionDiffusivity
55 {
56  // Private data
57 
58  autoPtr<motionDiffusivity> basicDiffusivityPtr_;
59 
60 
61  // Private Member Functions
62 
63  //- No copy construct
65 
66  //- No copy assignment
67  void operator=(const quadraticDiffusivity&) = delete;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("quadratic");
74 
75 
76  // Constructors
77 
78  //- Construct for the given fvMesh and data Istream
79  quadraticDiffusivity(const fvMesh& mesh, Istream& mdData);
80 
81 
82  //- Destructor
83  virtual ~quadraticDiffusivity();
84 
85 
86  // Member Functions
87 
88  //- Return diffusivity field
89  virtual tmp<surfaceScalarField> operator()() const;
90 
91  //- Correct the motion diffusivity
92  virtual void correct();
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
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::quadraticDiffusivity::correct
virtual void correct()
Correct the motion diffusivity.
Definition: quadraticDiffusivity.C:75
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::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::quadraticDiffusivity
Mesh motion diffusivity maipulator which returns the sqr of the given diffusivity.
Definition: quadraticDiffusivity.H:51
Foam::quadraticDiffusivity::TypeName
TypeName("quadratic")
Runtime type information.
Foam::quadraticDiffusivity::~quadraticDiffusivity
virtual ~quadraticDiffusivity()
Destructor.
Definition: quadraticDiffusivity.C:62
Foam::quadraticDiffusivity::operator()
virtual tmp< surfaceScalarField > operator()() const
Return diffusivity field.
Definition: quadraticDiffusivity.C:69