From bd9826dc2620f73973ebbb7f07426b36b34f1c1d Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Thu, 10 Aug 2017 11:14:10 +0100
Subject: [PATCH] ENH: Corrections to doxygen help

---
 doc/Doxygen/Doxyfile                        |   2 +-
 doc/Doxygen/OpenFOAMlogo.png                | Bin 5622 -> 1130 bytes
 src/functionObjects/doc/functionObjects.dox |  97 ++++++++++++++++++++
 3 files changed, 98 insertions(+), 1 deletion(-)
 create mode 100644 src/functionObjects/doc/functionObjects.dox

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 722febb968068d28a82262b316a4a890e1a601bf..491d00780800cbe1788b4d73806cd7f598f57c4c 100644
GIT binary patch
literal 1130
zcmeAS@N?(olHy`uVBq!ia0vp^=0I%9!3-oXoo%iMQY`6?zK#qG8~eHcB(ehe3dtTp
zz6=aiY77hwEes65fI<x~7#K<o7#Ln9FfdrnU|<k0n6oR;1}O11z$e6&f#E-p2_}Jz
z;f((O|1Y+F`y!xU{YrxTf*Ba<Hmol=TPVBw+?fPMi8YdwLQ791&gZ)je=10A$09+d
z;GK(wF2<b>Q5RnoyF_?pSxlJNQs(IJ70W~-qC}TRYV0bn(3EaJ?|(9Yr-YaHj&2#y
zWX2?KcNag&#KQYP4rhT!WHAE+w=f7ZGR&GI!N9;I=jq}Y;&FWLwcO}i1|n<^)L*UI
z!Xt8L*@_0PMH&_^0)ZhV!twwA-#7HVHNi|h*DyZglFjwI)6|wnM8!q!(ba$0{(0`U
zuB~%k>)yI^M`}X3*g4Ce^BopSG)U@CEIwM=z`9^_;Hhh;W}nlam!#2QT~hzwaoM(A
zM=j?i-w>M~dGq1%mAt#F^X~B*vW8_#HhujRwo##&>yH2V#P0|0ib<NW^GmNhShaJe
zc8g`3GUK+s%S9HPI~1<lon_PVdnR$tsL`%mL}dnF*)ETVez&Xq8dXyshpele$9L_&
zmfjh|FDey{D(5VNKOerok469O1Bb^UeTf<ewN(oC{wyiIAkX=sibuQro_R6X9!EC6
z^Qz5(ey0uZs5RJ`Us2C)7v{X@>rk}VZZ5au`+H{|DxPvJo@_1sqF6Y(@8Lex1JM$9
zu5|LbSu<L6H8&qmd!w{SxIp<}V$O`>jkEi{9=pzT<-g{n?x!L*x^0*z8yAV3uzaj)
zH1Ez-#$R(j@=5;vxRl|!cJGs(IZV&Be<!}0*?mdo#W9CT$wyXKC>|_WtYWEk{Vj*V
zjT!9zzFFrLr}20RO(}hT|H|TT7Fizbx-!bw%NRcG%6j}F#<^)vUvb~PLnm!Hj_dxM
z`KY+$<N|i-cA-E2GakN(;Ru`eU1yH2y5srTH@!Bb1|P3e-N|&jE&J+|uKcxj)>Du8
zOTDgGYxOzp>aj(ZZPTycd_DW`maj*CyD$HfY5SM8g)4M&p@-B%VDeEdag8WRNi0dV
zN-jzTQVd20hGx137P^L}A%-Sah89)^7TN}eRt5$?vWz`ZH00)|WTsW(*3fC*{S~Nz
N!PC{xWt~$(698vgyp;d|

literal 5622
zcmW+)cQjnx+r2_$lrTgYL?>E8CP73ug6M*n=z<YMi5k6&Fk1B9Mu|3Fy|+YkCWfd%
zw20n&`|j^M>y&lRTKA8$&wlpv>=Uk~p>&s&krV)cyUH(LXoKr8I0PWKz`6a9Ee~8s
zKD^X-0RRehaAXk79cLiH%{#8j>I!%M5I{)p(KY?+v<A1BZFJwb$~)TIqa0kpPXLg2
zM!j`KS+ae!akXYsQdZZp6hz$t09rfc7jn8D(_2QKlE2ojZzNZ}lkSf|<9eSP&<w#M
z=-donL)5ih(v#Lc(b@D5>c-DJ=^rbvDP~AZf?LHQ_@|gc*!f;jA#xSM#XeU{oy6=k
z_BgpeIyu=GK5J=NZ}!Q$y7I|7Sv`=P58jsYy3IJ!dqE#jNG7~LPql7ZRE#Ty1KqIJ
zo^VwHc~N}My3pNP8NrdOt6B(x7n*ZI^dz$LC-jL!jjh&EvWaX_qsx?Cu517=^&`c9
zvzK4=-$o`qT(D&;Sg`$XxSb5hb-;XrEAA{)0wIW>qu+1dOcVzud@Ai!(-f3Q*xO~#
z8+ja~bmr{2sxm)}tboe3cxEBkAE!37WNa^CTFn)bi8WP-t_p&f`6>?sfJcn#y-Vz5
zWSuLK$Mv|;v4DE_L<cqU)?Gg|v1ZzBU9M`$M!ULLoRTmj7F(Dlb48J6>K?|zplsS|
zV1XCb+TgpsHimHmAy8?*jI(2g?b*^_^+IK*D&O&Qv}4oR*EpCc8TkJlep(q%MAwU!
z*PEDDg2hGajka^g6ydS!&0v<>D5FO*QpeM^?^jk<VpwGy92^R@i-Ye_ii(P6N&7aT
z(PRn}oAU4Me54tzIbL2I3^B}%9}U*H+FsAHRMt2mg=}qY;||?caL%L(yfo8OQ{_{z
zvX@2GmFxQ}s?VP{Mnwsgl)eu^<hHf7RaRCeCMGsFH?RD&X)Uq;w>?zvI8O{beLBi~
zq4{;}#CVw>3V{ScAw>5ch+$7{OT`PyPV_r$?74O9XPXj5`d=}OIjkB@)jP84KWfBR
zWMgCMar<tDGFml_>LbOTpTFu3F1-p0GLTAMcs9^8-7=r_$k?=Ov(hV?3Dv#uVQld2
z=455ja6zxHo0x}%u5LnH*{0&m?Hy7UI}wx2Ad_|vGe^gm%C7|^$@eC+)pYabkE*7J
zhc$dkF_?J&dJPoc3ARY^&402!OjJ~GtB9~~W=b!$I*Q|qy6TgXlIrT}<ijYuuUi(z
zhYVL}SMF036%@GnzkI1;YinuAr5<zCDQ92qkCY9d1K2{of3KBFu5Fcj&^ZskIKIu7
zK@bof?VzM|2k})iTbd>U5rG)?mM4^-Le`$_>tPM_4GmT2*4Njg8AWW%f(bF2*?2s@
zs;a8LUj=AzJ4iyK2mTJF(^pLASJkZ!XMTr0txW}fo;4k~cCF<=QCjj4IE-96TZo2~
zB<RlvvCvfd9}Ta#NJvPC<bGNU=W6jnAz#NF0+i(+eYi^AqhGWUW{l}M*xlVdIAF3|
zV=HE}E|&7#xAb@;mfX|ovKpP9Zs@GSZ%ui*3p3=!{AJJ6Uf8qXcyMcIr}eFb%cnXN
z`hL;_8d9QL1i%X=C3G_7Q9<r{QjZa(U@{rt<>eI^7&t75)s`}H60pE!NljFk@<7Z_
zwr7ovjRo4K3ngdB=mptA?(>M<lJzo}W<}mWv|rz&7Bnz0fLTaq`|mAsCu*sxs^5bU
zEuxUQhERG2Mt}CKPP1K)mOp>~utvXlxj+tl_6znUY|~U$9+{Znf#hMa4nym&Sr-|b
z^p+#cLq2%CsW2WfCRJm!q3XRMzk7E+$9y1Jh{wsw-aa!mb!~IykwkphjJlMYAnIuS
zmydL|MiHynhnzAtW96*ZKlDL1!<HCE-+6cp{s4xChMd0S@=tLAYU!f(`^$YmY<fJ#
zsGaNC+FEtd`T6<12Wn8#P*SO%!`&r+j5~?sT;1Gm6BA>NZ_4A;?oNur;c#-|V3h(Z
z6sn*{$)^D>`u~BuRW88j_NmSxlcPt+lFd`n#PPkGEAC?qixdasn`KU4W0%po(%*io
zfxok=pjtUM(vYrfIJW8KF;KBH=4jeUr><`*W8b$cTo-C2rl=K$HQxb*B^?|5L^Q&!
zE`NB0K-WYflymQYRZz&>+T5fe4FzK#?bBZFxT$4AXm~*)fW$5zoI!FiN-@Xe1iH%w
zKfoSae~FB7j>EB>y&Y|@!>WF!sNioa)F6AWdJt!!!2&t=+NrBp^p`l^b-;2AMHn)8
z+Q2Ct-h~hPy*JiSaedP}E_HJ#<A45h_L8R7+-_mo5r@w&OH<*|)#Kpwm#5)^Lfkhe
zbEB{S8s~y!0e1h5U=kX1_9r^Wn-UUqfyYmuGTDi+eD&>)VhV%u3kkKyCzn-yj*gD*
zbD^`bu_2Jv){dhd8XQ!MtVE;HzdwC+sZB_*41sog{D`1k7p`inw3w<w@n~d#u>js<
zqC)C-yQ0{NxcK;b`x#=u^K85x?cg|7RnXX||6~hx0cU4tC;lty?9yiHaTLbtKHs9x
zd-NNR-v_aF%2?w*^0_$P;^yYI=!uqcbJ(A{$1Zbqs<Skps2uwCdl<9WhmOT1<p>6*
zZCVSRF7T)Zjs<_#L+eB-fRyxfiD8o*tC9lMWEN>37(0!(wEK9Ae=k254|jcSEkQtY
zv&5O@9zEK{*%^xX^5u(n4^D5Psm;%REC%j%n39o^0iILA_Sus~CPv2d$LC^d7Z2B0
zuSn$^gjf?3W`(}PHvaunJ9$%L#cAVJrX2s^%jh#9A<fH-PBSRcNQG(p(n1fi!esXM
z??J0-snwzMXO3Bcfdl}}9ItEE)@A<XrwqU6{`k?+_%40_tLx$6VKTahW|e~kIV~-}
zCwh1!U!>iD%0x|+TT$V^-iytY_$b<Dw^=do-y6$rCz`JNwd`xg$yCegF9i^RwTO}*
zlkWC<4)~_>G#Vj2zO^-uww1-j62Fp0msPyAaOB=B-rJehe962Io+jfjeP$UqunLj@
zwp5C|v3C5bwRZofO;^TqEO7b*O<#{SPBK-odx+?r>zo@4n3|g6lh}BnCBV<WcyJ0l
zw(N~HIf@PrCIrkPcYZgHN)^NDAVkc}%te~n#Ih3Zn=gAGl8SrSu6F9^KV$V6KH(aw
z+EFnr{>_hm(tiE-eGnTI5g2HQrG33ciJo>j?Mf_LT<VDdf#wK_zW?0$=|-L<KT8Y`
z6as270&$#9{)B{#tXWUjZ7n99Bvk>7>W6e_m4baxmW(?|VN7)Jx*l72-B(`jhviED
zgDs8m@Y_Pe32WKpv|ouIKPTDD_0<KT>_929w!jmQ#$9ckO&m}m!0e((SGTw-I4lVK
zoH`R16x8s%CXyR_=B}149o%Pmt7BzgKQ}2p9SwJPap4@{6WM5@|GB=-zaR8t-8fc_
zd?;DSw4c}t_%jnVZ+GgB<~krFeLmG~qpGZ2TwMIz|2%eL|7Z~jiWf&zXO@(=sQt9A
z!OSh7q7eb??(H$aox6-;8bO(p__!UBy~!SKhaXN)Nik~jaGHF{<m99=y!}?(*Vx#I
z3ZX#Cfxo`aBp@(=Jw}{*h`C%>xxbF)(X+)jrSGh+7L}F?Kq1S{^x~Oq5{Jk>9<cJD
zi@MeP5z}E+oh{`}4B(iuDC^eu*6j}UI|2y&ug_M!rpNxew^>ga*9o5+31{PET>cKm
z{Yp=KMg*iN$}?{=KdFB5^vRRDfq$0V88!~K_>mE(v;{7A;}xMCM4&YX-nzy_#Ch_+
zx62CZ>QQ3?EHORim2HP)2}h6HZmzxg6C<GF^u8MS{KVvB!hoo#sF``>7qNS)HukDF
zo!LH>r(}^%DAdYOnJPYsXlZ32S#>dzE5VAh8zkJ@$eC#|_1cd#jd{1E87wf}idwqQ
zvuv4b6(B3i%Ulm06z1o14aBP^3%=E8)xGzEJY@LaFJ5wHaow>nN`4ffF_2SHwA1tx
z8Tk}=%nWxw-CY2*3=O>{cwS{{8?83nlC`i{ii-4D>)lEu3W){D+$z)DRw=(dM(rk$
zDd#^h89275w{J>Gc}69Z8OT{yUIy=`O{BHQ_4kD_Ffc5Gk|$6`d=j6&i&ij=9eD5V
zUZ*=kBqt^=-tU&7%sKMw*RN^*n?E<=H-eE=-2qSvvQh1C_?lWd=6FTXY(>lnEgFjz
z#KX51Ft6tKlz&|wHk_Y(0Uw;5%_;vam>Z_83mP@Vwou5hU^N`#c{Inz$Gc&w<+<O+
zn>IJ?A}g!W)zlM)W1{ewd**K|7&)^Py9uKTy0Z|uu^Pcf3^pQF4f$`_ppx%BM8_uM
zEUzr57Z(?QVsa}aOmukTc5er%)U?>XeUiGhwN+u#8fP3stTL7x=DV`rRU?o6rbdEH
zh^*{$Q^4dUNMzx)&=C=gaPzK>iHd@ztiwYTlELY|hUj&%QAx>*%bu~CJMNg_EOsi%
zHOF{c#%a$X%02`L*SA0l3JP*!Olj!`?)UG%P0e0bn1tj!DYJ%I>*kEjjEt<x-!(PD
z6k!&Ymdld!hT%^IgVGusd38@W*Q)14_5;6uc|fRcxp^PPz`&<s?da%#ys00#7u<hG
z-u?k0@cagf;L*&|)!zo?6&04$voxA$U^LZ`moLBw&EcMtj78b4SJyba?>A>>)+vl`
zI`8i8=34PRJ}l-6Me>0+v>ckMf8xY69Dk9@kP2ZZ4W)*`dS@D5*{*=a8_a?~v48cz
z|K{qXHvMDi!`>fL+!qG!^76sUe%9LB)ClYKv0{~sz3tnszZ;x%gMa`KVH3Hn?x<V)
z-@3aM>2NA7zI*2E<8L3s@*i1Nz5y#)<~-Sl4<EjHm}HsVZ`?I+cF=(^KVUmX_A^xr
zJKd<9UfPC7McthW*~~CH(h<>}<sdj8QDRkgXf#o7`L=q%M?;!CU~gly_V1r{ax9pc
z>*_=WlU0cqUZ3aY52nCD&Eg2b8Z~k-wk1sm1>FJ@bt!ruim`6FNcT6lmnvD-P&PC)
zoDMb3kiO8)3<@oGOHIv#U7hYNp;S8~f>RX~6o3HU&s;_3gK(HHcpli*qw5R9*Ptz8
zx_0@^xykbgSFqI@UeLE@%H1Qr9G}Y<kIQ&Y2q-Iu`=tl{Qlq73>RH-@B0##v;V?MG
zcpa~yG!YQ@{OHZ)%e@{}Q02kq9Eaf<Hu-8E-)}t$mLb((t9r5Iw|&`|ltjlVkAcTa
zB^cH^u!#5AYd9&x5xl~}y3Aiw86VfPoHn+$GP8GCRfqYB>$@v>Yn_<|gl7I;reu{S
z0!Z^<OlU|_ZSB$4O#RHvjEaiNX3;gPtbHNR#3C=IP?5r7gH|<ubKaz{OP}m6`7P5n
zAAKDim!rjs0lhNqMkxsJ>K&$6Cn?+aSpVbaZ7+UhjLh}vlCd{}X2rs`!{_?)#|S1D
zfKpNAQriN%Ckp<!;b8}B>(eFeW#JR<a3q#3q);Qf(0M7}d-~D-Rgz@5*6Y_tOLMY`
zl|37csXgDn7whtOPtMPq3JPhcY9cKuz}SK!9@444`vcj}O-$tFpkeiY^(wbuV)T{|
z-S%|Lxs?5Gg|R@TC$#V`P)K~4nO@`7hu>vFcHnR^%bId>a)~Hz{-a<~EEiJq>C>n0
zgd9mIA4G5!x)`nUcE0zu2uq&ui5pzLN=5p&%hs;B>A!F|TV7o`NMog=Pd1C3o&Bvl
z+{8lXH{a$9vk=ep105Y}8`9&Oo)X%?)O~hf0F9&HJ@et=DM~#^8i;zr!~LLt+dGBv
zv1YdTEFK>Or`zc#2msB?e4988DL4DV{%Aj<QGr#=m5p13o1b6BR_DlAS+iU5MK;a&
zGi_W}LFo{FuD^t!Bgo(G!-o%l4$i>jkd<{{ke$HyYOdbb*VR=xQ-hu~G>(TQq}&Zm
zrOQyUAy;jaJc5Dl@o_r#5CSEIE35`LGmkh&hy%@>nA2j2EZbuS>;1JCza(s=a;#+B
zu=8oPMuN$Tn5*|Y?QQ#6Ld}l7o?iYFGK8S~JB!)-NY8)!w)ivrAVO4ldV2cu@-jaw
z`}}P3%TG=SJ0T(A&e80bcX{(>tgMcB+{w|AufBj(5#`po=nhVjH1wNQHTMZ@?zshL
zyS@@cNpan7_wB#6qv1Utrcz>{Cz_das2ihH`_xLzSo|QqOvA}xk>iA~{c@j74r(O$
zaUe-n`Br>N%1de{C8eGiwer_VFNwRU5cEPO+C`thJlqLGB41~VIZ?9<+cz0xi@oe2
zpRk)&C>o_;5r+V4Hfvzl)6?TriWYvxdby~ul-c}oJ9(B~LJ#y5;h#?xUX3q%&NDr8
zQ2Pj5sO@;)9mx=rEg9Vo)zlCJ#5{I$bg6faX2?iMon2f?OH1G3(ze#u#ohXK<K-TN
zhKBa_^?`Ff50zI<PpUL&C<00(2aPBrDb6WG^G8>*6N!i<q@_t4)*o*N^S(mO>82=t
zr^a$UG_I=2%gbwR-D=)xn*pC9b{D?e+shPa+tAX|qEM*C>OV9urjD<U&rGo!3^!;F
z%Ff~RXPTMRnScF?o81gSEJ~3T)VQn7s*bQtfhzW@;UOX(A*t4=^73*YX-c4_rNy%K
z?i5Sxy{zN8|9ro7kz5>a3-Iy+0ibio<F)yiIXN+}1(1&pDYWoFpzMEdzkj+o+2P^l
z4*di+_oeS09cDMzSML7t)g7!dE-1r}h{?%GP)QF~aoIBS-!0S9(m==XS*oNb_Y_pu
zK-r&jb6DQ}sku3grg|S~Q(t644k<xLFT{U)wmC&XRh3NN$WhbXRflGYiXKnu_nYZ-
zqoUneETgcn5aiV5r4L^%Xb*1RzOAhAXZvqa>^$p;jj#wONq#Oz=KO#EJ*Ku@4kW2M
zu{`RDVogp+Ap(Ml@5UWLBqSvI>Qq@M65H>Yqjp@+TSjLu#|8%@t1eJSZb$0s>bm@i
zKg{n6!&BkD=b-Ye3!8yu-P}gK#I?Jy2=~!kt2dDxIm45#&d$z{EBxHqoJ7oGjXr1l
zDJdxt5fLRNC1Cj>FE8)na*+D;U6bHp;!=ZphP9cQY|&_K>VC|#XqKl<rKM!R;nC4A
zR|S2gb4f2Em`+Qp_f^ztnSM2h6Cevdt;`|D?Z{2)?DVaytlZs?(ey$rk{+^t8PBYL
z=DZpoci7&x;_T@wEGaGJ#1z+MA9FxjJoXkrr@#>sf?%&N{)EMCTRgV>JD4iTf*aS<
zkXB88xaBiT0#v^nc)o3AW1~DSci$x7<S?B%8S_olagH1S9fpU0{(7s5)vY01jExm>
z-}5xnMUQ9ue*WQK>*0epGEYzxLZ~<C#Ram2Up^8OtJCvFzIy+mFfdI~SnERbP4NYA
zd)&2BagK9r?r%t_;x%%`_sZ5%{?{V__P9%9^arD7yVmGu#r)-Y;mm^ummkCF|9g;C
MR?v8XMVJNsA0w^+L;wH)

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 <http://www.gnu.org/licenses/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\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.
+
+
+\*---------------------------------------------------------------------------*/
-- 
GitLab