zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

functionObject.H: Updated documentation

Browse Source
This commit is contained in:
Henry Weller
2024-05-29 12:20:30 +01:00
parent 5f80ee7f10
commit 2bb0f6b75d
1 changed files with 14 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -34,26 +34,22 @@ Description
\subsection secFunctionObjects Using functionObjects \subsection secFunctionObjects Using functionObjects
FunctionObjects are selected by additional entries in the functionObjects are selected by entries in the $FOAM_CASE/system/functions
$FOAM_CASE/system/controlDict dictionary. Each object is listed in the \c dictionary e.g. to select the \c functionObjectType functionObject the
functions sub-dictionary, e.g. to select the \c functionObjectType following entry would be specified:
functionObject the following entry would be specified:
\verbatim \verbatim
functions <functionObjectName>
{ {
<functionObjectName> type functionObjectType;
{ libs ("libMyFunctionObjectlib.so");
type functionObjectType; region defaultRegion;
libs ("libMyFunctionObjectlib.so"); enabled yes;
region defaultRegion; startTime 0;
enabled yes; endTime 10;
startTime 0; writeControl writeTime;
endTime 10; writeInterval 1;
writeControl writeTime; ...
writeInterval 1;
...
}
} }
\endverbatim \endverbatim