fileControl.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::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  // Private Member Functions
65 
66  //- Disallow default bitwise copy construct
67  fileControl(const fileControl&);
68 
69  //- Disallow default bitwise assignment
70  void operator=(const fileControl&);
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("fileControl");
77 
78 
79  // Constructors
80 
81  //- Construct from dictionary and references to conformalVoronoiMesh and
82  // searchableSurfaces
84  (
85  const Time& runTime,
86  const word& name,
87  const dictionary& controlFunctionDict,
88  const conformationSurfaces& geometryToConformTo,
89  const scalar& defaultCellSize
90  );
91 
92  //- Destructor
93  ~fileControl();
94 
95 
96  // Member Functions
97 
98  // Access
99 
100 
101  // Query
102 
103 // //- Return the cell size at the given location
104 // virtual scalar cellSize(const point& pt) const;
105 //
106 // //- Return the cell alignment at the given location
107 // virtual tensor cellAlignment(const point& pt) const;
108 //
109 // virtual void cellSizeAndAlignment
110 // (
111 // const point& pt,
112 // scalar& size,
113 // tensor& alignment
114 // ) const;
115 
117  virtual label maxPriority() const
118  {
119  return maxPriority_;
120  }
121 
122  // Edit
123 
124  virtual void cellSizeFunctionVertices
125  (
127  DynamicList<scalar>& sizes
128  ) const;
129 
130  virtual void initialVertices
131  (
132  pointField& pts,
133  scalarField& sizes,
134  triadField& alignments
135  ) const;
136 };
137 
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
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
A class for handling file names.
Definition: fileName.H:69
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
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.
virtual void initialVertices(pointField &pts, scalarField &sizes, triadField &alignments) const
virtual void cellSizeFunctionVertices(DynamicList< Foam::point > &pts, DynamicList< scalar > &sizes) const
TypeName("fileControl")
Runtime type information.
virtual label maxPriority() const
Definition: fileControl.H:116
Namespace for OpenFOAM.