src/dbns/timeStepping/EulerLocalDdtScheme/EulerLocalDdtScheme.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::fv::EulerLocalDdtScheme
  26
  27 Description
  28     Local time-setp limited first-order Euler implicit/explicit ddt.
  29
  30     The local time-step field has to be registered and provided outside of this
  31     class. If the physical time-step deltaT is already divided by a multi-stage
  32     coefficient this scheme can be also used for multi-stage time integration.
  33
  34     This scheme should only be used for steady-state computations
  35     using transient codes where local time-stepping is preferably to
  36     under-relaxation for transport consistency reasons.
  37
  38 Author
  39     Oliver Borm
  40     Aleksandar Jemcov
  41
  42 SourceFiles
  43     EulerLocalDdtScheme.C
  44
  45 \*---------------------------------------------------------------------------*/
  46
  47 #ifndef EulerLocalDdtScheme_H
  48 #define EulerLocalDdtScheme_H
  49
  50 #include "ddtScheme.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  58
  59 namespace fv
  60 {
  61
  62 /*---------------------------------------------------------------------------*\
  63                        Class EulerLocalDdtScheme Declaration
  64 \*---------------------------------------------------------------------------*/
  65
  66 template<class Type>
  67 class EulerLocalDdtScheme
  68 :
  69     public fv::ddtScheme<Type>
  70 {
  71     // Private Data
  72
  73         //- Name of the physical time-step (field)
  74         word deltaTName_;
  75
  76         //- Name of the local time-step field
  77         word deltaTauName_;
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         EulerLocalDdtScheme(const EulerLocalDdtScheme&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const EulerLocalDdtScheme&);
  86
  87 public:
  88
  89     //- Runtime type information
  90     TypeName("EulerLocal");
  91
  92
  93     // Constructors
  94
  95         //- Construct from mesh and Istream
  96         EulerLocalDdtScheme(const fvMesh& mesh, Istream& is)
  97         :
  98             ddtScheme<Type>(mesh, is),
  99             deltaTName_(is),
 100             deltaTauName_(is)
 101         {}
 102
 103
 104     // Member Functions
 105
 106         //- Return mesh reference
 107         const fvMesh& mesh() const
 108         {
 109             return fv::ddtScheme<Type>::mesh();
 110         }
 111
 112         tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt
 113         (
 114             const dimensioned<Type>&
 115         );
 116
 117         tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt
 118         (
 119             const GeometricField<Type, fvPatchField, volMesh>&
 120         );
 121
 122         tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt
 123         (
 124             const dimensionedScalar&,
 125             const GeometricField<Type, fvPatchField, volMesh>&
 126         );
 127
 128         tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt
 129         (
 130             const volScalarField&,
 131             const GeometricField<Type, fvPatchField, volMesh>&
 132         );
 133
 134         tmp<fvMatrix<Type> > fvmDdt
 135         (
 136             GeometricField<Type, fvPatchField, volMesh>&
 137         );
 138
 139         tmp<fvMatrix<Type> > fvmDdt
 140         (
 141             const dimensionedScalar&,
 142             GeometricField<Type, fvPatchField, volMesh>&
 143         );
 144
 145         tmp<fvMatrix<Type> > fvmDdt
 146         (
 147             const volScalarField&,
 148             GeometricField<Type, fvPatchField, volMesh>&
 149         );
 150
 151         typedef typename ddtScheme<Type>::fluxFieldType fluxFieldType;
 152
 153         tmp<fluxFieldType> fvcDdtPhiCorr
 154         (
 155             const volScalarField& rA,
 156             const GeometricField<Type, fvPatchField, volMesh>& U,
 157             const fluxFieldType& phi
 158         );
 159
 160         tmp<fluxFieldType> fvcDdtPhiCorr
 161         (
 162             const volScalarField& rA,
 163             const volScalarField& rho,
 164             const GeometricField<Type, fvPatchField, volMesh>& U,
 165             const fluxFieldType& phi
 166         );
 167
 168         tmp<surfaceScalarField> meshPhi
 169         (
 170             const GeometricField<Type, fvPatchField, volMesh>&
 171         );
 172 };
 173
 174
 175 template<>
 176 tmp<surfaceScalarField> EulerLocalDdtScheme<scalar>::fvcDdtPhiCorr
 177 (
 178     const volScalarField& rA,
 179     const volScalarField& U,
 180     const surfaceScalarField& phi
 181 );
 182
 183
 184 template<>
 185 tmp<surfaceScalarField> EulerLocalDdtScheme<scalar>::fvcDdtPhiCorr
 186 (
 187     const volScalarField& rA,
 188     const volScalarField& rho,
 189     const volScalarField& U,
 190     const surfaceScalarField& phi
 191 );
 192
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 } // End namespace fv
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 } // End namespace Foam
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 #ifdef NoRepository
 205 #   include "EulerLocalDdtScheme.C"
 206 #endif
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 #endif
 211
 212 // ************************************************************************* //