src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/upwindCFCCellToFaceStencilObject.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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
  36 #include "extendedUpwindCellToFaceStencil.H"
  37 #include "CFCCellToFaceStencil.H"
  38 #include "MeshObject.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46               Class upwindCFCCellToFaceStencilObject Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class upwindCFCCellToFaceStencilObject
  50 :
  51     public MeshObject<fvMesh, upwindCFCCellToFaceStencilObject>,
  52     public extendedUpwindCellToFaceStencil
  53 {
  54
  55 public:
  56
  57     TypeName("upwindCFCCellToFaceStencil");
  58
  59     // Constructors
  60
  61         //- Construct from uncompacted face stencil
  62         explicit upwindCFCCellToFaceStencilObject
  63         (
  64             const fvMesh& mesh,
  65             const bool pureUpwind,
  66             const scalar minOpposedness
  67         )
  68         :
  69             MeshObject<fvMesh, upwindCFCCellToFaceStencilObject>(mesh),
  70             extendedUpwindCellToFaceStencil
  71             (
  72                 CFCCellToFaceStencil(mesh),
  73                 pureUpwind,
  74                 minOpposedness
  75             )
  76         {
  77             if (extendedCellToFaceStencil::debug)
  78             {
  79                 Info<< "Generated off-centred stencil " << type()
  80                     << nl << endl;
  81                 writeStencilStats(Info, ownStencil(), ownMap());
  82             }
  83         }
  84
  85
  86     //- Destructor
  87     virtual ~upwindCFCCellToFaceStencilObject()
  88     {}
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //