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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2013 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::blendedSchemeBase
29
30Description
31 Base class for blended schemes to provide access to the blending factor
32 surface field
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef blendedSchemeBase_H
37#define blendedSchemeBase_H
38
39#include "className.H"
40#include "tmp.H"
41#include "surfaceFieldsFwd.H"
42#include "volFieldsFwd.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
50
51/*---------------------------------------------------------------------------*\
52 Class blendedSchemeBase Declaration
53\*---------------------------------------------------------------------------*/
54
55template<class Type>
57:
58 public blendedSchemeBaseName
59{
60
61public:
62
63 //- Constructor
65 {}
66
67 //- Destructor
68 virtual ~blendedSchemeBase() = default;
69
70
71 // Member Functions
72
73 //- Return the face-based blending factor
75 (
77 ) const = 0;
78};
79
80
81// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82
83} // End namespace Foam
84
85// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86
87#endif
88
89// ************************************************************************* //
Generic GeometricField class.
Base class for blended schemes to provide access to the blending factor surface field.
virtual ~blendedSchemeBase()=default
Destructor.
virtual tmp< surfaceScalarField > blendingFactor(const GeometricField< Type, fvPatchField, volMesh > &vf) const =0
Return the face-based blending factor.
blendedSchemeBase()
Constructor.
A class for managing temporary objects.
Definition: tmp.H:65
Macro definitions for declaring ClassName(), NamespaceName(), etc.
#define TemplateName(TemplateNameString)
Add typeName information from argument TypeNameString to a.
Definition: className.H:79
Namespace for OpenFOAM.