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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::fileControl
28
29Description
30
31SourceFiles
32 fileControl.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef fileControl_H
37#define fileControl_H
38
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45
46
47/*---------------------------------------------------------------------------*\
48 Class fileControl Declaration
49\*---------------------------------------------------------------------------*/
51class fileControl
52:
54{
55 // Private data
56
57 const fileName pointsFile_;
58
59 const fileName sizesFile_;
60
61 const fileName alignmentsFile_;
62
63 label maxPriority_;
64
65
66 // Private Member Functions
67
68 //- No copy construct
69 fileControl(const fileControl&) = delete;
70
71 //- No copy assignment
72 void operator=(const fileControl&) = delete;
73
74
75public:
76
77 //- Runtime type information
78 TypeName("fileControl");
79
80
81 // Constructors
82
83 //- Construct from dictionary and references to conformalVoronoiMesh and
84 // searchableSurfaces
86 (
87 const Time& runTime,
88 const word& name,
89 const dictionary& controlFunctionDict,
90 const conformationSurfaces& geometryToConformTo,
91 const scalar& defaultCellSize
92 );
93
94 //- Destructor
95 ~fileControl() = default;
96
97
98 // Member Functions
99
100 // Access
101
102
103 // Query
104
105// //- Return the cell size at the given location
106// virtual scalar cellSize(const point& pt) const;
107//
108// //- Return the cell alignment at the given location
109// virtual tensor cellAlignment(const point& pt) const;
110//
111// virtual void cellSizeAndAlignment
112// (
113// const point& pt,
114// scalar& size,
115// tensor& alignment
116// ) const;
117
119 virtual label maxPriority() const
120 {
121 return maxPriority_;
122 }
123
124 // Edit
126 virtual void cellSizeFunctionVertices
127 (
130 ) const;
132 virtual void initialVertices
133 (
134 pointField& pts,
135 scalarField& sizes,
136 triadField& alignments
137 ) const;
138};
139
140
141// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142
143} // End namespace Foam
144
145// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146
147#endif
148
149// ************************************************************************* //
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Definition: DynamicList.H:72
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
TypeName("fileControl")
Runtime type information.
virtual label maxPriority() const
Definition: fileControl.H:118
virtual void cellSizeFunctionVertices(DynamicList< Foam::point > &pts, DynamicList< scalar > &sizes) const
virtual void initialVertices(pointField &pts, scalarField &sizes, triadField &alignments) const
~fileControl()=default
Destructor.
A class for handling file names.
Definition: fileName.H:76
A class for handling words, derived from Foam::string.
Definition: word.H:68
engineTime & runTime
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73