centredFECCellToFaceStencilObject.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-2013 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::centredFECCellToFaceStencilObject
29
30Description
31
32SourceFiles
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef centredFECCellToFaceStencilObject_H
37#define centredFECCellToFaceStencilObject_H
38
41#include "MeshObject.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Class centredFECCellToFaceStencilObject Declaration
50\*---------------------------------------------------------------------------*/
53:
54 public MeshObject
55 <
56 fvMesh,
57 TopologicalMeshObject,
58 centredFECCellToFaceStencilObject
59 >,
61{
62
63public:
65 TypeName("centredFECCellToFaceStencil");
66
67 // Constructors
68
69 //- Construct from uncompacted face stencil
71 (
72 const fvMesh& mesh
73 )
74 :
76 <
77 fvMesh,
80 >(mesh),
82 {
83 if (extendedCellToFaceStencil::debug)
84 {
85 Info<< "Generated centred stencil " << type()
86 << nl << endl;
88 }
89 }
90
91
92 //- Destructor
93 virtual ~centredFECCellToFaceStencilObject() = default;
94};
95
96
97// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99} // End namespace Foam
100
101// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102
103#endif
104
105// ************************************************************************* //
All cells connected via edge to face.
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:91
TypeName("centredFECCellToFaceStencil")
virtual ~centredFECCellToFaceStencilObject()=default
Destructor.
centredFECCellToFaceStencilObject(const fvMesh &mesh)
Construct from uncompacted face stencil.
static void writeStencilStats(Ostream &os, const labelListList &stencil, const mapDistribute &map)
Write some statistics about stencil.
const mapDistribute & map() const
Return reference to the parallel distribution map.
const labelListList & stencil() const
Return reference to the stencil.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73