d2dt2Scheme.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) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::fv::d2dt2Scheme
28
29Description
30 Abstract base class for finite volume d2dt2 schemes.
31
32SourceFiles
33 d2dt2Scheme.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef d2dt2Scheme_H
38#define d2dt2Scheme_H
39
40#include "tmp.H"
41#include "dimensionedType.H"
42#include "volFieldsFwd.H"
43#include "surfaceFieldsFwd.H"
44#include "typeInfo.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52template<class Type>
53class fvMatrix;
54
55class fvMesh;
56
57// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58
59namespace fv
60{
61
62/*---------------------------------------------------------------------------*\
63 Class d2dt2Scheme Declaration
64\*---------------------------------------------------------------------------*/
65
66template<class Type>
67class d2dt2Scheme
68:
69 public refCount
70{
71
72protected:
73
74 // Protected data
76 const fvMesh& mesh_;
77
78
79 // Private Member Functions
80
81 //- No copy construct
82 d2dt2Scheme(const d2dt2Scheme&) = delete;
83
84 //- No copy assignment
85 void operator=(const d2dt2Scheme&) = delete;
86
87
88public:
89
90 //- Runtime type information
91 virtual const word& type() const = 0;
92
93
94 // Declare run-time constructor selection tables
97 (
98 tmp,
100 Istream,
101 (const fvMesh& mesh, Istream& schemeData),
102 (mesh, schemeData)
103 );
104
105
106 // Constructors
107
108 //- Construct from mesh
109 d2dt2Scheme(const fvMesh& mesh)
110 :
111 mesh_(mesh)
112 {}
113
114 //- Construct from mesh and Istream
116 :
117 mesh_(mesh)
118 {}
119
120
121 // Selectors
122
123 //- Return a pointer to a new d2dt2Scheme created on freestore
125 (
126 const fvMesh& mesh,
127 Istream& schemeData
128 );
129
130
131 //- Destructor
132 virtual ~d2dt2Scheme() = default;
133
134
135 // Member Functions
136
137 //- Return mesh reference
138 const fvMesh& mesh() const
139 {
140 return mesh_;
141 }
144 (
146 ) = 0;
149 (
150 const volScalarField&,
152 ) = 0;
155 (
157 ) = 0;
160 (
161 const dimensionedScalar&,
163 ) = 0;
166 (
167 const volScalarField&,
169 ) = 0;
170};
171
172
173// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174
175} // End namespace fv
176
177// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178
179} // End namespace Foam
180
181// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182
183// Add the patch constructor functions to the hash tables
185#define makeFvD2dt2TypeScheme(SS, Type) \
186 defineNamedTemplateTypeNameAndDebug(Foam::fv::SS<Foam::Type>, 0); \
187 \
188 namespace Foam \
189 { \
190 namespace fv \
191 { \
192 d2dt2Scheme<Type>::addIstreamConstructorToTable<SS<Type>> \
193 add##SS##Type##IstreamConstructorToTable_; \
194 } \
195 }
197#define makeFvD2dt2Scheme(SS) \
198 \
199makeFvD2dt2TypeScheme(SS, scalar) \
200makeFvD2dt2TypeScheme(SS, vector) \
201makeFvD2dt2TypeScheme(SS, sphericalTensor) \
202makeFvD2dt2TypeScheme(SS, symmTensor) \
203makeFvD2dt2TypeScheme(SS, tensor)
204
205
206// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
207
208#ifdef NoRepository
209 #include "d2dt2Scheme.C"
210#endif
211
212// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
213
214#endif
215
216// ************************************************************************* //
Generic GeometricField class.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Abstract base class for finite volume d2dt2 schemes.
Definition: d2dt2Scheme.H:69
void operator=(const d2dt2Scheme &)=delete
No copy assignment.
virtual tmp< fvMatrix< Type > > fvmD2dt2(const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0
d2dt2Scheme(const fvMesh &mesh, Istream &)
Construct from mesh and Istream.
Definition: d2dt2Scheme.H:114
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcD2dt2(const GeometricField< Type, fvPatchField, volMesh > &)=0
const fvMesh & mesh_
Definition: d2dt2Scheme.H:75
virtual tmp< fvMatrix< Type > > fvmD2dt2(const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)=0
d2dt2Scheme(const d2dt2Scheme &)=delete
No copy construct.
d2dt2Scheme(const fvMesh &mesh)
Construct from mesh.
Definition: d2dt2Scheme.H:108
static tmp< d2dt2Scheme< Type > > New(const fvMesh &mesh, Istream &schemeData)
Return a pointer to a new d2dt2Scheme created on freestore.
Definition: d2dt2Scheme.C:46
declareRunTimeSelectionTable(tmp, d2dt2Scheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
virtual ~d2dt2Scheme()=default
Destructor.
const fvMesh & mesh() const
Return mesh reference.
Definition: d2dt2Scheme.H:137
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcD2dt2(const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual const word & type() const =0
Runtime type information.
virtual tmp< fvMatrix< Type > > fvmD2dt2(const GeometricField< Type, fvPatchField, volMesh > &)=0
Reference counter for various OpenFOAM components.
Definition: refCount.H:51
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
labelList fv(nPoints)
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)