File size: 3,877 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2025 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::removeObjects
Description
Removes registered objects if present in the database.
Example of function object specification:
\verbatim
removeObjects1
{
type removeObjects;
libs ("libutilityFunctionObjects.so");
objects (obj1 obj2);
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: removeObjects | yes |
objects | objects to remove | yes |
\endtable
See also
Foam::functionObject
SourceFiles
removeObjects.C
\*---------------------------------------------------------------------------*/
#ifndef removeObjects_functionObject_H
#define removeObjects_functionObject_H
#include "functionObject.H"
#include "wordList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class removeObjects Declaration
\*---------------------------------------------------------------------------*/
class removeObjects
:
public functionObject
{
// Private Data
//- Reference to the objectRegistry
const objectRegistry& obr_;
//- Names of objects to control
wordList objectNames_;
public:
//- Runtime type information
TypeName("removeObjects");
// Constructors
//- Construct from Time and dictionary
removeObjects
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
removeObjects(const removeObjects&) = delete;
//- Destructor
virtual ~removeObjects();
// Member Functions
//- Read the removeObjects data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Remove the registered objects
virtual bool execute();
//- Do nothing
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const removeObjects&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|