blendedSchemeBase.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) 2013 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::blendedSchemeBase
26 
27 Description
28  Base class for blended schemes to provide access to the blending factor
29  surface field
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef blendedSchemeBase_H
34 #define blendedSchemeBase_H
35 
36 #include "className.H"
37 #include "tmp.H"
38 #include "surfaceFieldsFwd.H"
39 #include "volFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 TemplateName(blendedSchemeBase);
47 
48 /*---------------------------------------------------------------------------*\
49  Class blendedSchemeBase Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public blendedSchemeBaseName
56 {
57 
58 public:
59 
60  //- Constructor
62  {}
63 
64  //- Destructor
65  virtual ~blendedSchemeBase()
66  {}
67 
68 
69  // Memeber Functions
70 
71  //- Return the face-based blending factor
73  (
75  ) const = 0;
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
TemplateName(blendedSchemeBase)
virtual ~blendedSchemeBase()
Destructor.
Generic GeometricField class.
blendedSchemeBase()
Constructor.
virtual tmp< surfaceScalarField > blendingFactor(const GeometricField< Type, fvPatchField, volMesh > &vf) const =0
Return the face-based blending factor.
Base class for blended schemes to provide access to the blending factor surface field.
Macro definitions for declaring ClassName(), NamespaceName(), etc.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.