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