uniformValue.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) 2012-2015 OpenFOAM Foundation
9  Copyright (C) 2018 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::uniformValue
29 
30 Description
31 
32 SourceFiles
33  uniformValue.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef uniformValue_H
38 #define uniformValue_H
39 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class uniformValue Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class uniformValue
52 :
54 {
55 private:
56 
57  // Private data
58 
59  scalar surfaceCellSize_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("uniformValue");
66 
67 
68  // Constructors
69 
70  //- Construct from components
72  (
73  const dictionary& cellSizeFunctionDict,
74  const searchableSurface& surface,
75  const scalar& defaultCellSize
76  );
77 
78 
79  //- Destructor
80  virtual ~uniformValue() = default;
81 
82 
83  // Member Functions
84 
85  virtual scalar interpolate
86  (
87  const point& pt,
88  const label index
89  ) const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
Foam::uniformValue::~uniformValue
virtual ~uniformValue()=default
Destructor.
Foam::uniformValue::uniformValue
uniformValue(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize)
Construct from components.
Foam::searchableSurface
Base class of (analytical or triangulated) surface. Encapsulates all the search routines....
Definition: searchableSurface.H:69
surfaceCellSizeFunction.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::uniformValue::TypeName
TypeName("uniformValue")
Runtime type information.
Foam::Vector< scalar >
Foam::surfaceCellSizeFunction
Abstract base class for specifying target cell sizes.
Definition: surfaceCellSizeFunction.H:53
Foam::uniformValue
Definition: uniformValue.H:50
Foam::uniformValue::interpolate
virtual scalar interpolate(const point &pt, const label index) const