fileControl.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) 2012-2019 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::fileControl
26 
27 Description
28 
29 SourceFiles
30  fileControl.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef fileControl_H
35 #define fileControl_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 
45 /*---------------------------------------------------------------------------*\
46  Class fileControl Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class fileControl
50 :
52 {
53  // Private Data
54 
55  const fileName pointsFile_;
56 
57  const fileName sizesFile_;
58 
59  const fileName alignmentsFile_;
60 
61  label maxPriority_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("fileControl");
68 
69 
70  // Constructors
71 
72  //- Construct from dictionary and references to conformalVoronoiMesh and
73  // searchableSurfaces
75  (
76  const Time& runTime,
77  const word& name,
78  const dictionary& controlFunctionDict,
79  const conformationSurfaces& geometryToConformTo,
80  const scalar& defaultCellSize
81  );
82 
83  //- Disallow default bitwise copy construction
84  fileControl(const fileControl&) = delete;
85 
86 
87  //- Destructor
88  ~fileControl();
89 
90 
91  // Member Functions
92 
93  // Access
94 
95  virtual label maxPriority() const
96  {
97  return maxPriority_;
98  }
99 
100 
101  // Edit
102 
103  virtual void cellSizeFunctionVertices
104  (
106  DynamicList<scalar>& sizes
107  ) const;
108 
109  virtual void initialVertices
110  (
111  pointField& pts,
112  scalarField& sizes,
113  triadField& alignments
114  ) const;
115 
116 
117  // Member Operators
118 
119  //- Disallow default bitwise assignment
120  void operator=(const fileControl&) = delete;
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
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
virtual void initialVertices(pointField &pts, scalarField &sizes, triadField &alignments) const
A class for handling file names.
Definition: fileName.H:79
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
engineTime & runTime
virtual label maxPriority() const
Definition: fileControl.H:94
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual void cellSizeFunctionVertices(DynamicList< Foam::point > &pts, DynamicList< scalar > &sizes) const
void operator=(const fileControl &)=delete
Disallow default bitwise assignment.
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects...
Definition: DynamicList.H:56
A class for handling words, derived from string.
Definition: word.H:59
~fileControl()
Destructor.
fileControl(const Time &runTime, const word &name, const dictionary &controlFunctionDict, const conformationSurfaces &geometryToConformTo, const scalar &defaultCellSize)
Construct from dictionary and references to conformalVoronoiMesh and.
TypeName("fileControl")
Runtime type information.
Namespace for OpenFOAM.