src/dbns/timeStepping/localTimeStep/localTimeStep.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     Foam::localTimeStep
  26
  27 Description
  28     The time-step is computed locally so that the local Courant number
  29     does not exceed the specified value.
  30
  31 Author
  32     Oliver Borm
  33     Aleksandar Jemcov
  34
  35 SourceFiles
  36     localTimeStep.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef localTimeStep_H
  41 #define localTimeStep_H
  42
  43 #include "fvCFD.H"
  44 #include "basicThermo.H"
  45 #include "turbulenceModel.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                        Class localTimeStep Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class localTimeStep
  57 {
  58     // Private Data
  59
  60         //- Reference to mesh
  61         const fvMesh& mesh_;
  62
  63         // Reference to primitive fields
  64
  65             //- Velocity field
  66             const volVectorField& U_;
  67
  68            //- Reference to the thermophysicalModel
  69            const basicThermo& thermo_;
  70
  71            //- Reference to the turbulenceModel
  72            const compressible::turbulenceModel& turbModel_;
  73
  74
  75        //- CFL number limited local time step field
  76        volScalarField CoDeltaT_;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         localTimeStep(const localTimeStep&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const localTimeStep&);
  86
  87
  88 public:
  89
  90     // Constructors
  91
  92         //- Construct from mesh and Istream
  93         localTimeStep
  94         (
  95             const volVectorField& U,
  96             const basicThermo& thermo,
  97             compressible::turbulenceModel& turbModel
  98         );
  99
 100
 101     // Member Functions
 102
 103         //- Return mesh reference
 104         const fvMesh& mesh() const
 105         {
 106             return mesh_;
 107         }
 108
 109         //- Return the Courant-number limited time-step
 110         const volScalarField& CoDeltaT() const
 111         {
 112             return CoDeltaT_;
 113         }
 114
 115         //- Update the local deltaT field
 116         // and adjust it to the minimum value optionally
 117         void update(const scalar maxCo, const bool adjustTimeStep = false);
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //