OpenFOAM: API Guide
v2112
The open source CFD toolbox
solverFieldSelection.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) 2017-2019 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::functionObjects::volFieldSelection
28
29
Description
30
Helper class to manage solver field selections
31
32
SourceFiles
33
solverFieldSelection.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef functionObjects_solverFieldSelection_H
38
#define functionObjects_solverFieldSelection_H
39
40
#include "
fieldSelection.H
"
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
namespace
functionObjects
47
{
48
49
/*---------------------------------------------------------------------------*\
50
Class solverFieldSelection Declaration
51
\*---------------------------------------------------------------------------*/
52
53
class
solverFieldSelection
54
:
55
public
fieldSelection
56
{
57
private
:
58
59
// Private Member Functions
60
61
//- No copy construct
62
solverFieldSelection
(
const
solverFieldSelection
&) =
delete
;
63
64
65
public
:
66
67
//- Construct from object registry
68
solverFieldSelection
69
(
70
const
objectRegistry
& obr,
71
const
bool
includeComponents =
false
72
);
73
74
75
//- Destructor
76
virtual
~solverFieldSelection
() =
default
;
77
78
79
// Member Functions
80
81
//- Update the selection using current contents of obr_
82
virtual
bool
updateSelection
();
83
};
84
85
86
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88
}
// End namespace functionObjects
89
}
// End namespace Foam
90
91
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92
93
#endif
94
95
// ************************************************************************* //
Foam::functionObjects::solverFieldSelection::updateSelection
virtual bool updateSelection()
Update the selection using current contents of obr_.
Definition:
solverFieldSelection.C:54
Foam::functionObjects::solverFieldSelection::~solverFieldSelection
virtual ~solverFieldSelection()=default
Destructor.
Foam::functionObjects::solverFieldSelection
Definition:
solverFieldSelection.H:52
Foam::functionObjects::fieldSelection
Helper class to manage field selections.
Definition:
fieldSelection.H:63
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:60
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
fieldSelection.H
src
finiteVolume
functionObjects
fieldSelections
solverFieldSelection
solverFieldSelection.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.