patchFunction1Base.C
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) 2020-2021 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 \*---------------------------------------------------------------------------*/
27 
28 #include "patchFunction1Base.H"
29 #include "polyBoundaryMesh.H"
30 #include "polyMesh.H"
31 #include "polyPatch.H"
32 #include "objectRegistry.H"
33 #include "Time.H"
34 
35 // * * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * //
36 
38 (
39  const polyPatch& pp,
40  const word& entryName,
41  const bool faceValues
42 )
43 :
44  refCount(),
45  name_(entryName),
46  patch_(pp),
47  faceValues_(faceValues)
48 {}
49 
50 
52 (
53  const polyPatch& pp,
54  const word& entryName,
55  const dictionary& dict,
56  const bool faceValues
57 )
58 :
59  refCount(),
60  name_(entryName),
61  patch_(pp),
62  faceValues_(faceValues)
63 {}
64 
65 
67 :
68  patchFunction1Base(rhs, rhs.patch())
69 {}
70 
71 
73 (
74  const patchFunction1Base& rhs,
75  const polyPatch& pp
76 )
77 :
78  refCount(),
79  name_(rhs.name_),
80  patch_(pp),
81  faceValues_(rhs.faceValues_)
82 {}
83 
84 
85 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
86 
88 {
89  return &(patch_.boundaryMesh().mesh()); // mesh registry
90 }
91 
92 
94 {
95  return patch_.boundaryMesh().mesh(); // mesh registry
96 }
97 
98 
100 {
101  return patch_.boundaryMesh().mesh().time();
102 }
103 
104 
106 {}
107 
108 
109 // ************************************************************************* //
Foam::patchFunction1Base::whichDb
const objectRegistry * whichDb() const
Return the associated registry (ie, the mesh)
Definition: patchFunction1Base.C:87
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::patchFunction1Base::patchFunction1Base
patchFunction1Base(const polyPatch &pp, const word &entryName, const bool faceValues=true)
Construct from polyPatch and entry name.
Definition: patchFunction1Base.C:38
polyPatch.H
Foam::refCount
Reference counter for various OpenFOAM components.
Definition: refCount.H:50
Foam::patchFunction1Base::time
const Time & time() const
Return false: function not created with time database.
Definition: patchFunction1Base.C:99
objectRegistry.H
polyMesh.H
patchFunction1Base.H
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
Foam::polyPatch
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:68
Foam::patchFunction1Base::userTimeToTime
virtual void userTimeToTime(const Time &t)
Convert time.
Definition: patchFunction1Base.C:105
Foam::patchFunction1Base::obr
const objectRegistry & obr() const
Return the object registry (ie, the mesh)
Definition: patchFunction1Base.C:93
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Time.H
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::patchFunction1Base::faceValues_
const bool faceValues_
Generate face or point values on patch.
Definition: patchFunction1Base.H:75
polyBoundaryMesh.H
Foam::patchFunction1Base
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: patchFunction1Base.H:60
Foam::objectRegistry::time
const Time & time() const noexcept
Return time registry.
Definition: objectRegistry.H:178
Foam::patchFunction1Base::name_
const word name_
Name of entry.
Definition: patchFunction1Base.H:69