pointFile.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-------------------------------------------------------------------------------
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::pointFile
29
30Description
31 Inserts points at locations specified in a pointFile into the surfaces to
32 be conformed to of the conformalVoronoiMesh
33
34SourceFiles
35 pointFile.C
36
37\*---------------------------------------------------------------------------*/
38
39#ifndef pointFile_H
40#define pointFile_H
41
42#include "fileName.H"
43#include "pointIOField.H"
44#include "Switch.H"
45#include "initialPointsMethod.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52/*---------------------------------------------------------------------------*\
53 Class pointFile Declaration
54\*---------------------------------------------------------------------------*/
56class pointFile
57:
59{
60
61private:
62
63 // Private data
64
65 //- The initial cell spacing
66 fileName pointFileName_;
67
68 //- Check if inserted points are inside or outside
69 Switch insideOutsideCheck_;
70
71 //- Should the initial positions be randomised
72 Switch randomiseInitialGrid_;
73
74 //- Randomise the initial positions by fraction of the initialCellSize_
75 scalar randomPerturbationCoeff_;
76
77
78public:
79
80 //- Runtime type information
81 TypeName("pointFile");
82
83 // Constructors
84
85 //- Construct from components
87 (
88 const dictionary& initialPointsDict,
89 const Time& runTime,
94 );
95
96
97 //- Destructor
98 virtual ~pointFile() = default;
99
100
101 // Member Functions
102
103 //- Return the initial points for the conformalVoronoiMesh
104 virtual List<Vb::Point> initialPoints() const;
105};
106
107
108// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110} // End namespace Foam
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114#endif
115
116// ************************************************************************* //
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:77
Random number generator.
Definition: Random.H:60
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:78
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A class for handling file names.
Definition: fileName.H:76
Abstract base class for generating initial points for a conformalVoronoiMesh.
const conformationSurfaces & geometryToConformTo() const
const cellShapeControl & cellShapeControls() const
const backgroundMeshDecomposition & decomposition() const
Inserts points at locations specified in a pointFile into the surfaces to be conformed to of the conf...
Definition: pointFile.H:58
virtual ~pointFile()=default
Destructor.
pointFile(const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)
Construct from components.
TypeName("pointFile")
Runtime type information.
virtual List< Vb::Point > initialPoints() const
Return the initial points for the conformalVoronoiMesh.
engineTime & runTime
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73