rayShooting.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-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::rayShooting
29 
30 Description
31 
32 SourceFiles
33  rayShooting.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef rayShooting_H
38 #define rayShooting_H
39 
40 #include "initialPointsMethod.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class rayShooting Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class rayShooting
52 :
53  public initialPointsMethod
54 {
55 private:
56 
57  // Private data
58 
59  //- Should the initial positions be randomised
60  Switch randomiseInitialGrid_;
61 
62  //- Randomise the initial positions by fraction of the initialCellSize_
63  scalar randomPerturbationCoeff_;
64 
65 
66  // Private Member Functions
67 
68  void splitLine
69  (
70  const line<point, point>& l,
71  const scalar& pert,
73  ) const;
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("rayShooting");
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const dictionary& initialPointsDict,
87  const Time& runTime,
88  Random& rndGen,
92  );
93 
94 
95  //- Destructor
96  virtual ~rayShooting() = default;
97 
98 
99  // Member Functions
100 
101  //- Return the initial points for the conformalVoronoiMesh
102  virtual List<Vb::Point> initialPoints() const;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Foam::Random
Random number generator.
Definition: Random.H:59
Foam::Switch
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:77
Foam::initialPointsMethod::cellShapeControls
const cellShapeControl & cellShapeControls() const
Definition: initialPointsMethod.H:181
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::initialPointsMethod::decomposition
const backgroundMeshDecomposition & decomposition() const
Definition: initialPointsMethod.H:186
Foam::DynamicList
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Definition: DynamicList.H:55
Foam::rayShooting::TypeName
TypeName("rayShooting")
Runtime type information.
Foam::conformationSurfaces
Definition: conformationSurfaces.H:55
Foam::rayShooting::initialPoints
virtual List< Vb::Point > initialPoints() const
Return the initial points for the conformalVoronoiMesh.
Foam::initialPointsMethod::geometryToConformTo
const conformationSurfaces & geometryToConformTo() const
Definition: initialPointsMethod.H:176
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::cellShapeControl
Definition: cellShapeControl.H:64
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::initialPointsMethod
Abstract base class for generating initial points for a conformalVoronoiMesh.
Definition: initialPointsMethod.H:56
Foam::rayShooting::rayShooting
rayShooting(const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)
Construct from components.
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
initialPointsMethod.H
Foam::initialPointsMethod::rndGen
Random & rndGen() const
Definition: initialPointsMethod.H:171
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:63
Foam::rayShooting::~rayShooting
virtual ~rayShooting()=default
Destructor.
Foam::line
A line primitive.
Definition: line.H:53
Foam::rayShooting
Definition: rayShooting.H:50