upwindCFCCellToFaceStencilObject.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) 2011-2015 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::upwindCFCCellToFaceStencilObject
29 
30 Description
31 
32 SourceFiles
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef upwindCFCCellToFaceStencilObject_H
37 #define upwindCFCCellToFaceStencilObject_H
38 
40 #include "CFCCellToFaceStencil.H"
41 #include "MeshObject.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class upwindCFCCellToFaceStencilObject Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public MeshObject
55  <
56  fvMesh,
57  TopologicalMeshObject,
58  upwindCFCCellToFaceStencilObject
59  >,
61 {
62 
63 public:
64 
65  TypeName("upwindCFCCellToFaceStencil");
66 
67  // Constructors
68 
69  //- Construct from uncompacted face stencil
71  (
72  const fvMesh& mesh,
73  const bool pureUpwind,
74  const scalar minOpposedness
75  )
76  :
78  <
79  fvMesh,
82  >(mesh),
84  (
86  pureUpwind,
87  minOpposedness
88  )
89  {
91  {
92  Info<< "Generated off-centred stencil " << type()
93  << nl << endl;
95  }
96  }
97 
98 
99  //- Destructor
100  virtual ~upwindCFCCellToFaceStencilObject() = default;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
Foam::extendedUpwindCellToFaceStencil::ownStencil
const labelListList & ownStencil() const
Return reference to the stencil.
Definition: extendedUpwindCellToFaceStencil.H:169
Foam::expressions::patchExpr::debug
int debug
Static debugging option.
CFCCellToFaceStencil.H
Foam::extendedUpwindCellToFaceStencil::pureUpwind
bool pureUpwind() const
Definition: extendedUpwindCellToFaceStencil.H:151
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::upwindCFCCellToFaceStencilObject::TypeName
TypeName("upwindCFCCellToFaceStencil")
Foam::extendedUpwindCellToFaceStencil
Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally remo...
Definition: extendedUpwindCellToFaceStencil.H:61
extendedUpwindCellToFaceStencil.H
Foam::MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >::mesh
const fvMesh & mesh() const
Definition: MeshObject.H:122
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::extendedUpwindCellToFaceStencil::ownMap
const mapDistribute & ownMap() const
Return reference to the parallel distribution map.
Definition: extendedUpwindCellToFaceStencil.H:157
Foam::upwindCFCCellToFaceStencilObject
Definition: upwindCFCCellToFaceStencilObject.H:51
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::upwindCFCCellToFaceStencilObject::upwindCFCCellToFaceStencilObject
upwindCFCCellToFaceStencilObject(const fvMesh &mesh, const bool pureUpwind, const scalar minOpposedness)
Construct from uncompacted face stencil.
Definition: upwindCFCCellToFaceStencilObject.H:70
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::extendedCellToFaceStencil::writeStencilStats
static void writeStencilStats(Ostream &os, const labelListList &stencil, const mapDistribute &map)
Write some statistics about stencil.
Definition: extendedCellToFaceStencil.C:43
Foam::TopologicalMeshObject
Definition: MeshObject.H:182
MeshObject.H
Foam::upwindCFCCellToFaceStencilObject::~upwindCFCCellToFaceStencilObject
virtual ~upwindCFCCellToFaceStencilObject()=default
Destructor.
Foam::MeshObject
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:88
Foam::CFCCellToFaceStencil
Combined corresponding cellToCellStencil of owner and neighbour.
Definition: CFCCellToFaceStencil.H:50