bodyCentredCubic.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 | Copyright (C) 2012-2015 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::bodyCentredCubic
26 
27 Description
28  Generate a BCC lattice of points inside the surfaces to be
29  conformed to of the conformalVoronoiMesh
30 
31 SourceFiles
32  bodyCentredCubic.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef bodyCentredCubic_H
37 #define bodyCentredCubic_H
38 
39 #include "initialPointsMethod.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class bodyCentredCubic Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class bodyCentredCubic
51 :
52  public initialPointsMethod
53 {
54 
55 private:
56 
57  // Private data
58 
59  //- The initial cell spacing
60  scalar initialCellSize_;
61 
62  //- Should the initial positions be randomised
63  Switch randomiseInitialGrid_;
64 
65  //- Randomise the initial positions by fraction of the initialCellSize_
66  scalar randomPerturbationCoeff_;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("bodyCentredCubic");
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  const dictionary& initialPointsDict,
80  const Time& runTime,
81  Random& rndGen,
85  );
86 
87 
88  //- Destructor
89  virtual ~bodyCentredCubic()
90  {}
91 
92 
93  // Member Functions
94 
95  //- Return the initial points for the conformalVoronoiMesh
96  virtual List<Vb::Point> initialPoints() const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
const cellShapeControl & cellShapeControls() const
virtual List< Vb::Point > initialPoints() const
Return the initial points for the conformalVoronoiMesh.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none.
Definition: Switch.H:60
Generate a BCC lattice of points inside the surfaces to be conformed to of the conformalVoronoiMesh.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual ~bodyCentredCubic()
Destructor.
bodyCentredCubic(const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)
Construct from components.
TypeName("bodyCentredCubic")
Runtime type information.
Abstract base class for generating initial points for a conformalVoronoiMesh.
Simple random number generator.
Definition: Random.H:49
const conformationSurfaces & geometryToConformTo() const
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
const backgroundMeshDecomposition & decomposition() const
Namespace for OpenFOAM.