sphericalRadial.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) 2013-2023 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::extrudeModels::sphericalRadial
26 
27 Description
28  Extrudes by transforming points in the spherical radial direction
29 
30  Generates layers at radii specified by a Foam::Function1
31  of the layer index.
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef sphericalRadial_H
36 #define sphericalRadial_H
37 
38 #include "extrudeModel.H"
39 #include "Function1.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace extrudeModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class sphericalRadial Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class sphericalRadial
53 :
54  public extrudeModel
55 {
56  // Private Data
57 
58  //- Radial distribution of layers
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("sphericalRadial");
66 
67  // Constructors
68 
69  //- Construct from dictionary
71 
72 
73  //-Destructor
74  virtual ~sphericalRadial();
75 
76 
77  // Member Operators
78 
79  //- Return the new point corresponding to the surfacePoint
80  // on the specified layer.
81  // The surfaceNormal is not used.
82  point operator()
83  (
84  const point& surfacePoint,
85  const vector& surfaceNormal,
86  const label layer
87  ) const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace extrudeModels
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Top level extrusion model class.
Definition: extrudeModel.H:52
Extrudes by transforming points in the spherical radial direction.
sphericalRadial(const dictionary &dict)
Construct from dictionary.
TypeName("sphericalRadial")
Runtime type information.
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
dictionary dict