volFieldSelection.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 volume field selections
31 
32 SourceFiles
33  volFieldSelection.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef functionObjects_volFieldSelection_H
38 #define functionObjects_volFieldSelection_H
39 
40 #include "fieldSelection.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace functionObjects
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class volFieldSelection Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public fieldSelection
56 {
57 private:
58 
59  // Private Member Functions
60 
61  //- No copy construct
62  volFieldSelection(const volFieldSelection&) = delete;
63 
64 
65 protected:
66 
67  // Protected Member Functions
68 
69  //- Add registered GeometricField types to selection
70  template<template<class> class PatchType, class MeshType>
72 
73 
74 public:
75 
76  //- Construct from object registry
78  (
79  const objectRegistry& obr,
80  const bool includeComponents = false
81  );
82 
83 
84  //- Destructor
85  virtual ~volFieldSelection() = default;
86 
87 
88  // Member Functions
89 
90  //- Update the selection using current contents of obr_
91  virtual bool updateSelection();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace functionObjects
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #ifdef NoRepository
104 #endif
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
Foam::functionObjects::volFieldSelection::~volFieldSelection
virtual ~volFieldSelection()=default
Destructor.
Foam::DynamicList
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Definition: DynamicList.H:55
Foam::functionObjects::fieldSelection
Helper class to manage field selections.
Definition: fieldSelection.H:63
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
Foam::functionObjects::volFieldSelection
Helper class to manage solver field selections.
Definition: volFieldSelection.H:52
Foam::functionObjects::volFieldSelection::updateSelection
virtual bool updateSelection()
Update the selection using current contents of obr_.
Definition: volFieldSelection.C:46
volFieldSelectionTemplates.C
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
fieldSelection.H
Foam::List< fieldInfo >::set
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set(const label i, bool val=true)
A bitSet::set() method for a list of bool.
Definition: List.H:325
Foam::functionObjects::volFieldSelection::addRegisteredGeoFields
void addRegisteredGeoFields(DynamicList< fieldInfo > &set) const
Add registered GeometricField types to selection.
Definition: volFieldSelectionTemplates.C:34