uniform.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) 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::uniform
29
30Description
31
32SourceFiles
33 uniform.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef uniform_H
38#define uniform_H
39
40#include "cellSizeFunction.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46
47/*---------------------------------------------------------------------------*\
48 Class uniform Declaration
49\*---------------------------------------------------------------------------*/
51class uniform
52:
53 public cellSizeFunction
54{
55
56private:
57
58 // Private data
59
60
61public:
62
63 //- Runtime type information
64 TypeName("uniform");
65
66 // Constructors
67
68 //- Construct from components
70 (
71 const dictionary& initialPointsDict,
72 const searchableSurface& surface,
73 const scalar& defaultCellSize,
74 const labelList regionIndices
75 );
76
77
78 //- Destructor
79 virtual ~uniform() = default;
80
81
82 // Member Functions
84 virtual bool sizeLocations
85 (
86 const pointIndexHit& hitPt,
87 const vector& n,
88 pointField& shapePts,
89 scalarField& shapeSizes
90 ) const;
91
92 //- Modify scalar argument to the cell size specified by function.
93 // Return a boolean specifying if the function was used, i.e. false if
94 // the point was not in range of the surface for a spatially varying
95 // size.
96 virtual bool cellSize
97 (
98 const point& pt,
99 scalar& size
100 ) const;
101
102 //- Adapt local cell size. Return true if anything changed.
103 virtual bool setCellSize
104 (
105 const pointField& pts
106 );
107};
108
109
110// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112} // End namespace Foam
113
114// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116#endif
117
118// ************************************************************************* //
label n
This class describes the interaction of (usually) a face and a point. It carries the info of a succes...
Definition: PointIndexHit.H:66
Abstract base class for specifying target cell sizes.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Base class of (analytical or triangulated) surface. Encapsulates all the search routines....
virtual ~uniform()=default
Destructor.
virtual bool sizeLocations(const pointIndexHit &hitPt, const vector &n, pointField &shapePts, scalarField &shapeSizes) const
virtual bool cellSize(const point &pt, scalar &size) const
Modify scalar argument to the cell size specified by function.
TypeName("uniform")
Runtime type information.
uniform(const dictionary &initialPointsDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)
Construct from components.
virtual bool setCellSize(const pointField &pts)
Adapt local cell size. Return true if anything changed.
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73