mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
1804d3fed5
- use `#word` to concatenate, expand content with the resulting string
being treated as a word token. Can be used in dictionary or
primitive context.
In dictionary context, it fills the gap for constructing dictionary
names on-the-fly. For example,
```
#word "some_prefix_solverInfo_${application}"
{
type solverInfo;
libs (utilityFunctionObjects);
...
}
```
The '#word' directive will automatically squeeze out non-word
characters. In the block content form, it will also strip out
comments. This means that this type of content should also work:
```
#word {
some_prefix_solverInfo
/* Appended with application name (if defined) */
${application:+_} // Use '_' separator
${application} // The application
}
{
type solverInfo;
libs (utilityFunctionObjects);
...
}
```
This is admittedly quite ugly, but illustrates its capabilities.
- use `#message` to report expanded string content to stderr.
For example,
```
T
{
solver PBiCG;
preconditioner DILU;
tolerance 1e-10;
relTol 0;
#message "using solver: $solver"
}
```
Only reports on the master node.
102 lines
2.9 KiB
C++
102 lines
2.9 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2021 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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::messageDirective
|
|
|
|
Description
|
|
Expands string content and reports as a message on stderr.
|
|
|
|
For example,
|
|
\verbatim
|
|
T
|
|
{
|
|
solver PBiCG;
|
|
preconditioner DILU;
|
|
tolerance 1e-10;
|
|
relTol 0;
|
|
#message "using solver: $solver"
|
|
}
|
|
\endverbatim
|
|
|
|
SourceFiles
|
|
messageDirective.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionEntries_messageDirective_H
|
|
#define functionEntries_messageDirective_H
|
|
|
|
#include "functionEntry.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionEntries
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class messageDirective Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class messageDirective
|
|
:
|
|
public functionEntry
|
|
{
|
|
// Private Member Functions
|
|
|
|
//- Evaluate
|
|
static bool evaluate(const dictionary& parentDict, Istream& is);
|
|
|
|
|
|
public:
|
|
|
|
//- Execute in a primitiveEntry context.
|
|
// Reports message string (after expansion) - does not alter entry.
|
|
static bool execute
|
|
(
|
|
const dictionary& parentDict,
|
|
primitiveEntry& entry,
|
|
Istream& is
|
|
);
|
|
|
|
//- Execute in a sub-dict context.
|
|
// Reports message string (after expansion) - does not alter dictionary.
|
|
static bool execute(dictionary& parentDict, Istream& is);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionEntries
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|