| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2018-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::functionEntries::negEntry | |
| Description | |
| Negate a variable by prefixing with \c #neg | |
| E.g. | |
| \verbatim | |
| Umean 5.75; | |
| . | |
| . | |
| . | |
| inlet | |
| { | |
| type uniformFixedValue; | |
| uniformValue (#neg $Umean 0 0); | |
| } | |
| \endverbatim | |
| Note the space required between the \c #neg and the '$' | |
| SourceFiles | |
| negEntry.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace functionEntries | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class negEntry Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class negEntry | |
| : | |
| public functionEntry | |
| { | |
| // Private Member Functions | |
| //- Lookup variable, negate and return as a string | |
| static string negateVariable | |
| ( | |
| const dictionary& parentDict, | |
| Istream& is | |
| ); | |
| public: | |
| //- Runtime type information | |
| FunctionTypeName("#neg"); | |
| // Constructors | |
| //- Disallow default bitwise copy construction | |
| negEntry(const negEntry&) = delete; | |
| // Member Functions | |
| //- Expand the functionEntry into the contextDict | |
| virtual bool execute(dictionary& contextDict, Istream& is) | |
| { | |
| NotImplemented; | |
| return false; | |
| } | |
| //- Expand the functionEntry into the contextEntry | |
| static bool execute | |
| ( | |
| const dictionary& contextDict, | |
| primitiveEntry& contextEntry, | |
| Istream& | |
| ); | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const negEntry&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace functionEntries | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |