upwindCFCCellToFaceStencilObject.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) 2011-2022 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::upwindCFCCellToFaceStencilObject
26 
27 Description
28 
29 SourceFiles
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef upwindCFCCellToFaceStencilObject_H
34 #define upwindCFCCellToFaceStencilObject_H
35 
37 #include "CFCCellToFaceStencil.H"
38 #include "DemandDrivenMeshObject.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class upwindCFCCellToFaceStencilObject Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
52  <
53  fvMesh,
54  TopologicalMeshObject,
55  upwindCFCCellToFaceStencilObject
56  >,
58 {
59 
60 protected:
61 
62  friend class DemandDrivenMeshObject
63  <
64  fvMesh,
67  >;
68 
69  // Protected Constructors
70 
71  //- Construct from uncompacted face stencil
73  (
74  const fvMesh& mesh,
75  const bool pureUpwind,
76  const scalar minOpposedness
77  )
78  :
80  <
81  fvMesh,
84  >(mesh),
86  (
88  pureUpwind,
89  minOpposedness
90  )
91  {
92  if (extendedCellToFaceStencil::debug)
93  {
94  Info<< "Generated off-centred stencil " << type()
95  << nl << endl;
97  }
98  }
99 
100 
101 public:
102 
103  TypeName("upwindCFCCellToFaceStencil");
104 
105  //- Destructor
107  {}
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
Combined corresponding cellToCellStencil of owner and neighbour.
Templated abstract base-class for demand-driven mesh objects used to automate their allocation to the...
MeshObject types:
Definition: MeshObjects.H:60
static void writeStencilStats(Ostream &os, const labelListList &stencil, const distributionMap &map)
Write some statistics about stencil.
Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally remo...
const labelListList & ownStencil() const
Return reference to the stencil.
const distributionMap & ownMap() const
Return reference to the parallel distribution map.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:101
upwindCFCCellToFaceStencilObject(const fvMesh &mesh, const bool pureUpwind, const scalar minOpposedness)
Construct from uncompacted face stencil.
TypeName("upwindCFCCellToFaceStencil")
Namespace for OpenFOAM.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
messageStream Info
static const char nl
Definition: Ostream.H:260
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488