OpenFOAM: API Guide
v2112
The open source CFD toolbox
surfaceRegistry.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 OpenFOAM Foundation
9
Copyright (C) 2016 OpenCFD Ltd.
10
-------------------------------------------------------------------------------
11
License
12
This file is part of OpenFOAM.
13
14
OpenFOAM is free software: you can redistribute it and/or modify it
15
under the terms of the GNU General Public License as published by
16
the Free Software Foundation, either version 3 of the License, or
17
(at your option) any later version.
18
19
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22
for more details.
23
24
You should have received a copy of the GNU General Public License
25
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27
Class
28
Foam::surfaceRegistry
29
30
Description
31
Wraps the normal objectRegistry with a local instance for %surfaces.
32
33
SourceFiles
34
surfaceRegistry.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef surfaceRegistry_H
39
#define surfaceRegistry_H
40
41
#include "
objectRegistry.H
"
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
/*---------------------------------------------------------------------------*\
49
Class surfaceRegistry Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
surfaceRegistry
53
:
54
public
objectRegistry
55
{
56
57
// Private Member Functions
58
59
//- No copy construct
60
surfaceRegistry
(
const
surfaceRegistry
&) =
delete
;
61
62
//- No copy assignment
63
surfaceRegistry
& operator=(
const
surfaceRegistry
&) =
delete
;
64
65
66
public
:
67
68
//- Runtime type information
69
TypeName
(
"surfaceRegistry"
);
70
71
//- The prefix to local: %surfaces
72
static
const
word
prefix
;
73
74
//- The default surface name: %default
75
static
word
defaultName
;
76
77
78
// Constructors
79
80
//- Construct for the given objectRegistry and named surface
81
surfaceRegistry
82
(
83
const
objectRegistry
& obr,
84
const
word
& surfName =
word::null
85
);
86
87
88
//- Destructor
89
virtual
~surfaceRegistry
() =
default
;
90
91
};
92
93
94
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95
96
}
// End namespace Foam
97
98
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100
#endif
101
102
// ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:65
Foam::surfaceRegistry
Wraps the normal objectRegistry with a local instance for surfaces.
Definition:
surfaceRegistry.H:51
objectRegistry.H
Foam::surfaceRegistry::~surfaceRegistry
virtual ~surfaceRegistry()=default
Destructor.
Foam::surfaceRegistry::TypeName
TypeName("surfaceRegistry")
Runtime type information.
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:60
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::surfaceRegistry::defaultName
static word defaultName
The default surface name: default.
Definition:
surfaceRegistry.H:74
Foam::word::null
static const word null
An empty word.
Definition:
word.H:80
Foam::surfaceRegistry::prefix
static const word prefix
The prefix to local: surfaces.
Definition:
surfaceRegistry.H:71
src
surfMesh
surfaceRegistry
surfaceRegistry.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.