highAspectRatioFvGeometryScheme.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) 2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::highAspectRatioFvGeometryScheme
28 
29 Description
30  Geometry calculation scheme with automatic stabilisation for high-aspect
31  ratio cells.
32 
33 SourceFiles
34  highAspectRatioFvGeometryScheme.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef highAspectRatioFvGeometryScheme_H
39 #define highAspectRatioFvGeometryScheme_H
40 
41 #include "basicFvGeometryScheme.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class primitiveMesh;
49 class polyMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class highAspectRatioFvGeometryScheme Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
58 {
59 protected:
60 
61  const scalar minAspect_;
62 
63  const scalar maxAspect_;
64 
65 
66  // Protected Member Functions
67 
68  //- Calculate cell and face weight. Is 0 for cell < minAspect, 1 for
69  // cell > maxAspect
71  (
72  scalarField& cellWeight,
73  scalarField& faceWeight
74  ) const;
75 
76  //- Helper : calculate (weighted) average face and cell centres
77  static void makeAverageCentres
78  (
79  const polyMesh& mesh,
80  const pointField& points,
81  const pointField& faceAreas,
82  const scalarField& magFaceAreas,
83  pointField& faceCentres,
84  pointField& cellCentres
85  );
86 
87 
88 private:
89 
90  // Private Member Functions
91 
92  //- No copy construct
94  (
96  ) = delete;
97 
98  //- No copy assignment
99  void operator=(const highAspectRatioFvGeometryScheme&) = delete;
100 
101 
102 public:
103 
104  //- Runtime type information
105  TypeName("highAspectRatio");
106 
107 
108  // Constructors
109 
110  //- Construct from mesh
112  (
113  const fvMesh& mesh,
114  const dictionary& dict
115  );
116 
117 
118  //- Destructor
119  virtual ~highAspectRatioFvGeometryScheme() = default;
120 
121 
122  // Member Functions
123 
124  //- Do what is necessary if the mesh has moved
125  virtual void movePoints();
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
Foam::basicFvGeometryScheme
Default geometry calculation scheme. Slight stabilisation for bad meshes.
Definition: basicFvGeometryScheme.H:50
Foam::highAspectRatioFvGeometryScheme::movePoints
virtual void movePoints()
Do what is necessary if the mesh has moved.
Definition: highAspectRatioFvGeometryScheme.C:390
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::fvGeometryScheme::mesh
const fvMesh & mesh() const
Return mesh reference.
Definition: fvGeometryScheme.H:123
Foam::Field< scalar >
Foam::highAspectRatioFvGeometryScheme::calcAspectRatioWeights
void calcAspectRatioWeights(scalarField &cellWeight, scalarField &faceWeight) const
Calculate cell and face weight. Is 0 for cell < minAspect, 1 for.
Definition: highAspectRatioFvGeometryScheme.C:163
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::highAspectRatioFvGeometryScheme::makeAverageCentres
static void makeAverageCentres(const polyMesh &mesh, const pointField &points, const pointField &faceAreas, const scalarField &magFaceAreas, pointField &faceCentres, pointField &cellCentres)
Helper : calculate (weighted) average face and cell centres.
Definition: highAspectRatioFvGeometryScheme.C:235
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::highAspectRatioFvGeometryScheme::TypeName
TypeName("highAspectRatio")
Runtime type information.
Foam::highAspectRatioFvGeometryScheme::~highAspectRatioFvGeometryScheme
virtual ~highAspectRatioFvGeometryScheme()=default
Destructor.
Foam::highAspectRatioFvGeometryScheme::minAspect_
const scalar minAspect_
Definition: highAspectRatioFvGeometryScheme.H:60
Foam::highAspectRatioFvGeometryScheme
Geometry calculation scheme with automatic stabilisation for high-aspect ratio cells.
Definition: highAspectRatioFvGeometryScheme.H:54
Foam::highAspectRatioFvGeometryScheme::maxAspect_
const scalar maxAspect_
Definition: highAspectRatioFvGeometryScheme.H:62
basicFvGeometryScheme.H