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