mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
5148e4f860
- The logic for switching input-mode was previously completely encapsulated within the #inputMode directive, but without any programming equivalent. Furthermore, the encapsulation in inputMode made the logic less clear in other places. Exposing the inputMode as an enum with direct access from entry simplifies things a fair bit. - eliminate one level of else/if nesting in entryIO.C for clearer logic - for dictionary function entries, simply use addNamedToMemberFunctionSelectionTable() and avoid defining a type() as a static. For most function entries the information is only used to get a name for the selection table lookup anyhow.
103 lines
3.4 KiB
C++
103 lines
3.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016 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::includeFuncEntry
|
|
|
|
Description
|
|
Specify a functionObject dictionary file to include, expects the
|
|
functionObject name to follow with option arguments (without quotes).
|
|
|
|
Searches for functionObject dictionary file in user/group/shipped
|
|
directories allowing for version-specific and version-independent files
|
|
using the following hierarchy:
|
|
- \b user settings:
|
|
- ~/.OpenFOAM/\<VERSION\>/caseDicts/postProcessing
|
|
- ~/.OpenFOAM/caseDicts/postProcessing
|
|
- \b group (site) settings (when $WM_PROJECT_SITE is set):
|
|
- $WM_PROJECT_SITE/\<VERSION\>/caseDicts/postProcessing
|
|
- $WM_PROJECT_SITE/caseDicts/postProcessing
|
|
- \b group (site) settings (when $WM_PROJECT_SITE is not set):
|
|
- $WM_PROJECT_INST_DIR/site/\<VERSION\>/caseDicts/postProcessing
|
|
- $WM_PROJECT_INST_DIR/site/caseDicts/postProcessing
|
|
- \b other (project) settings:
|
|
- $WM_PROJECT_DIR/etc/caseDicts/postProcessing
|
|
|
|
The optional field arguments included in the name are inserted in 'field' or
|
|
'fields' entries in the functionObject dictionary and included in the name
|
|
of the functionObject entry to avoid conflict.
|
|
|
|
Examples:
|
|
\verbatim
|
|
#includeFunc Q
|
|
#includeFunc components(U)
|
|
#includeFunc mag(Ux)
|
|
#includeFunc mag(p)
|
|
\endverbatim
|
|
|
|
See also
|
|
Foam::functionObjectList
|
|
|
|
SourceFiles
|
|
includeFuncEntry.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef includeFuncEntry_H
|
|
#define includeFuncEntry_H
|
|
|
|
#include "functionEntry.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionEntries
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class includeFuncEntry Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class includeFuncEntry
|
|
:
|
|
public functionEntry
|
|
{
|
|
public:
|
|
|
|
//- Run function in a sub-dict context
|
|
static bool execute(dictionary& parentDict, Istream& is);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionEntries
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|