basicFvGeometryScheme.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::basicFvGeometryScheme
28 
29 Description
30  Default geometry calculation scheme. Slight stabilisation for bad meshes.
31 
32 SourceFiles
33  basicFvGeometryScheme.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef basicFvGeometryScheme_H
38 #define basicFvGeometryScheme_H
39 
40 #include "fvGeometryScheme.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class basicFvGeometryScheme Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public fvGeometryScheme
54 {
55  // Private Member Functions
56 
57  //- No copy construct
59 
60  //- No copy assignment
61  void operator=(const basicFvGeometryScheme&) = delete;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("basic");
68 
69 
70  // Constructors
71 
72  //- Construct from mesh
74 
75 
76  //- Destructor
77  virtual ~basicFvGeometryScheme() = default;
78 
79 
80  // Member Functions
81 
82  //- Do what is necessary if the mesh has moved
83  virtual void movePoints();
84 
85  //- Return linear difference weighting factors
86  virtual tmp<surfaceScalarField> weights() const;
87 
88  //- Return cell-centre difference coefficients
89  virtual tmp<surfaceScalarField> deltaCoeffs() const;
90 
91  //- Return non-orthogonal cell-centre difference coefficients
93 
94  //- Return non-orthogonality correction vectors
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
Foam::basicFvGeometryScheme::TypeName
TypeName("basic")
Runtime type information.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::basicFvGeometryScheme::~basicFvGeometryScheme
virtual ~basicFvGeometryScheme()=default
Destructor.
Foam::basicFvGeometryScheme::deltaCoeffs
virtual tmp< surfaceScalarField > deltaCoeffs() const
Return cell-centre difference coefficients.
Definition: basicFvGeometryScheme.C:149
Foam::basicFvGeometryScheme::weights
virtual tmp< surfaceScalarField > weights() const
Return linear difference weighting factors.
Definition: basicFvGeometryScheme.C:68
Foam::basicFvGeometryScheme
Default geometry calculation scheme. Slight stabilisation for bad meshes.
Definition: basicFvGeometryScheme.H:50
Foam::fvGeometryScheme::mesh
const fvMesh & mesh() const
Return mesh reference.
Definition: fvGeometryScheme.H:123
Foam::fvGeometryScheme
Abstract base class for geometry calculation schemes.
Definition: fvGeometryScheme.H:56
Foam::basicFvGeometryScheme::nonOrthDeltaCoeffs
virtual tmp< surfaceScalarField > nonOrthDeltaCoeffs() const
Return non-orthogonal cell-centre difference coefficients.
Definition: basicFvGeometryScheme.C:210
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::basicFvGeometryScheme::nonOrthCorrectionVectors
virtual tmp< surfaceVectorField > nonOrthCorrectionVectors() const
Return non-orthogonality correction vectors.
Definition: basicFvGeometryScheme.C:300
Foam::basicFvGeometryScheme::movePoints
virtual void movePoints()
Do what is necessary if the mesh has moved.
Definition: basicFvGeometryScheme.C:56
fvGeometryScheme.H