Difference between revisions of "OpenFOAM"

From UFRC
Jump to navigation Jump to search
 
(13 intermediate revisions by 3 users not shown)
Line 8: Line 8:
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
 
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
 
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
 +
|{{#vardefine:slurm|}} <!--Enable SLURM script wiki page link-->
 
|{{#vardefine:policy|}} <!--Enable policy section -->
 
|{{#vardefine:policy|}} <!--Enable policy section -->
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
Line 23: Line 24:
 
==Required Modules==
 
==Required Modules==
 
[[Modules|modules documentation]]
 
[[Modules|modules documentation]]
*intel
+
*intel/2018
*openmpi
+
*openmpi/3.0.0
*openfoam
+
*openfoam/5.0
 +
 
 +
<pre>
 +
$ module load intel/2018  openmpi/3.0.0 openfoam/5.0
 +
</pre>
  
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR - installation directory
+
{|cellpadding="10"
* HPC_LAMMPS_BIN - executable directory
+
|-style="vertical-align:top;"
* HPC_LAMMPS_LIB - library directory
+
|
 +
=== OpenFOAM variables ===
 +
* FOAM_INST_DIR - installation base directory
 +
* FOAM_APPBIN - executable program directory
 +
* FOAM_LIB - library directory
 +
* FOAM_SRC - source directory
 +
* FOAM_EXT_LIBBIN - ThirdParty library directory
 +
* PV_PLUGIN_PATH - ParaView library directory
 +
* FOAM_TUTORIALS - tutorial directory
 +
||
 +
=== Wmake variables ===
 +
These are the wmake parameters used in building OpenFOAM and could be used for compiling the third-party OpenFOAM applications using wmake.
 +
 
 +
* WM_PROJECT_INST_DIR - wmake installation base directory
 +
* WM_PROJECT_VERSION - wmake project version
 +
* WM_PROJECT - wmake project name (OpenFOAM in this case)
 +
* WM_PROJECT_DIR - wmake project directory
 +
* WM_DIR - directory where "wmake" executable is
 +
* WM_ARCH - architecture type
 +
* WM_COMPILER - compiler name
 +
* WM_COMPILE_OPTION - compiler option
 +
* WM_LINK_LANGUAGE - compiler for linking
 +
* WM_PRECISION_OPTION - precision type
 +
|}
 +
 
 
<!--Additional-->
 
<!--Additional-->
 
{{#if: {{#var: exe}}|==Additional Information==
 
{{#if: {{#var: exe}}|==Additional Information==
Line 38: Line 67:
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
 +
{{#if: {{#var: slurm}}|==SLURM Script Examples==
 +
See the [[{{PAGENAME}}_SLURM]] page for {{#var: app}} SLURM script examples.|}}
 
{{#if: {{#var: policy}}|==Usage Policy==
 
{{#if: {{#var: policy}}|==Usage Policy==
 
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
 
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}

Latest revision as of 14:20, 15 December 2022

Description

OpenFoam website  

OpenFOAM is a free, open source CFD software package produced by a commercial company, OpenCFD Ltd. It has a large user base across most areas of engineering and science, from both commercial and academic organisations. OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to solid dynamics and electromagnetic.

Required Modules

modules documentation

  • intel/2018
  • openmpi/3.0.0
  • openfoam/5.0
$ module load intel/2018  openmpi/3.0.0 openfoam/5.0

System Variables

OpenFOAM variables

  • FOAM_INST_DIR - installation base directory
  • FOAM_APPBIN - executable program directory
  • FOAM_LIB - library directory
  • FOAM_SRC - source directory
  • FOAM_EXT_LIBBIN - ThirdParty library directory
  • PV_PLUGIN_PATH - ParaView library directory
  • FOAM_TUTORIALS - tutorial directory

Wmake variables

These are the wmake parameters used in building OpenFOAM and could be used for compiling the third-party OpenFOAM applications using wmake.

  • WM_PROJECT_INST_DIR - wmake installation base directory
  • WM_PROJECT_VERSION - wmake project version
  • WM_PROJECT - wmake project name (OpenFOAM in this case)
  • WM_PROJECT_DIR - wmake project directory
  • WM_DIR - directory where "wmake" executable is
  • WM_ARCH - architecture type
  • WM_COMPILER - compiler name
  • WM_COMPILE_OPTION - compiler option
  • WM_LINK_LANGUAGE - compiler for linking
  • WM_PRECISION_OPTION - precision type