polyMeshTools.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-2013 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 Namespace
25  Foam::polyMeshTools
26 
27 Description
28  Collection of static functions operating on polyMesh (mainly checks) so
29  that need access to patch information.
30 
31 SourceFiles
32  polyMeshTools.C
33 
34 \*---------------------------------------------------------------------------*/
35 #ifndef polyMeshTools_H
36 #define polyMeshTools_H
37 
38 #include "polyMesh.H"
39 #include "primitiveMeshTools.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Namespace polyMeshTools Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public primitiveMeshTools
53 {
54 
55 public:
56 
57  //- Generate orthogonality field. (1 for fully orthogonal, < 1 for
58  // non-orthogonal)
60  (
61  const polyMesh& mesh,
62  const vectorField& fAreas,
63  const vectorField& cellCtrs
64  );
65 
66  //- Generate skewness field
68  (
69  const polyMesh& mesh,
70  const pointField& points,
71  const vectorField& fCtrs,
72  const vectorField& fAreas,
73  const vectorField& cellCtrs
74  );
75 
76  //- Generate interpolation factors field
78  (
79  const polyMesh& mesh,
80  const vectorField& fCtrs,
81  const vectorField& fAreas,
82  const vectorField& cellCtrs
83  );
84 
85  //- Generate volume ratio field
87  (
88  const polyMesh& mesh,
89  const scalarField& vol
90  );
91 
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
const pointField & points
static tmp< scalarField > faceOrthogonality(const polyMesh &mesh, const vectorField &fAreas, const vectorField &cellCtrs)
Generate orthogonality field. (1 for fully orthogonal, < 1 for.
Definition: polyMeshTools.C:35
static tmp< scalarField > faceSkewness(const polyMesh &mesh, const pointField &points, const vectorField &fCtrs, const vectorField &fAreas, const vectorField &cellCtrs)
Generate skewness field.
Definition: polyMeshTools.C:90
dynamicFvMesh & mesh
Namespace for OpenFOAM.
static tmp< scalarField > faceWeights(const polyMesh &mesh, const vectorField &fCtrs, const vectorField &fAreas, const vectorField &cellCtrs)
Generate interpolation factors field.
static tmp< scalarField > volRatio(const polyMesh &mesh, const scalarField &vol)
Generate volume ratio field.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
A class for managing temporary objects.
Definition: PtrList.H:118