src/lagrangian/intermediate/IntegrationScheme/Euler/Euler.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::Euler
  27
  28 Description
  29     Euler-implicit integration
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef Euler_H
  34 #define Euler_H
  35
  36 #include "IntegrationScheme.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class Euler Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class Type>
  48 class Euler
  49 :
  50     public IntegrationScheme<Type>
  51 {
  52 public:
  53
  54     //- Runtime type information
  55     TypeName("Euler");
  56
  57
  58     // Constructors
  59
  60         //- Construct from components
  61         Euler(const word& phiName, const dictionary& dict);
  62
  63
  64     //- Destructor
  65     virtual ~Euler();
  66
  67
  68     // Member Functions
  69
  70         //- Perform the integration
  71         virtual typename IntegrationScheme<Type>::integrationResult integrate
  72         (
  73             const Type phi,
  74             const scalar dt,
  75             const Type alpha,
  76             const scalar beta
  77         ) const;
  78 };
  79
  80
  81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  82
  83 } // End namespace Foam
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 #ifdef NoRepository
  88 #   include "Euler.C"
  89 #endif
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************************************************************* //