Analytical.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::Analytical
26 
27 Description
28  Analytical integration
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef Analytical_H
33 #define Analytical_H
34 
35 #include "IntegrationScheme.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class Analytical Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class Type>
47 class Analytical
48 :
49  public IntegrationScheme<Type>
50 {
51 public:
52 
53  //- Runtime type information
54  TypeName("analytical");
55 
56 
57  // Constructors
58 
59  //- Construct from components
60  Analytical(const word& phiName, const dictionary& dict);
61 
62  //- Copy constructor
63  Analytical(const Analytical& is);
64 
65  //- Construct and return clone
66  virtual autoPtr<IntegrationScheme<Type> > clone() const
67  {
69  (
70  new Analytical<Type>(*this)
71  );
72  }
73 
74 
75  //- Destructor
76  virtual ~Analytical();
77 
78 
79  // Member Functions
80 
81  //- Perform the integration
83  (
84  const Type& phi,
85  const scalar dt,
86  const Type& alphaBeta,
87  const scalar beta
88  ) const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #ifdef NoRepository
99 # include "Analytical.C"
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
Top level model for Integration schemes.
virtual IntegrationScheme< Type >::integrationResult integrate(const Type &phi, const scalar dt, const Type &alphaBeta, const scalar beta) const
Perform the integration.
Definition: Analytical.C:60
virtual ~Analytical()
Destructor.
Definition: Analytical.C:51
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
Analytical(const word &phiName, const dictionary &dict)
Construct from components.
Definition: Analytical.C:32
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
dictionary dict
TypeName("analytical")
Runtime type information.
Analytical integration.
Definition: Analytical.H:46
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
virtual autoPtr< IntegrationScheme< Type > > clone() const
Construct and return clone.
Definition: Analytical.H:65