From 89ac7ff40b36d0418f41d7ebb2acf17cfdad1bef Mon Sep 17 00:00:00 2001 From: Andrew Heather Date: Fri, 8 Jan 2016 12:37:24 +0000 Subject: [PATCH] ENH: Doxygen updates --- bin/tools/doxyFilter.sed | 2 +- doc/Doxygen/Doxyfile | 8 +++++-- doc/Doxygen/_Footer | 2 +- doc/Doxygen/css/cfdLayout.css | 7 +++--- doc/Doxygen/css/cfdNav.css | 5 +++-- doc/Doxygen/css/doxyMod.css | 21 +++++++++++++++++- doc/Doxygen/css/doxygen.css | 6 ++--- doc/Doxygen/css/img/OpenFOAMlogo.png | Bin 6140 -> 5622 bytes src/OpenFOAM/global/foamDoc.H | 7 +++--- .../DES/DESModel/DESModelDoc.H | 2 +- .../RASBoundaryConditionsDoc.H | 7 ------ .../turbulenceBoundaryConditionsDoc.H | 4 ++-- 12 files changed, 45 insertions(+), 26 deletions(-) diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index e2aecb8b8d..f3bec2901f 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -175,7 +175,7 @@ s/.*\*\//\*\// # convert /heading in source files to bold font and add some space -s#\\heading \(.*\)#
\1#g +s#\\heading \(.*\)#
\1
#g # add a linebreak s#\\linebreak#
#g diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index ddbe275ff9..4e86e5338d 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -769,6 +769,10 @@ INPUT = $(WM_PROJECT_DIR)/src \ $(WM_PROJECT_DIR)/applications/utilities \ $(WM_PROJECT_DIR)/applications/solvers +#For testing only +#INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \ +# $(WM_PROJECT_DIR)/applications/solvers/incompressible + # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv @@ -1172,7 +1176,7 @@ HTML_DYNAMIC_SECTIONS = NO # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_INDEX_NUM_ENTRIES = 100 +HTML_INDEX_NUM_ENTRIES = 2 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development @@ -1421,7 +1425,7 @@ EXT_LINKS_IN_WINDOW = NO # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. -FORMULA_FONTSIZE = 10 +FORMULA_FONTSIZE = 12 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not diff --git a/doc/Doxygen/_Footer b/doc/Doxygen/_Footer index abac826396..e558a423e7 100644 --- a/doc/Doxygen/_Footer +++ b/doc/Doxygen/_Footer @@ -2,7 +2,7 @@

