cellAspectRatioControl.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-2020 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::cellAspectRatioControl
26 
27 Description
28 
29 SourceFiles
30  cellAspectRatioControl.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef cellAspectRatioControl_H
35 #define cellAspectRatioControl_H
36 
37 #include "dictionary.H"
38 #include "vector.H"
39 #include "scalar.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 
47 /*---------------------------------------------------------------------------*\
48  Class cellAspectRatioControl Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private Data
54 
55  const dictionary aspectRatioDict_;
56 
57  const scalar aspectRatio_;
58 
59  vector aspectRatioDirection_;
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from dictionary
67  cellAspectRatioControl(const dictionary& motionDict);
68 
69  //- Disallow default bitwise copy construction
71 
72 
73  //- Destructor
74  virtual ~cellAspectRatioControl();
75 
76 
77  // Member Functions
78 
79  // Query
80 
82  (
83  vector& alignmentDir,
84  scalar& targetFaceArea,
85  scalar& targetCellSize
86  ) const;
87 
89  (
90  const vector& alignmentDir,
91  const scalar targetCellSize,
92  const scalar rABMag,
93  vector& delta
94  ) const;
95 
96 
97  // Member Operators
98 
99  //- Disallow default bitwise assignment
100  void operator=(const cellAspectRatioControl&) = delete;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
scalar delta
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual ~cellAspectRatioControl()
Destructor.
void operator=(const cellAspectRatioControl &)=delete
Disallow default bitwise assignment.
void updateCellSizeAndFaceArea(vector &alignmentDir, scalar &targetFaceArea, scalar &targetCellSize) const
cellAspectRatioControl(const dictionary &motionDict)
Construct from dictionary.
void updateDeltaVector(const vector &alignmentDir, const scalar targetCellSize, const scalar rABMag, vector &delta) const
Namespace for OpenFOAM.