OpenFOAM: API Guide
v2112
The open source CFD toolbox
FieldBase.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) 2018 OpenCFD 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::FieldBase
28
29
Description
30
Template invariant parts for Field and SubField
31
32
SourceFiles
33
FieldBase.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef FieldBase_H
38
#define FieldBase_H
39
40
#include "
refCount.H
"
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class FieldBase Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
FieldBase
52
:
53
public
refCount
54
{
55
public
:
56
57
// Static Data Members
58
59
//- Typename for Field
60
static
const
char
*
const
typeName
;
61
62
//- Permit read construct from a larger size.
63
// Mostly required for things like column mesh, for example.
64
static
bool
allowConstructFromLargerSize
;
65
66
67
// Constructors
68
69
//- Default construct, refCount zero
70
constexpr
FieldBase
() noexcept
71
:
72
refCount
()
73
{}
74
};
75
76
77
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78
79
}
// End namespace Foam
80
81
#endif
82
83
// ************************************************************************* //
Foam::FieldBase
Template invariant parts for Field and SubField.
Definition:
FieldBase.H:50
Foam::refCount
Reference counter for various OpenFOAM components.
Definition:
refCount.H:50
Foam::FieldBase::allowConstructFromLargerSize
static bool allowConstructFromLargerSize
Permit read construct from a larger size.
Definition:
FieldBase.H:63
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::FieldBase::typeName
static const char *const typeName
Typename for Field.
Definition:
FieldBase.H:59
Foam::FieldBase::FieldBase
constexpr FieldBase() noexcept
Default construct, refCount zero.
Definition:
FieldBase.H:69
refCount.H
src
OpenFOAM
fields
Fields
Field
FieldBase.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.