- Copyright © 2011-2013  + Copyright © 2011-2016  OpenFOAM | OPENFOAM® is a registered diff --git a/doc/Doxygen/css/cfdLayout.css b/doc/Doxygen/css/cfdLayout.css index b00bd68da4..f803ce8802 100644 --- a/doc/Doxygen/css/cfdLayout.css +++ b/doc/Doxygen/css/cfdLayout.css @@ -71,7 +71,7 @@ p:after { border:3px solid rgb(175,175,175); border-bottom-width: 0; margin-top:10px; - background:#e1f0e1; + background:#d5e1f0; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/; } @@ -265,12 +265,12 @@ p:after { } div.contents a { - color:rgb(85,144,112); + color:rgb(70,122,167); font-weight:bold; text-decoration:none; } div.contents a:hover { - color:rgb(56,94,73); + color:rgb(42,90,138); text-decoration:underline; } /* @@ -342,3 +342,4 @@ div.crosslinks { } } /* end media print */ + diff --git a/doc/Doxygen/css/cfdNav.css b/doc/Doxygen/css/cfdNav.css index 662442034f..6e37717c58 100644 --- a/doc/Doxygen/css/cfdNav.css +++ b/doc/Doxygen/css/cfdNav.css @@ -271,7 +271,7 @@ nav3-bullet padding:0 0 0 10px; background:url(img/bg_bullet_full_1.gif) no-repeat 0px 50%; text-decoration:none; - color:rgb(56,94,73); + color:rgb(70,122,167); font-weight:bold; font-size:120%; } @@ -282,7 +282,7 @@ nav3-bullet padding:0 0 0 10px; background:url(img/bg_bullet_half_1.gif) no-repeat 0px 50%; text-decoration:none; - color:rgb(56,94,73); + color:rgb(70,122,167); font-weight:normal; font-size:120%; } @@ -570,3 +570,4 @@ div.navpath, div.summary { background-color:#d5e1f0 !important; } + diff --git a/doc/Doxygen/css/doxyMod.css b/doc/Doxygen/css/doxyMod.css index 11407eedd7..fd250189cb 100644 --- a/doc/Doxygen/css/doxyMod.css +++ b/doc/Doxygen/css/doxyMod.css @@ -86,15 +86,34 @@ tr.memlist } .OFTable th { + height:20px; text-align: left; padding: 5px; border-bottom: 2px solid rgb(175,175,175); } -.OFTable td { +.OFTable tr td { + height:20px; padding-left: 5px; } +.OFPlainTable { + border: 0px; + margin-top: 10px; + margin-bottom: 10px; +/* background-color: #F0F0F0; */ +/* padding: 3px 7px 2px; */ +} + +.OFPlainTable th { + height: 20px; + text-align: left; +/* padding: 5px; */ +} + +.OFPlainTable tr td { + height: 20px; + padding-left: 5px; div.line, span.comment, span.keyword, diff --git a/doc/Doxygen/css/doxygen.css b/doc/Doxygen/css/doxygen.css index 4958570ce3..d8eb269cc7 100644 --- a/doc/Doxygen/css/doxygen.css +++ b/doc/Doxygen/css/doxygen.css @@ -86,13 +86,13 @@ div.navtab { /* @group Link Styling */ a { - color: rgb(85,144,112); + color: #153788; font-weight: normal; text-decoration: none; } .contents a:visited { - color: rgb(85,144,112); + color: #1b77c5; } a:hover { @@ -546,7 +546,7 @@ table.doxtable { } table.doxtable td, table.doxtable th { - border: 1px solid rgb(85,144,112); + border: 1px solid #153788; padding: 3px 7px 2px; } diff --git a/doc/Doxygen/css/img/OpenFOAMlogo.png b/doc/Doxygen/css/img/OpenFOAMlogo.png index 6d9e2f698b4052636fad0c08cb0fbcb539fd2202..722febb968068d28a82262b316a4a890e1a601bf 100644 GIT binary patch literal 5622 zcmW+)cQjnx+r2_$lrTgYL?>E8CP73ug6M*n=zy&lRTKA8$&wlpv>=Uk~p>&s&krV)cyUH(LXoKr8I0PWKz`6a9Ee~8s zKD^X-0RRehaAXk79cLiH%{#8j>I!%M5I{)p(KY?+vc-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_LK?|zplsS| zV1XCb+TgpsHimHmAy8?*jI(2g?b*^_^+IK*D&O&Qv}4oR*EpCc8TkJlep(q%MAwU! z*PEDDg2hGajka^g6ydS!&0v<>D5FO*QpeM^?^jk?zvI8O{beLBi~ zq4{;}#CVw>3V{ScAw>5ch+$7{OT`PyPV_r$?74O9XPXj5`d=}OIjkB@)jP84KWfBR zWMgCMarLbOTpTFu3F1-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}U5rG)?mM4^-Le`$_>tPM_4GmT2*4Njg8AWW%f(bF2*?2s@ zs;a8LUj=AzJ4iyK2mTJF(^pLASJkZ!XMTr0txW}fo;4k~cCF<=QCjj4IE-96TZo2~ zBeI^7&t75)s`}H60pE!NljFk@<7Z_ zwr7ovjRo4K3ngdB=mptA?(>M~utvXlxj+tl_6znUY|~U$9+{Znf#hMa4nym&Sr-|b z^p+#cLq2%CsW2WfCRJm!q3XRMzk7E+$9y1Jh{wsw-aa!mb!~IykwkphjJlMYAnIuS zmydL|MiHynhnzAtW96*ZKlDL1!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#)VhV%u3kkKyCzn-yj*gD* zbD^`bu_2Jv){dhd8XQ!MtVE;HzdwC+sZB_*41sog{D`1k7p`inw3wjs< 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{$1Zbqs6* 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#9AiD%0x|+TT$V^-iytY_$bG#Vj2zO^-uww1-j62Fp0msPyAaOB=B-rJehe962Io+jfjeP$UqunLj@ zwp5C|v3C5bwRZofO;^TqEO7b*O<#{SPBK-odx+?r>zo@4n3|g6lh}BnCBV_hm(tiE-eGnTI5g2HQrG33ciJo>j?Mf_LT7>W6e_m4baxmW(?|VN7)Jx*l72-B(`jhviED zgDs8m@Y_Pe32WKpv|ouIKPTDD_0_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{xxbF)(X+)jrSGh+7L}F?Kq1S{^x~Oq5{Jk>9ga*9o5+31{PET>cKm z{Yp=KMg*iN$}?{=KdFB5^vRRDfq$0V88!~K_>mE(v;{7A;}xMCM4&YX-nzy_#Ch_+ zx62CZ>QQ3?EHORim2HP)2}h6HZmzxg6C7qNS)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<+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>*kEjjEtA>>)+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?x2NA7zI*2E<8L3s@*i1Nz5y#)<~-Sl4}*_=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}YRH-@B0##v;V?MG zcpa~yG!YQ@{OHZ)%e@{}Q02kq9Eaf$@v>Yn_<|gl7I;reu{S z0!Z^K&$6Cn?+aSpVbaZ7+UhjLh}vlCd{}X2rs`!{_?)#|S1D zfKpNAQriN%Ckp(eFeW#JRvFcHnR^%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{%Ajjkd<{{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*6N!i82=t zr^a$UG_I=2%gbwR-D=)xn*pC9b{D?e+shPa+tAX|qEM*C>OV9urjDa3-Iy+0ibio^$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|#XqKlsf?%&N{)EMCTRgV>JD4iTf*aS< zkXB88xaBiT0#v^nc)o3AW1~DSci$x7 z-}5xnMUQ9ue*WQK>*0epGEYzxLZ~5@A*1SF2`mKNzagp-h?Q@TN#1H2;z1f;t~1f)|!={%5< zzW@Gr-|W0Mvv1$dH}n1Ci`LOnCLy9H!ok5IQB_gU1Nw2GaS=QOp2>eJ_kix9wYstb z4)*`MpuHp&7$JP8V&Z{=Lrn31yN8pVOA8F*d#Y+G;x9iUc+5$@l3yYV4AFTi8hgsa zU0m#3J#pmS?W{cQY*`Ubo{p@_s+u}RA*3`oI5f7Z3Qz;@g#)CI@vG^p0h#MZtlZoL zxGzFpIP+w`*bwzld7>*^uR8Lbr(ZZyWI*Ir+%np0ygW;9HJ2S^jI#W>szX|kl=2{C zxZqvH?e*IChZ0*|;+Bmqf2BtQ^Lm$^7n~~*R~?571PJh9j6w3?M_LEss3_D?Nj#ME z!9U3StJuFZPZg&rGqv#L83_rhjD zXjRTzvnW2uob&F=Q{qKD7OF6f1KzowC=9+Yn*?b{@Z4Nt@ww+%Z|T4VaeIhj+ zVm2;qZtU0{jHgoEM=v^!3fEt+DExEgc2Mxc&Z?96DHsx>reRRM;n6Bn(aA8&Pe52> zd2_)lV9>9COZC?tgZv>u}S&dtGI(__Ok__ySqE@lvgAv(;QVz z`7lV`L6Ad4WU5elp}~1*fV*d)Idd9*fUF`C! zp$IcSH+Q6etZg5^_IBMQf|SX0cNvJQ&-<=&yP3(bCK}B*eMUK*yzi@=CX2m&eJ4tF zZ33?a!qsVn-1zRO#l^*K?d)n{XD~K4c0xkJ?w=zVmVO0_2Sk~W5jC!4++-4l&oW}1 zrXsBnQJ7^?h$lmT`pu0$F0{b39`@aK!)!~Dd}h3R+%aoU#=>F0sb;Yiq21!(?5tjH zSh@XsBiybYX5JZyWDs*rN=m}%DvHfGIzP8R-=B}m5&c>5Z?WE)2E}dt`t_EPbinaP z0kcN3Ingl@4>hvtx;lkQL-aH(d1zyOeVr_TwZ;4)w`$~L7A3(9v;prptlm+Co-*bb zEnB3f!7Q3}yKs*@;m?2b5r<8Ynq2BrQa3%jJ zN(I(rinYmfJi0EcAm*J=dWY@!Ddt<15?APpvb^@<@YtmN7hY#d0vv;2q$FbEvpSzU z3zc5)JgVn*x!E)F-UECce^Zx%wqHD8OGt=Yayo2zT=G{aldnZ_vT!?p>$mx zov!uER87oD>tTmH8E%Uw2IawyLS6j1W*MeOj2Ab4{VGSPI0X~MCuJ0gjYhGd#~ek9 zhUIF5!(H|oYOt-h#-^sgl8jqCd7K-+h<=yF5#5`$UFb=Sii+x5US@7K*K&6Uu_Ukz z$i#E1sUS-ymAcbt*iMQi)62s11}%3o&}gk%gNP6urFeP{VV$9Lf#`$;`zY*lbZCvs zzlQyox&Dj4Yr5sr#>U2Ew6xzZOHVk@5F6`uAYL*BRq#MVH4$dV^)Q-+rV|#5&AWLWEgTKwWq_LS9xC;?XI)5V&e)ul{uGfBxf6h)2ikqHxI;vrf8XIGJ z8E{1jfXCiUB^}u2QP$^3PO;Vb4zSHYf?}m1JHdTm0*o_VOjgeoQ!1r9(LUUo_2Ka4 z4~JT5o8>~E{kf(vKCY@vDYseeHx8qlQv7)xnU|?sCnHzziyebYt&O6!jHm^Q{tb$L z95pX@$e-386VV{5d|dyY^wGw5oU0nmE<6445QC~C`#g9GHE(6~Fm(G7n|T?poLmPq zi4ZvG)Pm*&C?Bgn4ybx{?c`-2;&9pSFumO_eN^iwCmY)_9h*@iHPW=8E`7YlMj03S z8$f|vQW=*S+T)Xxoy`-7p`nD#+4eY^b2>I5L5What-XCDPaRKILE%LxD{Bnf-QAtN zkZkepQ+DM9+sR^0Am@OLl{NQd%&YQMv+L>Y&5{X{#wjsFZn`hpZ4PJ2D=9@-_z5)z zWlfhGt(~WsW!+j_+}+O)Xo!oY5u){9u5;2a4my2O^?1kS=rR=T2h3^Ijg+F^uPe(FON77SG0}}}v3VGKrq~XqE1^22R z`!S7WFa3;q!hW$DD@2AH(%$+Hk+e zd@as@*!4k*T$t&^m!+Y;Z{Nt7m|nXg*RB&&Q&QwahhX0AkfU@^K zz`z$TUTkNs-QZoF@2KB2d!ug;=IbK6!|>G~8T{&i1YDonZI69wY8J)$e{16Cq_U?^ zNCp_+y0`$}ocr~w_IOhJ@^n&L)h}1c<$A%}+xs^LBbcTcrQHQjVu^N(=Dbi+R6$;L zjJG)z!#+)9e>dQoqh*rx(zrS}SgPtdc*OXEtVl1KJLbmob_+CwS!y&|5Q4Y;jqvO| zGz+Myt(B)#?7-gP>#b^zPL09pjkz~2E>0gP=;`Z=`)u3Jug$g6K*<~rr}J7!XMl{D z;)im?#>UE5>OJ`V=TFEYYSlg@BO~LBneP8ET4YzujT(3SK04|EU`lXTPdIUOLM-P| zxoE{DjD!aM#`cIIjHCXg{XT8jZJ*+R@GW`=00dm9C1z3FT&+#vo#XS6?mcn0%Vz*L z^o@@{fsz@wdI@lm?y5gaQwvu@|LKdSsIX`!nw9v1i;wTY^Os!4{3c|($q^uru$&wQ zqHsCOTrnS+wS>zxCE0g;2Scd~%S7 z&3>tre+LFP2VS*wyNiu3uMf|I2||NQO1Ma*7}9+)OS5M92$_JMj(}?o%p1Xs)G}X{ zL}sa)h8e;d`AE_<6Rz_q9tGXPAnYAEJ3YC9(nxb(pX3CKtE+2Tiaj$k^TgpmA`3(R z={@`5o2WAI=JusUNY4GikwFeNw$Q@DXAS-x;kx=tX}n~Aj~JgP0lG-~){}6_|IM_`J{v{X^mJMnKIvGK&z_#m?(}SiWe)x6 z2_}-2pf8Ogn3TZ#N1c;l)M!#mJVS*hWXCfq*AYd{D^&t8Vb{zIb-a>(u_oNg3Od%n z+J61-a7AbtACvYAAA`ZX^gSgAUeOCg<6YgGW0FJ!6R@$tJ1#lXtp$iatoqOkyW>hC z4gfN)4Y>CDHp&b?Hph7(>eW}?PBYGh5)Zs-8b4O9eJw7UeB1q|eq80^p$!A8@r8Us@UG#j>H5;wNkh*n+BjA~)+?eo^aE4vvic zS+4inV0%yhUUyNYd!~K^zaaLB_=$EUQK;?4#3D0 z$}0_PHQPI%@tXFPlfA0WU6Ft)ix-9-(|q~^#mv1CB&m1H)ox+)w?L@lcc;tQV^Gjk zK}qqP%uHI~OjjXRh}e-aDOw*5rwn24YHCalG!9`5hMcLYI0`0HZHgXW%-chOywv@{ zo|_|~ZVA=(Gx}ow)bTZ$_HjOI>TRAA^h;7|T2^>{y{M0mkFC8uy{MacpqPb}rfw;( z9U?<9@UVp3;C>lj3bcTCM$v_wjmkx2DdAjvuz5uzT|YlgSgWjX;44i1Bf0jEcw^3ZTn4o+(J%(LCJ z<F<7B}(PW1ZiC@wY+ym`@0Y^noYEE zn=DUE=uJ2R`6dFJB6$2b5mXgH!mzrzS=?A)mzAGZw0fe{zu@ScwB&IXt|s`-$#}*e zw$xHDf-hWC!YimEw3M7#V_0eGJ3x@|fe8u-q0~Wce*R~Ce6fH7I6gjBdwqF%xxTrn zXKc)k_jd%k6I1G-&7{Ufa9=rrF&X2qG_<jE_zt^c0Q(j_Df1m z&QSNkHQnhlYb|~bGFQ{nvu16%OrHyFL#|0{Y;KgK4FJnRuntO34qry&<9yjPn=1#?(g4k$I? z1)K^X#C=B*m^mK8!N)Q;WWc_ZwF&<@-^h5A0%!m=HKIR~y*uEF#KAQ;*uFxm*FjWt zG(bM9x6RJ~1iya$`p(^Rb$aDf!zPRkFIYQ><^MEbCBVhQ%NkJtNTy=BF1xMmB`&mU zX$c8gTA&q0x^gXk>zzaoLxKQ*zO+eZ`$CfDnoq#2VI8ms>l+*HXS=Uj#P;tp?ASX0 z=@Xh7WfVT^?a;Lgc&bl5XRr&ddra!V=zVh`tg5QYIOi3de782NhMl;S{4~+s2@O*_ zMAs%eaCBbw)4Z`AJf7ZYc%#141Me*Q>WU;yUuk(?ZlZyEH1iAogaQrTA&p?{Lo^9l zDJN`eG&5Ia@t4MBd*ImE$0dIaK3r_>jcMi^CR#*FQH^{fVbI~G1fWV*RyIrPok8?= zlW-+94Gq9CP0h`JCMvx71xzUi7|#!7bTD&274vL{$ApKOWv;bV-aFuL-h~s~|CrWhDSq>2tg8k9wodGgX7z<18xA_cMiUqB`wg zocImKapVHg2CxT#K(r4>VvFGhryTlFGD5-{t6fL+{e9lZ?^1A0-0HwvUsc#jyI&$; z-)f}hE|Nd!Ta_FgK!U3}?*Q`Bva)*Wu{k^q-sHRjCN!(6D`P-K+5lY{Vwc!AM4ur ztP*FY!o;RJo`<;j9UwNfkP?d4)@%V5hw`0)x7&9xg!x{R`=1^>z|u6o`xA<*gz2F-T0ggj*fDH!Ku~q*K`uTrFG1T9#)SmcW#y7`}T9mNMyWeWo$GF9jK2x)9Pp2 zZg^Pdn^G``+jeT3T9h43ebSonod>K>0ueDUp^V26sQ* z)(s5}B_QH$?`C3TG_HqHVRx}Y=!3U1Uy)9ClXI;IAppPkm)mmyQrSx@H)|Ap5l+qK|VfpdVRavCiN6` zeHzqH#Tsi2QG?4bB`qz|ot>RragPYF!=wDl-GzESzz{-c-$+onDP3*HhwG^x21--W zXCx*jeqeowkFTy_@Nv$(PU~B#O-TYH$s|(fvwlee^k^u>6!0Mi+1mP~lJvu8N4q=y zn7meT3b*v_?X|@wpRhNnK^#(2OyP2$JkDRg-kC?^cl3_PNc`;~76J}ErQA#;8Qqh? zQ5kHUx!^!=?*l+8e2Zgpm_X3q7sCg^rnmtsA@A@15`kI#R8WAUtgK8g;wXE#+)f9v z&m6z1YC9$(B_#zaBRWeh`|_R#7Ou+B5G@bDtr-!NU0b_IVV3c9KmP5;Ps1iG0*Xt^ z*H@z8x@F{~I7{6Dmsc*Z7A%l5*m?&h%Erco3E5( zr*GF(-w(uWICflPT3`B?4!KOi>I=DwYz|$u>vtPYF-r`9BPuB=8NXtWNc_D+fjpZk zNwoS<6|9jBap8?`dMore ... + More ... \section layout Code Layout - The OpenFOAM source code comprises of four main components: + The OpenFOAM source code has four main components: - src: the core OpenFOAM source code @@ -56,8 +56,9 @@ License \section usingTheCode Using the code - - \subpage pagePostProcessing + - \subpage pageSolvers - \subpage pageBoundaryConditions + - \subpage pagePostProcessing \*---------------------------------------------------------------------------*/ diff --git a/src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelDoc.H b/src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelDoc.H index df3671a24a..54884acdf7 100644 --- a/src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelDoc.H +++ b/src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelDoc.H @@ -23,7 +23,7 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -\defgroup grpDESTurbulence DES +\defgroup grpDESTurbulence DES turbulence @{ \ingroup grpTurbulence This group contains DES turbulence models. diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H index 4202f5f7af..c2e558f948 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H @@ -29,11 +29,4 @@ License This group contains RAS turbulence model boundary conditions @} -\defgroup grpWallFunctions RAS wall functions -@{ - \ingroup grpRASBoundaryConditions - This group contains RAS turbulence model wall functions -@} - - \*---------------------------------------------------------------------------*/ diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H index bcf8f79f22..651e95c161 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H @@ -23,13 +23,13 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -\defgroup grpTurbulenceBoundaryConditions turbulence boundary conditions +\defgroup grpTurbulenceBoundaryConditions Turbulence boundary conditions @{ \ingroup grpTurbulence This group contains turbulence model boundary conditions @} -\defgroup grpWallFunctions wall functions +\defgroup grpWallFunctions Wall functions @{ \ingroup grpTurbulenceBoundaryConditions This group contains turbulence model wall functions