File size: 5,582 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::objectRegistryFunctionObject
Description
Specialisation of Foam::functionObject which holds a reference to an object
registry. Provides a number of functions for caching and accessing objects
from the registry.
See also
Foam::functionObject
SourceFiles
objectRegistryFunctionObject.C
\*---------------------------------------------------------------------------*/
#ifndef objectRegistryFunctionObject_functionObject_H
#define objectRegistryFunctionObject_functionObject_H
#include "functionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class objectRegistryFunctionObject Declaration
\*---------------------------------------------------------------------------*/
class objectRegistryFunctionObject
:
public functionObject
{
protected:
// Protected Data
//- Reference to the objectRegistry
const objectRegistry& obr_;
// Protected Member Functions
//- Find field in the objectRegistry
template<class ObjectType>
bool foundObject(const word& fieldName) const;
//- Prints a warning message that fieldName cannot be found
template<class ObjectType>
void cannotFindObject(const word& fieldName);
//- Prints a warning message that fieldName cannot be found
void cannotFindObject(const word& fieldName);
//- Prints a warning message that fieldNames cannot be found
void cannotFindObjects(const wordList& fieldNames);
//- Lookup object from the objectRegistry
template<class ObjectType>
const ObjectType& lookupObject(const word& fieldName) const;
//- Lookup non-const object reference from the objectRegistry
template<class ObjectType>
ObjectType& lookupObjectRef(const word& fieldName);
//- Store the given field in the objectRegistry
template<class ObjectType>
ObjectType& store(const tmp<ObjectType>& tfield);
//- Store the given field in the objectRegistry under the given name
template<class ObjectType>
ObjectType& store
(
const word& fieldName,
const tmp<ObjectType>& tfield,
bool cacheable = false
);
template<class Expression, class = EnableIfExpression<Expression>>
auto store
(
const word& fieldName,
const Expression& e,
bool cacheable = false
)
{
return store(fieldName, eval(e), cacheable);
}
//- Write field if present in objectRegistry
bool writeObject(const word& fieldName);
//- Clear field from the objectRegistry if present
bool clearObject(const word& fieldName);
public:
//- Runtime type information
TypeName("objectRegistryFunctionObject");
// Constructors
//- Construct from an objectRegistry and dictionary
objectRegistryFunctionObject
(
const word& name,
const objectRegistry& obr,
const dictionary& dict
);
//- Construct from an objectRegistry
objectRegistryFunctionObject
(
const word& name,
const objectRegistry& obr
);
//- Disallow default bitwise copy construction
objectRegistryFunctionObject
(
const objectRegistryFunctionObject&
) = delete;
//- Destructor
virtual ~objectRegistryFunctionObject();
// Member Functions
//- Read optional controls
virtual bool read(const dictionary&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const objectRegistryFunctionObject&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "objectRegistryFunctionObjectTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|