|
|
| (15 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| − | Annotations concerning the OpenFOAM ''Programmer's Guide''
| + | Community created ''Errata'' for the OpenFOAM ''Programmer's Guide'': |
| | + | * Online version: [https://sourceforge.net/projects/openfoamplus/files/v1606+/ProgrammersGuide-v1606.pdf OpenFOAM ''Programmer's Guide'' at SF.net] |
| | + | * The local version in your installation can be found by running one of the respective commands: |
| | + | ** On OpenFOAM 3.0 and older, as well as foam-extend and all OpenFOAM+ versions: <bash>echo $WM_PROJECT_DIR/doc/Guides-a4/ProgrammersGuide.pdf</bash> |
| | + | ** As of OpenFOAM 4, there is no Programmer's Guide. This is now maintained by the [http://openfoam.com OpenFOAM+ project]. |
| | | | |
| − | Notes to contributors: Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) | + | <br> |
| | + | <hr> |
| | + | '''Notes to contributors:''' Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) |
| | + | <hr> |
| | + | <br> |
| | | | |
| − | == Chapter 1: Tensor mathematics ==
| + | = Chapter 1: Tensor mathematics = |
| | | | |
| | | | |
| − | == Chapter 2: Discretisation procedures == | + | == Section 1.2: Tensors == |
| | | | |
| | + | As reported in the [http://bugs.openfoam.org/view.php?id=1068 bug report #1068], there are a couple of references to ''OpenFOAM 1.x'', which is likely an old reference to the original FOAM 2.x version. Feel free to compare to the old documentation at Nabla: the old Programmer's Guide, section [http://www.foamcfd.org/Nabla/guides/ProgrammersGuidese2.html#x5-40001.2 1.2 Tensors]. |
| | | | |
| − | == Chapter 3: Examples of the use of OpenFOAM ==
| + | Either way, feel free to disregard the ''1.x'' reference, since its objective is reflect that tensors as a mathematical entity, are only partially implemented in OpenFOAM. |
| | | | |
| | | | |
| − | == Chapter 4: Programming techniques == | + | == Section 1.4: OpenFOAM tensor classes == |
| | | | |
| − | [[Input/Output operations using dictionaries and the IOobject class | Input/Output operations using dictionaries and the IOobject class]] | + | |
| − | <div id="aflknwerkamfs" style="overflow:auto;height:5px;">[http://dooneiwboyb.toplog.nl dooney burke handbag] [http://ninewbygvlx.toplog.nl nine west handbag] [http://womenknkziq.toplog.nl womens handbag] [http://quiltvogrtw.toplog.nl quilted handbag] [http://maryfkwxkdp.toplog.nl mary frances handbag] [http://kathytjeenm.toplog.nl kathy van zeeland handbag] [http://wholetxjsml.toplog.nl wholesale replica handbag] [http://gucciwqoame.toplog.nl gucci handbag low price] [http://strawhglzxx.toplog.nl straw handbag] [http://lvhanmhwguu.toplog.nl lv handbag] [http://dknyhqtbvqp.toplog.nl dkny handbag] [http://repliyafqev.toplog.nl replica chanel handbag] [http://authetpwezh.toplog.nl authentic louis vuitton handbag] [http://doonewvzglt.toplog.nl dooney handbag] [http://disconxlchv.toplog.nl discount coach handbag] [http://handmfgamzc.toplog.nl handmade handbag] [http://fossigynumn.toplog.nl fossil handbag] [http://bradlwtvlur.toplog.nl bradley handbag vera] [http://michaxemkri.toplog.nl michael kors handbag] [http://discocevjkg.toplog.nl discount designer handbag] [http://authengtbfu.toplog.nl authentic gucci handbag] [http://knockeowawd.toplog.nl knockoff handbag] [http://diorhzsbres.toplog.nl dior handbag] [http://repliaikfux.toplog.nl replica coach handbag] [http://juicyldhgks.toplog.nl juicy couture handbag] [http://brighvlwoaq.toplog.nl brighton handbag] [http://chloewbforo.toplog.nl chloe handbag] [http://handbjmpvpt.toplog.nl handbag jacobs marc] [http://marcjvveyde.toplog.nl marc jacobs handbag] [http://discovktlpj.toplog.nl discount handbag] [http://handbcrpxag.toplog.nl handbag purse] [http://doonevzdepz.toplog.nl dooney bourke handbag] [http://chaneuscxrw.toplog.nl chanel handbag] [http://fendiileazr.toplog.nl fendi handbag] [http://louisqlssnj.toplog.nl louis vuitton handbag] [http://guccipvtxbd.toplog.nl gucci handbag] [http://swissfzuwdj.toplog.nl swiss panerai replica watch] [http://swissadvrqg.toplog.nl swiss cartier watch replica] [http://swissoemejy.toplog.nl swiss gear backpack laptop] [http://patekmcpuau.toplog.nl patek philippe swiss replica] [http://swissthutrc.toplog.nl swiss watch quartz] [http://luxurqnjwhk.toplog.nl luxury replica swiss watch] [http://swissicrunf.toplog.nl swiss offshore bank account] [http://swissdgkxpg.toplog.nl swiss army chronograph] [http://fakessqbtrm.toplog.nl fake swiss rolex watch replica] [http://fakerwqmqdm.toplog.nl fake replica rolex swiss watch] [http://armycwvjjec.toplog.nl army chronograph swiss watch] [http://omegawuhvgw.toplog.nl omega swiss replica] [http://fakerdgisdy.toplog.nl fake rolex swiss watch] [http://cartilabann.toplog.nl cartier swiss replica] [http://swissxuextt.toplog.nl swiss breitling replica] [http://swissuqtlzh.toplog.nl swiss made breitling replica watch] [http://fakesnbtmsu.toplog.nl fake swiss watch] [http://accougeatrl.toplog.nl account bank credit offshore suisse swiss] [http://swisswofaro.toplog.nl swiss army wrist watch] [http://swisslamver.toplog.nl swiss army laptop bag] [http://panerhzbttj.toplog.nl panerai swiss replica] [http://accouccrkng.toplog.nl account bank bank offshore swiss switzerland union] [http://swissjblwhx.toplog.nl swiss camping gear] [http://cncswynxson.toplog.nl cnc swiss machining] [http://armybrzvpdt.toplog.nl army briefcase swiss] [http://001reebyjqw.toplog.nl 0.01 replica rolex swiss watch] [http://swissmveoaq.toplog.nl swiss army laptop backpack] [http://swisshvtqjf.toplog.nl swiss made replica watch] [http://swissdmgird.toplog.nl swiss army backpack] [http://repliqxyqnf.toplog.nl replica rolex swiss watch] [http://replixblwen.toplog.nl replica rolex swiss] [http://swissarykjr.toplog.nl swiss rolex replica] [http://swissooitfp.toplog.nl swiss replica watch] [http://lastmjveumi.toplog.nl last minute package travel] [http://alaskmfuimh.toplog.nl alaska deal travel] [http://travelwgfem.toplog.nl travel agency lawton oklahoma] [http://califcsqxoh.toplog.nl california jose san travel] [http://travedczfpd.toplog.nl travel lancaster pennsylvania] [http://dealeraosxt.toplog.nl dealer illinois trailer travel] [http://groupynlqed.toplog.nl group holland travel] [http://agentsmsofo.toplog.nl agent california jose san travel] [http://travedxwhwt.toplog.nl travel agent johnstown pennsylvania] [http://jamailhrvck.toplog.nl jamaica travel requirement] [http://travevyhvcz.toplog.nl travel johnstown pennsylvania] [http://jamaisuccle.toplog.nl jamaica travel tip] [http://traverxgris.toplog.nl travel agency cleveland ohio] [http://travebwddig.toplog.nl travel agency cincinnati ohio] [http://hawaihjplsp.toplog.nl hawaii information travel] [http://travekbcdyz.toplog.nl travel agency lancaster pennsylvania] [http://travejvjjpm.toplog.nl travel agent madison wisconsin] [http://golfithncpn.toplog.nl golf ireland travel] [http://travebdhlnd.toplog.nl travel steubenville ohio] [http://alaskooilkc.toplog.nl alaska nursing travel] [http://travexkbnsl.toplog.nl travel agency allentown pennsylvania] [http://traveejuwub.toplog.nl travel trailer rental in wisconsin] [http://coastdthysc.toplog.nl coastal discount package travel vacation] [http://robotgeovnx.toplog.nl robot site travel web] [http://traveimorkl.toplog.nl travel agency fort smith oklahoma] [http://busesfsdcho.toplog.nl bus escort hanover travel] [http://hawaipawhpw.toplog.nl hawaii onlin online travel] [http://agentrfmtki.toplog.nl agent illinois travel] [http://hawaikqzvra.toplog.nl hawaii tip travel] [http://travemlngej.toplog.nl travel fort smith oklahoma] [http://agenctraebn.toplog.nl agency davenport illinois travel] [http://travefgcffq.toplog.nl travel agent cincinnati] [http://agencxdoqkx.toplog.nl agency nebraska travel] [http://discopnfzoq.toplog.nl discount hawaii package travel] [http://travegwiqmj.toplog.nl travel agent louisville] [http://travehpibeg.toplog.nl travel agent harrisburg pennsylvania] [http://califejjidz.toplog.nl california francisco guide san travel] [http://califybjgcu.toplog.nl california rental trailer travel] [http://aainsafplev.toplog.nl aa insurance travel] [http://travecnxesm.toplog.nl travel agency canton ohio] [http://travedmfkkf.toplog.nl travel agent riverside] [http://onlinklpxvc.toplog.nl online site travel web] [http://gaptrrugpec.toplog.nl gap travel year] [http://gaminttypwn.toplog.nl gaming lodging resort resort spa travel] [http://hawaiklgipk.toplog.nl hawaii links travel] [http://agenclzjemz.toplog.nl agency california jose san travel] [http://ameripvptll.toplog.nl america south travel] [http://bestsbuyzrt.toplog.nl best site travel web] [http://newnyyflbxy.toplog.nl new nyc travel visit york] [http://lastmjveumi.toplog.nl last minute package travel] [http://alaskmfuimh.toplog.nl alaska deal travel] [http://travelwgfem.toplog.nl travel agency lawton oklahoma] [http://califcsqxoh.toplog.nl california jose san travel] [http://travedczfpd.toplog.nl travel lancaster pennsylvania] [http://dealeraosxt.toplog.nl dealer illinois trailer travel] [http://groupynlqed.toplog.nl group holland travel] [http://agentsmsofo.toplog.nl agent california jose san travel] [http://travedxwhwt.toplog.nl travel agent johnstown pennsylvania] [http://jamailhrvck.toplog.nl jamaica travel requirement] [http://travevyhvcz.toplog.nl travel johnstown pennsylvania] [http://jamaisuccle.toplog.nl jamaica travel tip] [http://traverxgris.toplog.nl travel agency cleveland ohio] [http://travebwddig.toplog.nl travel agency cincinnati ohio] [http://hawaihjplsp.toplog.nl hawaii information travel] [http://travekbcdyz.toplog.nl travel agency lancaster pennsylvania] [http://travejvjjpm.toplog.nl travel agent madison wisconsin] [http://golfithncpn.toplog.nl golf ireland travel] [http://travebdhlnd.toplog.nl travel steubenville ohio] [http://alaskooilkc.toplog.nl alaska nursing travel] [http://travexkbnsl.toplog.nl travel agency allentown pennsylvania] [http://traveejuwub.toplog.nl travel trailer rental in wisconsin] [http://coastdthysc.toplog.nl coastal discount package travel vacation] [http://robotgeovnx.toplog.nl robot site travel web] [http://traveimorkl.toplog.nl travel agency fort smith oklahoma] [http://busesfsdcho.toplog.nl bus escort hanover travel] [http://hawaipawhpw.toplog.nl hawaii onlin online travel] [http://agentrfmtki.toplog.nl agent illinois travel] [http://hawaikqzvra.toplog.nl hawaii tip travel] [http://travemlngej.toplog.nl travel fort smith oklahoma] [http://agenctraebn.toplog.nl agency davenport illinois travel] [http://travefgcffq.toplog.nl travel agent cincinnati] [http://agencxdoqkx.toplog.nl agency nebraska travel] [http://discopnfzoq.toplog.nl discount hawaii package travel] [http://travegwiqmj.toplog.nl travel agent louisville] [http://travehpibeg.toplog.nl travel agent harrisburg pennsylvania] [http://califejjidz.toplog.nl california francisco guide san travel] [http://califybjgcu.toplog.nl california rental trailer travel] [http://aainsafplev.toplog.nl aa insurance travel] [http://travecnxesm.toplog.nl travel agency canton ohio] [http://travedmfkkf.toplog.nl travel agent riverside] [http://onlinklpxvc.toplog.nl online site travel web] [http://gaptrrugpec.toplog.nl gap travel year] [http://gaminttypwn.toplog.nl gaming lodging resort resort spa travel] [http://hawaiklgipk.toplog.nl hawaii links travel] [http://agenclzjemz.toplog.nl agency california jose san travel] [http://ameripvptll.toplog.nl america south travel] [http://bestsbuyzrt.toplog.nl best site travel web] [http://newnyyflbxy.toplog.nl new nyc travel visit york] [http://gucciwjrbie.toplog.nl gucci handbag low price] [http://atticpqnoje.toplog.nl attic handbag] [http://strawpixfth.toplog.nl straw handbag] [http://lvhancbyrhz.toplog.nl lv handbag] [http://repliuwjlmo.toplog.nl replica gucci handbag] [http://dknyhelvoxl.toplog.nl dkny handbag] [http://stonephczfg.toplog.nl stone mountain handbag] [http://balendhcafx.toplog.nl balenciaga handbag] [http://disconrbhxc.toplog.nl discount coach handbag] [http://handmwwqifp.toplog.nl handmade handbag] [http://bradldjhckz.toplog.nl bradley handbag vera] [http://michaoqexsf.toplog.nl michael kors handbag] [http://discoqzdupt.toplog.nl discount designer handbag] [http://chrishmdegv.toplog.nl christian dior handbag] [http://authehlafks.toplog.nl authentic gucci handbag] [http://knockrcbckp.toplog.nl knockoff handbag] [http://diorhnbxcnd.toplog.nl dior handbag] [http://repliafpnlw.toplog.nl replica coach handbag] [http://katesjziroe.toplog.nl kate spade handbag] [http://juicymxuzgs.toplog.nl juicy couture handbag] [http://brighvpamhq.toplog.nl brighton handbag] [http://chloevtbrkf.toplog.nl chloe handbag] [http://louisbcknnq.toplog.nl louis vuitton replica handbag] [http://handbhivhfu.toplog.nl handbag jacobs marc] [http://marcjwxgyth.toplog.nl marc jacobs handbag] [http://discoptnnsj.toplog.nl discount handbag] [http://guesscpaojo.toplog.nl guess handbag] [http://burbemdvxmu.toplog.nl burberry handbag] [http://repliqywzpf.toplog.nl replica designer handbag] [http://handbtcnkol.toplog.nl handbag purse] [http://doonemrqjgg.toplog.nl dooney bourke handbag] [http://fendijaupaz.toplog.nl fendi handbag] [http://louiselbecz.toplog.nl louis vuitton handbag] [http://wholeodzlct.toplog.nl wholesale handbag] [http://replisuwumv.toplog.nl replica handbag] [http://coacheygoum.toplog.nl coach handbag] [http://gucciakuupm.toplog.nl gucci handbag] [http://pradaimieyj.toplog.nl prada handbag] [http://fendinptvxq.toplog.nl fendi handbag] [http://louiszekmjg.toplog.nl louis vuitton handbag] [http://cheapbuy.toplog.nl/ cheap buy xanax] [http://orderedxanax.toplog.nl/ order xanax online] [http://toplognl.toplog.nl/ buy xanax] [http://tramadol.toplog.nl/ buy tramadol] [http://xanaxx.zikforum.com/ buy xanax online] [http://handbag.toplog.nl/ replica coach handbag] [http://vtopp.zikforum.com louis vuitton replica handbag] [http://e-mercato.org/vtop/wholesalehandbag.html wholesale replica handbag] [http://e-mercato.org/vtop/rdesignerhandbag.html replica designer handbag] [http://e-mercato.org/vtop/pradahandbag.html prada replica handbag] [http://e-mercato.org/vtop/louisvuittonhandbag.html louis vuitton replica handbag] [http://e-mercato.org/vtop/guccihandbag.html replica gucci handbag] [http://e-mercato.org/vtop/designerhandbag.html designer handbag replica] [http://e-mercato.org/vtop/coachhandbag.html replica coach handbag] [http://e-mercato.org/vtop/chanelhandbag.html replica chanel handbag] [http://www.dablogs.com/?u=vverh quality replica watch] [http://www.freewebs.com/vverh/ quality replica watch] [http://vverh.forumup.org quality replica watch] [http://topnash.forumup.org/ swiss replica rolex watch] [http://www.freewebs.com/topnash/ swiss replica rolex watch] [http://www.dablogs.com/?u=topnash swiss replica rolex watch] [http://www.dablogs.com/?u=buduvtope omega replica watch] [http://www.freewebs.com/buduvtope/ omega replica watch] [http://buduvtope.forumup.org omega replica watch] [http://www.dablogs.com/?u=replicahandbag12 louis vuitton replica handbag] [http://replicahandbag12.forumup.org/ louis vuitton replica handbag] [http://cartier.forumup.org/ cartier replica watch] [http://www.dablogs.com/?u=cartier cartier replica watch] [http://www.freewebs.com/cartierwatch/ cartier replica watch] [http://www.freewebs.com/brietling/ breitling replica watch] [http://www.dablogs.com/?u=brietling breitling replica watch] </div>
| + | === Subsection 1.4.1: Algebraic tensor operations in OpenFOAM === |
| | + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} |
| | + | |
| | + | In ''Table 1.2: Algebraic tensor operations in OpenFOAM'', the following entries need fixing: |
| | + | {| border="1" cellpadding="2" |
| | + | ! Operation !! Description in OpenFOAM<br>''(wrong)'' !! Description in OpenFOAM<br>''(correct)'' |
| | + | |- |
| | + | | Component maximum || max(a) || cmptMax(a) |
| | + | |- |
| | + | | Component minimum || min(a) || cmptMin(a) |
| | + | |- |
| | + | | Scale || scale(a,b) || cmptMultiply(a,b) |
| | + | |} |
| | + | |
| | + | = Chapter 2: Discretisation procedures = |
| | + | |
| | + | == Section 2.1: Differential operators == |
| | + | |
| | + | === Subsection 2.1.2: Divergence === |
| | + | {{versionInfo}}{{Version1.5}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}} |
| | + | |
| | + | ('''Note''': Already fixed in {{Version2.2}}) |
| | + | |
| | + | The documented divergence operator for tensors is incorrect: |
| | + | |
| | + | <math> |
| | + | \nabla \bullet T = \partial_i T_{ij}=\left( |
| | + | \begin{matrix} |
| | + | \frac{\partial T_{11}}{\partial x_1} + \frac{\partial T_{12}}{\partial x_1} + \frac{\partial T_{13}}{\partial x_1}\\ |
| | + | \frac{\partial T_{21}}{\partial x_2} + \frac{\partial T_{22}}{\partial x_2} + \frac{\partial T_{23}}{\partial x_2}\\ |
| | + | \frac{\partial T_{31}}{\partial x_3} + \frac{\partial T_{32}}{\partial x_3} + \frac{\partial T_{33}}{\partial x_3} |
| | + | \end{matrix} |
| | + | \right) |
| | + | </math> |
| | + | |
| | + | It should be: |
| | + | |
| | + | <math> |
| | + | \nabla \bullet T = |
| | + | \left( |
| | + | \begin{matrix} |
| | + | \frac{\partial }{\partial x_1}, & \frac{\partial }{\partial x_2}, & \frac{\partial}{\partial x_3} |
| | + | \end{matrix} |
| | + | \right) |
| | + | \bullet |
| | + | \left( |
| | + | \begin{matrix} |
| | + | T_{11} & T_{12} & T_{13} \\ |
| | + | T_{21} & T_{22} & T_{33} \\ |
| | + | T_{31} & T_{32} & T_{33} \\ |
| | + | \end{matrix} |
| | + | \right) |
| | + | =\partial_j T_{ji}=\left( |
| | + | \begin{matrix} |
| | + | \frac{\partial T_{11}}{\partial x_1} + \frac{\partial T_{21}}{\partial x_2} + \frac{\partial T_{31}}{\partial x_3}\\ |
| | + | \frac{\partial T_{12}}{\partial x_1} + \frac{\partial T_{22}}{\partial x_2} + \frac{\partial T_{33}}{\partial x_3}\\ |
| | + | \frac{\partial T_{13}}{\partial x_1} + \frac{\partial T_{32}}{\partial x_2} + \frac{\partial T_{33}}{\partial x_3} |
| | + | \end{matrix} |
| | + | \right) |
| | + | </math> |
| | + | |
| | + | |
| | + | == Section 2.4: Equation discretisation == |
| | + | |
| | + | |
| | + | === Subsection 2.4.6: Gradient === |
| | + | |
| | + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} |
| | + | |
| | + | * All references to '''timeScheme''' should be either ''gradSchemes'' or ''snGradSchemes'' [http://www.cfd-online.com/Forums/openfoam-bugs/82225-programmers-guide-p-40-a.html]. |
| | + | * The indication of '''[Check**]''' implies that this subsection needs to be revised. |
| | + | |
| | + | |
| | + | === Subsection 2.6.1: Physical boundary conditions === |
| | + | |
| | + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} |
| | + | |
| | + | * The indication of '''[Check**]''' implies that this subsection needs to be revised. |
| | + | |
| | + | |
| | + | |
| | + | = Chapter 3: Examples of the use of OpenFOAM = |
| | + | |
| | + | |
| | + | = Chapter 4: Programming techniques = |
| | + | |
| | + | |
| | + | <br> |
| | + | = Known forum threads on this topic = |
| | + | This is a unordered list of links to threads about typos and errors in the ''Programmer's Guide'' that have been found by the community: |
| | + | |
| | + | * [http://www.cfd-online.com/Forums/openfoam-bugs/104867-bug-programmers-guide-divergence-tensor-field.html Bug in the programmer's guide: divergence of a tensor field] |
| | + | ** Documented in [[#Subsection 2.1.2: Divergence|Subsection 2.1.2: Divergence]], but keep in mind that this has already been fixed. |
| | + | * [http://www.cfd-online.com/Forums/openfoam-bugs/82225-programmers-guide-p-40-a.html In Programmer's Guide p. 40] |
| | + | ** The issues in post #1 are at [[#Subsection 2.4.6: Gradient|Subsection 2.4.6: Gradient]] and [[#Subsection 2.6.1: Physical boundary conditions|Subsection 2.6.1: Physical boundary conditions]] |
| | + | * [http://www.cfd-online.com/Forums/openfoam-bugs/73361-programmers-guide-bugs.html Programmers Guide Bugs] |
| | + | ** The issues indicated in post #1 are already here in the wiki in the subsection [[#Subsection 1.4.1 Algebraic tensor operations in OpenFOAM|Subsection 1.4.1 Algebraic tensor operations in OpenFOAM]]. |
| | + | * [http://www.cfd-online.com/Forums/openfoam-bugs/62533-error-documentation.html Error in documentation] |
| | + | ** Only affects {{version1.4.1}} |
| | + | |
| | + | [[Category:OpenFOAM guide]] |
