src/finiteVolume/finiteVolume/ddtSchemes/boundedBackwardDdtScheme/boundedBackwardDdtScheme.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::fv::boundedBackwardDdtScheme
  27
  28 Description
  29     Second-order bounded-backward-differencing ddt using the current and
  30     two previous time-step values.
  31
  32 SourceFiles
  33     boundedBackwardDdtScheme.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef boundedBackwardDdtScheme_H
  38 #define boundedBackwardDdtScheme_H
  39
  40 #include "ddtScheme.H"
  41 #include "fvMatrices.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace fv
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                        Class boundedBackwardDdtScheme Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class boundedBackwardDdtScheme
  58 :
  59     public fv::ddtScheme<scalar>
  60 {
  61     // Private Member Functions
  62
  63         //- Return the current time-step
  64         scalar deltaT_() const;
  65
  66         //- Return the previous time-step
  67         scalar deltaT0_() const;
  68
  69         //- Return the previous time-step or GREAT if the old timestep field
  70         //  wasn't available in which case Euler ddt is used
  71         template<class GeoField>
  72         scalar deltaT0_(const GeoField& vf) const
  73         {
  74             if (vf.oldTime().timeIndex() == vf.oldTime().oldTime().timeIndex())
  75             {
  76                 return GREAT;
  77             }
  78             else
  79             {
  80                 return deltaT0_();
  81             }
  82         }
  83
  84
  85         //- Disallow default bitwise copy construct
  86         boundedBackwardDdtScheme(const boundedBackwardDdtScheme&);
  87
  88         //- Disallow default bitwise assignment
  89         void operator=(const boundedBackwardDdtScheme&);
  90
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("boundedBackward");
  96
  97
  98     // Constructors
  99
 100         //- Construct from mesh
 101         boundedBackwardDdtScheme(const fvMesh& mesh)
 102         :
 103             ddtScheme<scalar>(mesh)
 104         {}
 105
 106         //- Construct from mesh and Istream
 107         boundedBackwardDdtScheme(const fvMesh& mesh, Istream& is)
 108         :
 109             ddtScheme<scalar>(mesh, is)
 110         {}
 111
 112
 113     // Member Functions
 114
 115         //- Return mesh reference
 116         const fvMesh& mesh() const
 117         {
 118             return fv::ddtScheme<scalar>::mesh();
 119         }
 120
 121         tmp<volScalarField> fvcDdt
 122         (
 123             const dimensionedScalar&
 124         );
 125
 126         tmp<volScalarField> fvcDdt
 127         (
 128             const volScalarField&
 129         );
 130
 131         tmp<volScalarField> fvcDdt
 132         (
 133             const dimensionedScalar&,
 134             const volScalarField&
 135         );
 136
 137         tmp<volScalarField> fvcDdt
 138         (
 139             const volScalarField&,
 140             const volScalarField&
 141         );
 142
 143         tmp<fvScalarMatrix> fvmDdt
 144         (
 145             volScalarField&
 146         );
 147
 148         tmp<fvScalarMatrix> fvmDdt
 149         (
 150             const dimensionedScalar&,
 151             volScalarField&
 152         );
 153
 154         tmp<fvScalarMatrix> fvmDdt
 155         (
 156             const volScalarField&,
 157             volScalarField&
 158         );
 159
 160         tmp<surfaceScalarField> fvcDdtPhiCorr
 161         (
 162             const volScalarField& rA,
 163             const volScalarField& U,
 164             const surfaceScalarField& phi
 165         );
 166
 167         tmp<surfaceScalarField> fvcDdtPhiCorr
 168         (
 169             const volScalarField& rA,
 170             const volScalarField& rho,
 171             const volScalarField& U,
 172             const surfaceScalarField& phi
 173         );
 174
 175         tmp<surfaceScalarField> meshPhi
 176         (
 177             const volScalarField&
 178         );
 179 };
 180
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 } // End namespace fv
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace Foam
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 #endif
 193
 194 // ************************************************************************* //