upwindFECCellToFaceStencilObject.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) 2011-2015 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::upwindFECCellToFaceStencilObject
26 
27 Description
28 
29 SourceFiles
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef upwindFECCellToFaceStencilObject_H
34 #define upwindFECCellToFaceStencilObject_H
35 
37 #include "FECCellToFaceStencil.H"
38 #include "MeshObject.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class upwindFECCellToFaceStencilObject Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public MeshObject
52  <
53  fvMesh,
54  TopologicalMeshObject,
55  upwindFECCellToFaceStencilObject
56  >,
58 {
59 
60 public:
61 
62  TypeName("upwindFECCellToFaceStencil");
63 
64  // Constructors
65 
66  //- Construct from uncompacted face stencil
68  (
69  const fvMesh& mesh,
70  const bool pureUpwind,
71  const scalar minOpposedness
72  )
73  :
75  <
76  fvMesh,
79  >(mesh),
81  (
83  pureUpwind,
84  minOpposedness
85  )
86  {
87  if (extendedCellToFaceStencil::debug)
88  {
89  Info<< "Generated off-centred stencil " << type()
90  << nl << endl;
92  }
93  }
94 
95 
96  //- Destructor
98  {}
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
All cells connected via edge to face.
const mapDistribute & ownMap() const
Return reference to the parallel distribution map.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
const labelListList & ownStencil() const
Return reference to the stencil.
TypeName("upwindFECCellToFaceStencil")
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:85
upwindFECCellToFaceStencilObject(const fvMesh &mesh, const bool pureUpwind, const scalar minOpposedness)
Construct from uncompacted face stencil.
static const char nl
Definition: Ostream.H:262
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:485
Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally remo...
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
messageStream Info
static void writeStencilStats(Ostream &os, const labelListList &stencil, const mapDistribute &map)
Write some statistics about stencil.
Namespace for OpenFOAM.