The following table shows selected system variables and aliases in OpenFOAM.
Directory
Variable
Alias
Description
OpenFOAM-dev
WM_PROJECT_DIR
foam
Jumps to directory of version dev
applications
FOAM_APP
app
Jumps to directory application
solvers
FOAM_SOLVERS
sol
Jumps to directory application/solvers
utilities
FOAM_UTILITIES
util
Jumps to directory application/utilities
platforms
platformName
lib
FOAM_LIBBIN
lib
Jumps to directory with compiled libraries
src
FOAM_SRC
src
Jumps to directory src
tutorials
FOAM_TUTORIALS
tut
Jumps to directory tutorials
System variable (environment variable) definition: # export variable=value (bash) # setenv variable value (csh, tcsh) usage: # $variable example: # export WM_PROJECT_DIR=$HOME/OpenFOAM/OpenFOAM-dev # defines system variable WM_PROJECT_DIR, which contains the path to directory OpenFOAM-dev # cd $WM_PROJECT_DIR # jump to directory OpenFOAM-dev
alias (user defined one-word command substitution for another command) definition: # alias name=`commands` usage: # name example: # alias foam=`cd $WM_PROJECT_DIR` # alias definition foam for jumping to directory OpenFOAM-dev # foam # jumps to directory OpenFOAM-dev
The first part of the simulation is the setup. The plugin TCFDSource presents an intuitive graphical user interface (GUI) for the complete setup of a TCFD calculation. It is possible to save the data from the form to a file and also to read them back, whenever necessary.
When starting a new calculation, make sure that the TCFDSource plugin is loaded (Tools > Manage Plugins…). If you can see the plugin in the list (“SMTCFDSource…”), you should be also able to locate the VTK source in the menu Sources (Sources > TCFD Source). Select that item; it will add a new object to the Pipeline Browser window.
Figure: Source TCFDSource added to the Pipeline Browser.
A long form will appear in the Properties panel, which may become even longer, depending on the current settings, if you show the advanced options using the Toggle advanced properties button next to the search bar (wheel icon, see Figure left). The advanced mode is indicated by orange color of section headers (see Figure right). Generally, the advanced properties have universally reasonable values and are not necessary to modify. Individual sections of the form can be folded and unfolded by a single click on their header. Double click on a header will hide all other section than the one clicked.
Figure: Toggle advanced properties button.
A new TCFDSource form contains default values. It is also possible to import an already prepared TCFD setup file (with the *.tcfd extension) into this form and start editing those. You can load a TCFD setup file by using the menu item File > Open… (or using the toolbar button, or the keyboard shortcut (Ctrl + O) and selecting the file in the dialog window.
Once the form is edited to your satisfaction, press Apply. This finalizes the setup and provides you with a concise table summarizing the options in the syntax of the TCFD setup files. Of course, it is possible to edit the entries even after clicking Apply. If you do, the Apply button will be enabled again and the changes need to be accepted anew.
The TCFDSource plugin is relatively uncommon with regard to its output. While most built-in ParaView sources and filters have just one output, TCFDSource provides two outputs! These are clearly visible in the Pipeline Browser. The output “Settings” provides a table with raw settings, which can be saved as a *.tcfd file or passed to TCFDManager filter (described in the next chapter). The output “Components” provides the component geometry and is displayed in the common 3D RenderView.
The state of the form can be saved as a TCFD setup file using the menu item File > Save Data… (or the appropriate toolbar button, or using the keyboard shortcut Ctrl + S). In the Save File: dialog first select the correct extension *.tcfd; only then the correct plugin will be used for writing the data. The form must be confirmed by Apply before saving.
The following sections provide details for individual form fields.