From c782b093222cc7a2a70f7365de28a7e1e6c1e013 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 771dc8f14b1..a0321938063 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!ia0y~yU@&K3U@+xiW?*2rbhf#kfq{V~-O<;Pfnj4m_n$;o z1_lO&WRD<U28Jp%28M<f28Le@3=9n~7#K<o7#Ln9FfdrnU|<k0n6oR;hJk_MZGcaR zD+9xS1`zlUW(;TY|NsAD>$fjrU|{eo3GxeOV5r-$zTj-3?CNu85*Q`cNKOhZJ&`z{ z??U{kAhjKf1et<&E*82NcREB}d{yic;gw}EVPZ>}qr+D$6N!itT^^~itGq%}y8XQW z$pD@bUfw&pWef}qj7i?^E`E}Uh4&d47&r?&B8wRqxP?KOkzv*x2?hoxIZqeI5Rc<? zujNMHG7w>Vp#Eyr79Np1%T_dSEz+=X5eN(^5sv@=|GuH`tqEr8xrXr>mu#-zou;-t zA}TI&kFNg1_Rn*-b#0yVTKCqSJ5m$M#m-s&obRwuqCrxBV)4<^2G#|e15aH$HT#_Y zyd;ed>yrBaj?1>~I%+vD`G(l^$eRz3ujJibop+DlkTon@vgzxmu#F1ETzCA>Cw@P0 zS4`53onLz8!K$4zwOcIPlo_}6T`scV+@WyY?kt;@-!qAGMvZpmA}TZZ%654?^t)Z< z*QlEEIAmSzJicrHwe-#yeo?7tR5@oE{Q2<xeJuKKA2>V?=}Xi&sI5}4_h(7z1$oX7 zRXp0|_somA_BgWnomXuR^gC^MN3Frm{EB*ZyD;ZHUx%W_c5}HM-`_j)Q1O&&@nmc1 z7sbNSeGm7k9*CB>bET8d&6?4otGW4j+8d=s!Uf6)6LV%1Z=But_1JZ$EB`eobw3rk z(QU&#*|<pLgymyZqj`6xGX9$Lkx%mP$E6I<wR@lR%wc-2{X6m1%<fAvFOE4(N<Ol> zLh)e1ViilR>u)&>Zp>i!_su%5IE}|kXiDkx`&Sl!v&iyb*OgJeUdHfgSJvYfG0shU z`ilGR9Xe^taa{N3%tyr~Cl|0ww+sFGpYiZT3`f|!?>cjI)g8~zzUj3gHTZa)>Q1KH zZP{0!bmgzLvz~gyU+Q(mTC2}#SC1{SY@2@l=Ihyiw|qVF+kN?;OxwS#EnK0K3q7PB zGB7ZxmbgZgq$HN4S|t~yCYGc!7#SFv=^9w*8k&X}nphcHSQ%Jo8yH#{82rdG_C(Q; bo1c=IR*73fr+N2RP^R~E^>bP0l+XkKXIi|K literal 5622 zcmeAS@N?(olHy`uVBq!ia0y~yU^vIXz@W{+#K6F?|BJ#R1_lPs0*}aI1_nM~1_r)4 zjQ76H31?tnU@!6Xb!C6R$iXEnw(G^g3<d@U+02lL66gHf+|;}h1`u#AN=+<DO;IS% zEXh!C_w)@&(Mx4#U=Ypmba4!+xb-%s(&p;RfB$WsS5K3<C@|@SWt7NSi7v6y=ui&d zpyJunUbcy4o;njU`L@xiD{Hr`l$<rqFl~~P)=lXaMa@7#r-iPa79E>yzxTi2dAzVp z_xtzP=YH<l^J;g^yuW{I=6!$u+2(%pJKHK&sf#Cmi+3&KHu-d4@KyZsmFHI*G8~iG zd%V+|(b??Mf>-*yTkZ8O{{6d^!%0J6!FLv;o`V+zjPkZ*1$><z=dgTd@y(ot4h<SY zx^6G-{+Sq=*fUM%VV1(uhgloW?dN7#n76pi(Cz&beufsO3zrZ7kGQ_FaZ20jgFgOx z)>A%yP+WA;px^yxQRQ>5`{%;f3pnnnoadxyFmuPAIqx1X-kan)oz35i<?qraS<Q`K z8W?n?d`~=9<mNv3wCCIQ^OvtQY%iOd=fku2LtQtU|18!JmCZIgbGA)5?`|TsZr!qZ z_J8?i#h10qNqWZbjY_^`67X8{-@jN1Wrh|3ySh0)ze&EkyZY*O{WU+l4qv(_dga#q zf9EC4xVKF>&#onEU+HwjWl!jv#d{eaJ<52!?^pf|lPmw;G|RE3#^~DHe!I0b`{~oC z{qpvCd3no%RyMQqo0*x-v#Z_J-OcTK{f%>aPK}*ZhLXqc&u1lXU;BDyOG(zhyK)=1 z<cI5LWo1qJQu_3K5tplm$gP_<*WQ#^<FS16##f)7dRtoV?CsTGwK}`SY2m(o`!;Ue zICbjO-Me=`eUZ6$Rql&-XSe6yXJarnzAXFOf5nyWu}`!FI5?UFI9P<$EY|(VT5Yv- z&G*OynYpULxp#L>H9Zw5c_r_8%+2lj@{zhbFRh=yu7CUaPo>fJ0b6$ZUR+t(u_ENm z<G`k-DBI}|%}*b{wdejc-PrgwZ#Gu-Nv9rrSa9V`;+q>Am!DgDqPEncA~_^v%A_@K z+-|eJ=aS1YjhovPx4$AGKfizDilv;>g>TIF30ZXi>!w@h&iU1>Uc7j6{dT`p&F|}$ z>qTsEsF4;FG)(JiKa}9^5pZDT<mE@UPn$Mv+qP}a?R?e$_B_0HHu|aPQyISHOP7|` zdw6(dWu>I3`1XH2=$N~<KHQ-}j6tF0@Zqht)3@$*R6BUz@b@=X%{hz>eSLZE?(9x0 z{O8+=bUAf7ovU_ccD@<D_4}u=by1Pg(cbr7y?WIrWtz37nR&7Q{7aWEZQ8Wy)G059 z9i^YAb$6eBc6PS-`ddpjZF_!h?qLbztuq-e{M_}q<jBhf0;vJc9EK7+cJuW`xHy|0 z6j-#*6hFEnP=%9|lg05uhRMPJ4FQf7SMnM>oplTTPX8$WDAPo$|M=$*A3l8kES>UF zVWmRGO54g$DHRbG(~s{he%?2Gc65=KRtEo{4-(NDi=Qbj3VQf4SxJrQ?EAfm*2Qhx zQoCiQsflp0FflT?xVv{x=l{BN;j3xKWBB!^b2C&`RW&v?p3_?wWE)ecoqT?t?e+EX z>KsYm-`$Okjn&?FYnjb$ZgD+@78!L5CWor1Tk_%mIf6okh4iALq9l^-=GT9Gq&hXg z+uK)|gXK|b_`+xbaY?Cq#d!x4K2+>^@Zf=bpNq#s9)^y(=33@`{+^x}uU}W^ShQ|k z-q}~7@{go;g+1v?YAL9QSRZ>amdi&fQ}D!p9$w!23zAMx*H<r0%gvoTbLPu8Pj#&) zx8L@)E!9i?`s!+p-F(00@)iXP)+oe!&I>&nId$q(iN}(c(<>^@9A!9r_H5zAg<3aN z7<^`%<$ii{l3~K^$%|w5tC+uhxq11oU%!Oad<3{!xoj_-JGSaU>_HaClG0LEHnw%K z|JP3P;k{vIXlTg8*6g)3Ej4xNarc@XhGyW5`*y9iRB79`ytzupgHseLZQ}B?OH0m| z_siKTaU4onaB}C7m{;!4PNkiGcGr8F&cmXeB3w^j=kE(!Bq^vUwZK2eZsw~up6jyr zyZ&3|H+6>3vi9BV3??@DJL*jRI@A6ft!NQ=Y1-wvP-caz>)f|*-iUCunwgn(*X&=L z|0W=gIr=xJcKEs{pMP>JT<qTejfXMh$<m`wmL8q3{ZDv*(WLWoKNBzS-?q-XgKxdo zzGZ&g+1{TgCHu*7{Hl7tZT+Kq>u(?O)+wFsik7U*G~~}q?>tkN9qZ>+5^>_1?f)<K z^}jCM{Ufq9Dd*v>{PUNVteNGd9ulUcT<<KRBEV7h=ElOlf6rnUR#jCoe0Xtj@su6G zpROOgwrk3i5C#KdW9b}IxfQj?dZpV1wDk4&PoBPJQ%7H4-^pUJ%*;$ihoGQILTAsM z@#)#v-Q9hst-N^alqo4K0>>(jc8R_+*|cwC^36@D>V9(`6j)51I(4e+%)>d$C#;_| zdGhw$+iVP#Kd)`?&da~KY3a_Lkw$MNej6$(DzZH@D=OX>U-7kFzU=;<NR6*|E?xTc zI)7i`oR_L!Ykq%wtE#G+e7w)LH1E?*VMY7DKY|~hcJpjaJlrm8QE=eVW6v&0>35>Z z!ACAFSre7N^uepvZDxE7GiJ}WJ{PwjZPilm>2h{85{e?#c4gQ0)Su8&QCHo*bt_}T z?%mcuQ$C7!7Z()?I8B^5vHJM=u!p<$)#YC4H>~<HW6qp8XU_PzW|<p3l9rPCW$??w z=eN$Q=YP4Jcj(JcopM+Iu*B;ZFMPg7tV&bPtXktaS#9EFbA5gPKXVQy2(VmSAHV<c z!{g!W<L=(Mb0%%G?env<&GY9qHZn4Z+|wwT_x8_{KW%gBEbA{_zC8IzWc}ZN=gytu z7Sl=Cc!qJoo;`Q2A6K_=nf3qGt5-rS3)io&e|2KrT<dbPeK~K|->*M0K{3Z{cF2k~ zE9QK^x##&+*DguvmtCul-YClr%e%B|?JN=fFwK`QmG(V-^k`Mxs-4BpFJ+kYe7t+9 zx=1wXaneb{S@!jIKT{^1eqL2oCGmK5`2URj6#*}0E@U2=W4Vsu$I))_?dxKv#e3!G zIGwn6@ZOb%n>TN2TEBJ)(ALs=^!W#aLCT2<abNqIo0%CBdfwmJdD(WQp%@2?tgP&E z|M_eV)@5%zPUvu1Rb)Ls7#wLXUvcic%Gpitz2aBi(dstZ|L<9LlY)R#V`KC>(a^X2 z-M5N=9GSZ2(c|O&(o#}NEqyYUMaHierD)0Zs|#>!+O)~Z>Dz1`BTjDa-C-f6FZ*Y6 z&U7_2G}IC6_FDR>V$XxvgIp5QVuss}XBlo=p`og?)*TdVv!uQpdbs1e{F)oL>Q>ch zDRbZc_xCrm!|B!GTbEW|>OTMX_0Q{{1)a8S+vX;=?a_0+b9xLHZvM2=)AOtR$KrU! zyv%35UGvElrUOq;e_A+g^6YNIvf^Upi<+jdcZpwk^-Akg)6rM46MT5iPS=k=#g@kK z;CAo*oF8S~DxbNzEN>pm^!D^zxpJjt{jUkvKYe`^KHDr;srTSK+iJ7iTOm=mnHbjZ zbYl4M@uQ?+(UF+`ooCOUwJv|xHUEubXU?T_vuDhR*;P?^!$Z2T(C^&4M624^*cd@4 zS1zSX|NhNoWQ>w9aQabUQT%UHS!kbnSk|Rov)?~|zI^p+Z2^uaMdDU-_gQ}lKdIg? zZ!gx%w7Y!qfwax@ZL8TB&P&hZ-}dU`tDG;92O1db|NVSkb?eHrvV9phW4D?7iZPjg z-oE(RnMqe?Pc>&@nBnFu`$pDivyrip(YDhsQdH+;=4D;Fc(HKSLzS}Fr}_(=8Z(qG zWo(HvExNHG@rkRiZ|@atx&Grx8~1(Tp7PaT-~WHrT2s3Oti)^mE-jfleL8bPZ*TAI z`{5HUguOF!z5gGaU$gNCcTZtz>eI7pye~~-dHnSBbniz!DpS&wkKMd^GqLCPEeqeR z<sv&5G1*BbFFxiL5MntmOLnU($I~ZIRMga#Em@*+db0O)y+psgA;K;^E$3cb)!>n} z3c1qGua(Li%dlYm^7p$gg!dRT7|0ry{rK>ZAs{-s+FCtuZcxng9ZU|%$&Y(`Dqfy= zJC&tnLUS|oUi;nqHafq%B2=n9*RlTejm9e<!#>6H^ZyjIpWCRsX6+ioW1>?<bI+eT z*)Az5`Q&JqsP-DR?~`YL=yr{ta5}rJY+J}h7Do#!t5c<OJe4nAy?XVQ*8d0pt^Vuv z2p($?;N!j=bm-ESt&Xyj-OT2@Exst)y>6Y}CBwH57YE+|=y~<emmR-;RWTG46(#Y% zc$gGD>y=*2jtP7C?B&+^<xN)izjp1~F$wRr3lCk}_2x}Z&&JK&n}x1NUokW67fwoC zFQq)s?HF_K(qr?S7EbVMj*-kX-Lzv#go1!gc7@rM8<SH0rrdh;=+TA63)fr61#3+D zz}n=sWlvV3(ag7R->#3_J1MrG&Fjj-_S&bPj%;yWcgTk`d`i#8lclbU7frFAcPXH| zt4qo->B#Hr>zD4D_vK4!xMZP>pV_~aF{@U&{5gJQ3wzn(bMq7hZC>V2&XT%Sd6xgA zli@MZLydfVd^~K6SFe73{?46eyLMNlEuJ!ck!`|`yBWLZyqPm+-o`sywwUm>C#R%5 zvAG}JX{^^YYv)dlkRNYeZoX&wsd2?bHD=$GH!>2ElA2x_`T6zV-bD6%Y(B;AoU6vn zVEJFbN!@>5NaVY-v&~c6ryYNMd1_S5%^i!DXiEt!P`zg}AvNdK<}G>Ir;-$9gO~N~ z`gQEsF_ova-@dF=X${xBdiCm))|rvt3#HFZ{ykH2CWj(dtB{1miQ78@vz{&t(2z*h zntJN_=lcJDzi*vgzFOzR(VMEjqsp9}o1fHW1O*8>WxTqw(reDgcdR9Mb`*v*F*H1S z^eE2p?Xg~_Plt{ja}zu7wWs!DlH#>Q1BoTNDH|i4+xcV{Iq2x<MCeRQnSUzw$o+)R z2b_{VD|`z-CB50C@W0oOKUtl<y}UPD-pq;l8f+SJSBdf0MR$46yq$5Ldk#JStSQ1Z z{d8_-=F1l^GNw=H>+9RL%}j5)H`~L|UkjI<nPJ#`GDWFnUCd4;seRLKH8nByZ0ug$ z{YhYP#-87^>yvVAS3U9bjE;`J)fzv??sw4Krq;EkGiNT6`1|AI<5cg1UClFHU0oR( zG&)q4C!H~rsD1S4k;Gr!f4`$c|NV=V{#SfQ`Hi~n`K537b}l{nGG6t#)sx8!H7B2+ zW68|m>DgH~yXmTrsJQg;#~%fpu3ft}>HOmJZj*zn&dxGDcI?=azBf<)d^|2MEd>Ha zlNPI=i(8R2`BcV@7Z(?A-n@D9CYQ%`@BZwZHcd>~d9mSS+bPjo^W?0K=lT_T8aip1 zn1sl#m?>qjUGB%uy?bR9kECsGud|9QbFB{enb6QW_s$c3c{>&cu0;~k-5k@lZvFc9 z_V(MiZ+m%py;=TG-XV9H`t?T|i<i0aCBGK+p8V#1+{q)6+`K$Y@%w5bgM*8|K3ab| zY)#NkTMmZ6^u;HFr_HbZ7Fpi$u1d>uvHiavk7KKyM4l#R9jN*D=jg@73mF6i1s4is zF?{&$T7UlBxx9>wACH5cn0#053}2_vvdnM(vZBXJs&DCj`a8|0Gaxkd>*IS4Q#T%e zy>sUA!-rRfXdSz8|9-rlzMr>$cnV*4SC@d3j+l4)1CCD%r%u&S5|OVD3|zSM`emjX zv3Ixj{Ibpcus&9MW2L|{UWR3Cf9B5KQg!mu2kGzw=g;>)@pp7|oSLet^|je-ol3aB zv9WQwem*C^T9?YQ;+W?e2eWIF+oxZznRMpK-<jd{`yIBvERA%@`}ySg)6cWy#l)v4 z^xVCBC*<5NIkCF?`)VbUt>)Ifxv^1xUwFl#F!%1L__DjFPj{ae|M0U$U48k?&(lu# z8mX(QoqAV2L(0H^zSZ4JmzoU4-k)M@m_0lC{yr-aE>*>cpDv$r+UY89QKFz~s;Z^s zl@<Io*3<u(o6CHWYvw`c=Pg}*_R_sms~8V7)#nrx6g>F+v$wZ*-n`FI^QUMA-rHVV zTT)^&*H4_Qb&|SV%i7YFD_1@dusB;16t{@+^s#H##1vZ?-Ch5#^HY^ow^C}!6S-$m z_^8D}!9X(O(@U4D)|s{o((Fsu-Ji8JMsK>?;=kGN_wV~OPk(p*iOQ<_>-Nks&vz7A z<kr~TKXmBPh0f1iW+u08-TL$A&ysobfBn2M@q#jkA~Q4d`>%H=rZ2jmATOVP>HPPv zUuz?^ZI|=E{blz4ybV|Dp|s7a-zDx@CM)lcbmwq)dzJGc@x{xp=RVd*uV!O7-Y2Vk z_Sj<gt;T5<u~wfaukkC)d!+PTbN`=D+>Qb<dgZ65Ie0Qno-xBiNZQ@~c)!ou&}klQ z#{`|k_2Yt;w-rA-b5J5YJaoQAp^&0U?yji$79PiWuIJoxU4EHQ&WeNKW#-G5nJ>e_ z!j#?nOw8r~JaT<JcX#=_>37Ag!xp>ucXs@64ZQZG^1ifro=>^N!>tFhkM&6Q&$sE@ zFW~QI!C+DGVL^z{`>(gTxwwjoi&w8+oqm4S+gGowN>7DMc2sL^Z9RGNWNT~d5_Q3< zEyritakV-Lus8~It>Ij`U|F|T-$q3iQ`0H4X4yq=|Msp~BQW(|$PBl`LhDp?VmEDB zv}n=Zy>EBF-*<a^{{0UR59j9EFAd5R6%|cQO?|Zafr!h^Z-2l2j9>R!@_)Ay|G{&! z&Hd*J&3#t4a(8L8yZiCg;p>IY|9!LRK>Hi*O^Tb&on=wix82*jcJ104JAQ^ed-kO4 z<-I94L3rM`dmCyG9pU`_?VYxU21COo5D3zgRaRacsvWNTg)iU|L!-ln#KUdBzrR;k zRc&o+YilceeE7hDg#Z8kmeo(*d_dm5I5qk}*Nq!D`uh4lKR-X;{{G>VS+i!z+0}H| zt~$Q($F^-|jSd&?-CL*e>E^wAe!I5U*u~d|Pg%glc;Ey_{kyxnXSjNMb4SMH`<Imj zi#!$-zr<B{NBYO>_4|t~<}6#b><<XkXm0hKtj5a9>goF6-LvHr?#o}yG%;1?T(VGU z?)?oL41}_tG;(hGp7Qm0ul)2WGgug!*?1>?<*>H4KDo_Xj&JII;iS~}CBODuzWe9O znKM0`ey4sd{p#!M8=^J!XcDi9;Y`EYUnbvGUzsEvXkfhedb{<%G80qPulM#=vpDid z8XY-!@L>5<E!FwTEV33mYkq#3F=IwoSJ$dltJba4b9QzvF8(~zIDMDim#L3;_|C~l zNN`wwdF#wi{pNjg#=BOp=4SZv_3PCV*GTtYHdQPV!F%>r|LuLgCUWzvS+f`%+}+vl zIbF-)iQASFnU<DTR`#u1Twl(n!l7=CdB%kWf!D6(y?d9YeEj6HRjXGkFJ8HA{x>C# zJry4xE%%?V)Y9UlxP4{Yy7TXn4N{(+nQ0?;{#uxyo%eK|w>5V;88)Y%wtSbCndy1W zQ6{e8`<L0W(-$8y%fH9NU|sg6qJGJ%y<TZdXV3R%rm>y0oE875!u(TRedmhphG+iU z8>RB;r$)?PxzvGqVmTX|uee4}V0OW>##wGA0l)ntR{mySy;ic(?Vj?Ld(T>0-Ts9? yt^J#o;(S$?LBimO-{qrHmHPuOcepKia^Ga`=N-jI&&>u6$a=c^xvX<aXaWEut^h;; diff --git a/src/functionObjects/doc/functionObjects.dox b/src/functionObjects/doc/functionObjects.dox new file mode 100644 index 00000000000..694ac1ec2ab --- /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