src/dynamicMesh/dynamicTopoFvMesh/fieldMapping/fluxCorrector.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     fluxCorrector
  26
  27 Description
  28     Virtual base class that deals with flux-correction after topo-changes.
  29
  30 Author
  31     Sandeep Menon
  32     University of Massachusetts Amherst
  33     All rights reserved
  34
  35 SourceFiles
  36     fluxCorrector.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef fluxCorrector_H
  41 #define fluxCorrector_H
  42
  43 #include "fvMesh.H"
  44 #include "runTimeSelectionTables.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class fluxCorrector Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class fluxCorrector
  56 {
  57     // Private data
  58
  59         //- Reference to fvMesh
  60         const fvMesh& mesh_;
  61
  62         //- Reference to dictionary
  63         const dictionary& dict_;
  64
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise copy construct
  68         fluxCorrector(const fluxCorrector&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const fluxCorrector&);
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("fluxCorrector");
  77
  78
  79     // Declare run-time constructor selection tables
  80
  81         declareRunTimeSelectionTable
  82         (
  83             autoPtr,
  84             fluxCorrector,
  85             mesh,
  86             (
  87                 const fvMesh& mesh,
  88                 const dictionary& dict
  89             ),
  90             (mesh, dict)
  91         );
  92
  93
  94     // Selectors
  95
  96         //- Select constructed from fvMesh
  97         static autoPtr<fluxCorrector> New
  98         (
  99             const fvMesh& mesh,
 100             const dictionary& dict
 101         );
 102
 103
 104     // Constructors
 105
 106         //- Construct from fvMesh and dictionary
 107         fluxCorrector(const fvMesh& mesh, const dictionary& dict)
 108         :
 109             mesh_(mesh),
 110             dict_(dict)
 111         {}
 112
 113
 114     // Destructor
 115
 116         virtual ~fluxCorrector()
 117         {}
 118
 119
 120     // Member Functions
 121
 122         //- Return reference to mesh
 123         const fvMesh& mesh() const;
 124
 125         //- Return reference to dictionary
 126         const dictionary& dict() const;
 127
 128         //- Is flux-correction required?
 129         virtual bool required() const;
 130
 131         //- Interpolate fluxes to a specified list of faces
 132         virtual void interpolateFluxes(const labelList& faces) const;
 133
 134         //- Update fluxes in the registry
 135         virtual void updateFluxes() const;
 136 };
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 #endif
 145
 146 // ************************************************************************* //