EulerFaDdtScheme.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2017 Wikki Ltd
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::fa::EulerDdtScheme
28 
29 Description
30  Basic first-order Euler implicit/explicit ddt using only the current and
31  previous time-step values.
32 
33 SourceFiles
34  EulerDdtScheme.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef EulerFaDdtScheme_H
39 #define EulerFaDdtScheme_H
40 
41 #include "faDdtScheme.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace fa
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class EulerFaDdtScheme Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 template<class Type>
58 class EulerFaDdtScheme
59 :
60  public fa::faDdtScheme<Type>
61 {
62  // Private Member Functions
63 
64  //- No copy construct
65  EulerFaDdtScheme(const EulerFaDdtScheme&) = delete;
66 
67  //- No copy assignment
68  void operator=(const EulerFaDdtScheme&) = delete;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("Euler");
75 
76 
77  // Constructors
78 
79  //- Construct from mesh
81  :
82  faDdtScheme<Type>(mesh)
83  {}
84 
85  //- Construct from mesh and Istream
86  EulerFaDdtScheme(const faMesh& mesh, Istream& is)
87  :
88  faDdtScheme<Type>(mesh, is)
89  {}
90 
91 
92  // Member Functions
93 
94  //- Return mesh reference
95  const faMesh& mesh() const
96  {
98  }
99 
101  (
102  const dimensioned<Type>
103  );
104 
106  (
107  const dimensioned<Type>
108  );
109 
111  (
113  );
114 
116  (
118  );
119 
121  (
122  const dimensionedScalar&,
124  );
125 
127  (
128  const dimensionedScalar&,
130  );
131 
133  (
134  const areaScalarField&,
136  );
137 
139  (
140  const areaScalarField&,
142  );
143 
145  (
147  );
148 
150  (
151  const dimensionedScalar&,
153  );
154 
156  (
157  const areaScalarField&,
159  );
160 };
161 
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 } // End namespace fa
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #ifdef NoRepository
174  #include "EulerFaDdtScheme.C"
175 #endif
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
Foam::fa::EulerFaDdtScheme::EulerFaDdtScheme
EulerFaDdtScheme(const faMesh &mesh)
Construct from mesh.
Definition: EulerFaDdtScheme.H:79
Foam::fa::EulerFaDdtScheme::facDdt
tmp< GeometricField< Type, faPatchField, areaMesh > > facDdt(const dimensioned< Type >)
Definition: EulerFaDdtScheme.C:47
EulerFaDdtScheme.C
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::fa::EulerFaDdtScheme
Definition: EulerFaDdtScheme.H:57
Foam::fa::EulerFaDdtScheme::mesh
const faMesh & mesh() const
Return mesh reference.
Definition: EulerFaDdtScheme.H:94
Foam::fa::faDdtScheme::mesh
const faMesh & mesh() const
Return mesh reference.
Definition: faDdtScheme.H:137
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::fa::faDdtScheme
Definition: faDdtScheme.H:66
faDdtScheme.H
Foam::fa::EulerFaDdtScheme::TypeName
TypeName("Euler")
Runtime type information.
Foam::dimensioned
Generic dimensioned Type class.
Definition: dimensionedScalarFwd.H:43
Foam::fa::EulerFaDdtScheme::facDdt0
tmp< GeometricField< Type, faPatchField, areaMesh > > facDdt0(const dimensioned< Type >)
Definition: EulerFaDdtScheme.C:94
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fa::EulerFaDdtScheme::famDdt
tmp< faMatrix< Type > > famDdt(const GeometricField< Type, faPatchField, areaMesh > &)
Definition: EulerFaDdtScheme.C:444
Foam::fa::EulerFaDdtScheme::EulerFaDdtScheme
EulerFaDdtScheme(const faMesh &mesh, Istream &is)
Construct from mesh and Istream.
Definition: EulerFaDdtScheme.H:85
Foam::faMesh
Finite area mesh. Used for 2-D non-Euclidian finite area method.
Definition: faMesh.H:77
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53