src/finiteVolume/cfdTools/general/MRF/MRFZones.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::MRFZones
  27
  28 Description
  29     Container class for a set of MRFZones with the MRFZone member functions
  30     implemented to loop over the functions for each MRFZone.
  31
  32 SourceFiles
  33     MRFZones.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef MRFZones_H
  38 #define MRFZones_H
  39
  40 #include "MRFZone.H"
  41 #include "IOPtrList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class MRFZones Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class MRFZones
  53 :
  54     public IOPtrList<MRFZone>
  55 {
  56
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise copy construct
  60         MRFZones(const MRFZones&);
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const MRFZones&);
  64
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from fvMesh
  71         MRFZones(const fvMesh& mesh);
  72
  73
  74     // Member Functions
  75
  76         //- Add the Coriolis force contribution to the momentum equation
  77         void addCoriolis(fvVectorMatrix& UEqn) const;
  78
  79         //- Add the Coriolis force contribution to the momentum equation
  80         void addCoriolis(const volScalarField& rho, fvVectorMatrix& UEqn) const;
  81
  82         //- Make the given absolute velocity relative within the MRF region
  83         void relativeVelocity(volVectorField& U) const;
  84
  85         //- Make the given absolute flux relative within the MRF region
  86         void relativeFlux(surfaceScalarField& phi) const;
  87
  88         //- Make the given absolute mass-flux relative within the MRF region
  89         void relativeFlux
  90         (
  91             const surfaceScalarField& rho,
  92             surfaceScalarField& phi
  93         ) const;
  94
  95         //- Make the given relative flux absolute within the MRF region
  96         void absoluteFlux(surfaceScalarField& phi) const;
  97
  98         //- Make the given relative mass-flux absolute within the MRF region
  99         void absoluteFlux
 100         (
 101             const surfaceScalarField& rho,
 102             surfaceScalarField& phi
 103         ) const;
 104
 105         //- Correct the boundary velocity for the roation of the MRF region
 106         void correctBoundaryVelocity(volVectorField& U) const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //