Euler.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "Euler.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& phiName,
34  const dictionary& dict
35 )
36 :
38 {}
39 
40 
41 template<class Type>
43 :
44  IntegrationScheme<Type>(is)
45 {}
46 
47 
48 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
49 
50 template<class Type>
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56 
57 template<class Type>
60 (
61  const Type& phi,
62  const scalar dt,
63  const Type& alphaBeta,
64  const scalar beta
65 ) const
66 {
68  retValue.value() = (phi + alphaBeta*dt)/(1.0 + beta*dt);
69  retValue.average() = 0.5*(phi + retValue.value());
70 
71  return retValue;
72 }
73 
74 
75 // ************************************************************************* //
Top level model for Integration schemes.
Euler(const word &phiName, const dictionary &dict)
Construct from components.
Definition: Euler.C:32
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
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
virtual ~Euler()
Destructor.
Definition: Euler.C:51
Type average() const
Return const access to the average.
Type value() const
Return const access to the value.
Euler-implicit integration.
Definition: Euler.H:46