Euler.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::Euler
26 
27 Description
28  Euler-implicit integration
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef Euler_H
33 #define Euler_H
34 
35 #include "IntegrationScheme.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class Euler Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class Type>
47 class Euler
48 :
49  public IntegrationScheme<Type>
50 {
51 public:
52 
53  //- Runtime type information
54  TypeName("Euler");
55 
56 
57  // Constructors
58 
59  //- Construct from components
60  Euler(const word& phiName, const dictionary& dict);
61 
62  //- Copy constructor
63  Euler(const Euler& is);
64 
65  //- Construct and return clone
66  virtual autoPtr<IntegrationScheme<Type> > clone() const
67  {
68  return autoPtr<IntegrationScheme<Type> >(new Euler<Type>(*this));
69  }
70 
71 
72  //- Destructor
73  virtual ~Euler();
74 
75 
76  // Member Functions
77 
78  //- Perform the integration
80  (
81  const Type& phi,
82  const scalar dt,
83  const Type& alphaBeta,
84  const scalar beta
85  ) const;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #ifdef NoRepository
96 # include "Euler.C"
97 #endif
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
Top level model for Integration schemes.
Euler(const word &phiName, const dictionary &dict)
Construct from components.
Definition: Euler.C:32
dimensionedScalar beta("beta", dimless/dimTemperature, laminarTransport)
Helper class to supply results of integration.
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual autoPtr< IntegrationScheme< Type > > clone() const
Construct and return clone.
Definition: Euler.H:65
virtual IntegrationScheme< Type >::integrationResult integrate(const Type &phi, const scalar dt, const Type &alphaBeta, const scalar beta) const
Perform the integration.
Definition: Euler.C:60
dictionary dict
TypeName("Euler")
Runtime type information.
virtual ~Euler()
Destructor.
Definition: Euler.C:51
surfaceScalarField & phi
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
Euler-implicit integration.
Definition: Euler.H:46