diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index 771dc8f14b..a032193806 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = "The open source CFD toolbox" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = OpenFOAM-logo2-55x55.png +PROJECT_LOGO = OpenFOAMlogo.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/doc/Doxygen/OpenFOAMlogo.png b/doc/Doxygen/OpenFOAMlogo.png index 722febb968..491d007808 100644 Binary files a/doc/Doxygen/OpenFOAMlogo.png and b/doc/Doxygen/OpenFOAMlogo.png differ diff --git a/src/functionObjects/doc/functionObjects.dox b/src/functionObjects/doc/functionObjects.dox new file mode 100644 index 0000000000..694ac1ec2a --- /dev/null +++ b/src/functionObjects/doc/functionObjects.dox @@ -0,0 +1,97 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation + \\/ M anipulation | Copyright (C) 2015-2017 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\page pagePostProcessing Post-processing + +\section secFunctionObjects Function objects + +OpenFOAM includes a collection of \ref grpFunctionObjects that offer users the +opportunity to closely manage their computational analyses. These objects can +be applied to manipulate the workflow process, and provide a mechanism to +extract predicted field and derived quantities at run-time. Alternatively, +the actions can be executed afterwards using the \c execFlowFunctionObjects +utility. + +\linebreak +The current range of features comprises of: +- \ref grpFieldFunctionObjects +- \ref grpForcesFunctionObjects +- \ref grpGraphicsFunctionObjects +- \ref grpLagrangianFunctionObjects +- \ref grpSolversFunctionObjects +- \ref grpUtilitiesFunctionObjects + +\linebreak +\subsection secFieldFunctionObjectUsage Using function objects + +Function objects are defined by additional entries in the +$FOAM_CASE/system/controlDict input dictionary. Each object is listed in a +\c functions sub-dictionary entry, e.g. the following shows the input options +applicable to `output' -type objects: + +\verbatim +functions +{ + myFunctionObject // user-defined name of function object entry + { + type functionObjectType; + libs ("libMyFunctionObjectlib.so"); + region defaultRegion; + enabled yes; + timeStart 0; + timeEnd 10; + evaluateControl timeStep; + evaluateInterval 1; + writeControl outputTime; + writeInterval 1; + ... + } +} +\endverbatim + +Where: +\table + Property | Description | Required | Default value + type | type of function object | yes | + libs | libraries containing object implementation | yes | + region | name of region for multi-region cases | no | + enabled | on/off switch | no | yes + timeStart| start time | no | + timeEnd | end time | no | + evaluateControl | when to evaluate: either 'writeTime' or 'timeStep'| no | timeStep + evaluateInterval| steps between evaluation when evaluateControl=timeStep | no | 1 + writeControl | when to output: either 'writeTime' or 'timeStep'| no | timeStep + writeInterval| steps between output when writeControl=timeStep | no | 1 +\endtable + +The sub-dictionary name \c myFunctionObject is chosen by the user, and is +typically used as the name of the output directory for any derived data. The +\c type entry defines the type of function object properties that follow. +Since the function objects are packaged into separate libraries, the user must +tell the code where to find the function object implementation, identified +using the \c functionObjectLibs entry. + + +\*---------------------------------------------------------------------------*/