http://wiki.aperturelab.science/api.php?action=feedcontributions&feedformat=atom&user=ArgononSapienza Rocket Team - User contributions [en]2026-04-11T18:19:03ZUser contributionsMediaWiki 1.43.0http://wiki.aperturelab.science/index.php?title=Getting_Started&diff=179Getting Started2025-06-14T11:20:53Z<p>Argonon: /* Constant Directory */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The '''''# include''''' command simply copy and past the given file's content. So in the "Include/initialConditions", for example, we wrote all initial conditions for the case, like velocity, pressure ecc... and then import it into U file. The '''''internalField''''' key set the field value, the '''''$''''' symbol get the associated value. <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''[https://www.openfoam.com/documentation/user-guide/5-models-and-physical-properties/5.2-thermophysical-models transportProperties]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-turbulence.html turbulenceProperties]'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''[https://www.openfoam.com/documentation/user-guide/5-models-and-physical-properties/5.2-thermophysical-models transportProperties]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-turbulence.html turbulenceProperties]''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation by typing: <syntaxhighlight lang="bash"><br />
/Allclean<br />
/Allrun<br />
</syntaxhighlight><br />
If these file are not executable, run the following command: <syntaxhighlight lang="bash"><br />
/chmod +x /All*<br />
</syntaxhighlight><br />
However, it's beneficial to learn how to perform these actions manually: <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=178Getting Started2025-06-14T11:16:23Z<p>Argonon: /* Constant Directory */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The '''''# include''''' command simply copy and past the given file's content. So in the "Include/initialConditions", for example, we wrote all initial conditions for the case, like velocity, pressure ecc... and then import it into U file. The '''''internalField''''' key set the field value, the '''''$''''' symbol get the associated value. <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation by typing: <syntaxhighlight lang="bash"><br />
/Allclean<br />
/Allrun<br />
</syntaxhighlight><br />
If these file are not executable, run the following command: <syntaxhighlight lang="bash"><br />
/chmod +x /All*<br />
</syntaxhighlight><br />
However, it's beneficial to learn how to perform these actions manually: <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=177Linux Introduction2025-06-14T11:08:53Z<p>Argonon: /* Installing Debian */</p>
<hr />
<div>[[File:GUI vm2.png|thumb|301x301px|Gui of VM Box]]<br />
<br />
=== Installing VM-Box Oracle ===<br />
[[File:Creazione vm1.png|thumb]]<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software. You should see an interface similar to the one shown in the image beside this text.<br />
<br />
=== Upload ISO file ===<br />
Your next step is to upload the ISO file downloaded in the previous section. Press the '''''New''''' button and a pop up as showed on the left will appear. Select a name and on '''''ISO image''''' select the downloaded file. For the next steps: <br />
<br />
# Update '''''User''''' and '''''Password'''''<br />
# Allocate '''''ram''''' and '''''core number''''' based on your pc <br />
# [[File:GUI vm1.png|thumb]]Allocate '''''at least 60-80 GB''''' of solid memory<br />
<br />
After that you should see your new machine in the main window. <br />
<br />
<br />
<br />
<br />
=== Installing Debian ===<br />
Now it's time to launch your virtual machine. During the initial startup, the VM will begin the Debian installation process and prompt you to enter some information , in particular save the '''''Root password and your User name and password'''''. The most important step is to '''''install Debian as the primary operating system''''' within the VM, not as a dual-boot partition. Don’t worry,this won't affect your Windows installation, as everything is contained within the virtual environment. At a certain point, Debian will ask you to choose a desktop environment. We recommend selecting the '''''KDE desktop''''' due to its visual and functional similarity to Windows.<br />
<br />
=== Installing Debian as dual-boot ===<br />
If you prefer not to use a virtual machine, you can install Debian as a dual-boot system on your PC, or you can remove Windows entirely to unlock the full potential of Debian.<br />
<br />
The process is relatively straightforward. First, you’ll need a USB drive, which must be formatted with the Debian ISO image. A tool like [https://etcher.balena.io/ balenaEtcher]can be used for this purpose. Once the USB is ready, you’ll need to create a new partition on your hard drive. Keep in mind that '''''Debian typically requires 20–25 GB''''' after installation. We recommend allocating '''''100–150 GB''''' of storage space ('''HDD''' or '''SSD''') for optimal performance.<br />
<br />
Next, insert the prepared USB drive, reboot your PC, and boot from the USB. To do this, press '''F12''', '''F2''', or the appropriate key for your system during startup to access the BIOS/boot menu and select the USB device.<br />
<br />
Debian will then begin the installation process. This time, make sure to choose '''''dual-boot installation''''', not "use entire disk" or "replace existing OS," as that would remove Windows. Select the new partition you created earlier for Debian. From this point onward, the installation steps are the same as described in the virtual machine section.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=176Getting Started2025-06-14T11:07:04Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The # include command simply copy and past the given file's content. So in the "Include/initialConditions", for example, we wrote all initial conditions for the case, like velocity, pressure ecc... and then import it into U file. In particular we have "flowVelocity: xxxx" and the $flowVelocity command get the value xxxx. <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation by typing: <syntaxhighlight lang="bash"><br />
/Allclean<br />
/Allrun<br />
</syntaxhighlight><br />
If these file are not executable, run the following command: <syntaxhighlight lang="bash"><br />
/chmod +x /All*<br />
</syntaxhighlight><br />
However, it's beneficial to learn how to perform these actions manually: <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=175Getting Started2025-06-14T11:04:43Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The # include command simply copy and past the given file's content. So in the "Include/initialConditions", for example, we wrote all initial conditions for the case, like velocity, pressure ecc... and then import it into U file. In particular we have "flowVelocity: xxxx" and the $flowVelocity command get the value xxxx. <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=174Getting Started2025-06-14T11:04:21Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The # include command simply copy and past the given file's content. So in the "Include/InitialConditions", for example, we wrote all initial conditions for the case, like velocity, pressure ecc... and then import it into U file. In particular we have "FlowVelocity: xxxx" and the $FlowVelocity command get the value xxxx. <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=173Getting Started2025-06-14T11:02:57Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
The # include command simply copy and past the given file's content. So in the "Include/InitialConditions2, for example, we wrote all initial conditions for the case, like velocity, pressure ecc... . This <br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=172Linux Introduction2025-06-13T16:51:34Z<p>Argonon: /* Installing VM-Box Oracle */</p>
<hr />
<div>[[File:GUI vm2.png|thumb|301x301px|Gui of VM Box]]<br />
<br />
=== Installing VM-Box Oracle ===<br />
[[File:Creazione vm1.png|thumb]]<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software. You should see an interface similar to the one shown in the image beside this text.<br />
<br />
=== Upload ISO file ===<br />
Your next step is to upload the ISO file downloaded in the previous section. Press the '''''New''''' button and a pop up as showed on the left will appear. Select a name and on '''''ISO image''''' select the downloaded file. For the next steps: <br />
<br />
# Update '''''User''''' and '''''Password'''''<br />
# Allocate '''''ram''''' and '''''core number''''' based on your pc <br />
# [[File:GUI vm1.png|thumb]]Allocate '''''at least 60-80 GB''''' of solid memory<br />
<br />
After that you should see your new machine in the main window. <br />
<br />
<br />
<br />
<br />
=== Installing Debian ===<br />
Now it's time to launch your virtual machine. During the initial startup, the VM will begin the Debian installation process and prompt you to enter some information. The most important step is to '''''install Debian as the primary operating system''''' within the VM, not as a dual-boot partition. Don’t worry,this won't affect your Windows installation, as everything is contained within the virtual environment. At a certain point, Debian will ask you to choose a desktop environment. We recommend selecting the '''''KDE desktop''''' due to its visual and functional similarity to Windows.<br />
<br />
=== Installing Debian as dual-boot ===<br />
If you prefer not to use a virtual machine, you can install Debian as a dual-boot system on your PC, or you can remove Windows entirely to unlock the full potential of Debian.<br />
<br />
The process is relatively straightforward. First, you’ll need a USB drive, which must be formatted with the Debian ISO image. A tool like [https://etcher.balena.io/ balenaEtcher]can be used for this purpose. Once the USB is ready, you’ll need to create a new partition on your hard drive. Keep in mind that '''''Debian typically requires 20–25 GB''''' after installation. We recommend allocating '''''100–150 GB''''' of storage space ('''HDD''' or '''SSD''') for optimal performance.<br />
<br />
Next, insert the prepared USB drive, reboot your PC, and boot from the USB. To do this, press '''F12''', '''F2''', or the appropriate key for your system during startup to access the BIOS/boot menu and select the USB device.<br />
<br />
Debian will then begin the installation process. This time, make sure to choose '''''dual-boot installation''''', not "use entire disk" or "replace existing OS," as that would remove Windows. Select the new partition you created earlier for Debian. From this point onward, the installation steps are the same as described in the virtual machine section.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=171Linux Introduction2025-06-13T16:51:04Z<p>Argonon: </p>
<hr />
<div>[[File:GUI vm2.png|thumb|301x301px|Gui of VM Box]]<br />
<br />
== Installing VM-Box Oracle ==<br />
[[File:Creazione vm1.png|thumb]]<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software. You should see an interface similar to the one shown in the image beside this text.<br />
<br />
=== Upload ISO file ===<br />
Your next step is to upload the ISO file downloaded in the previous section. Press the '''''New''''' button and a pop up as showed on the left will appear. Select a name and on '''''ISO image''''' select the downloaded file. For the next steps: <br />
<br />
# Update '''''User''''' and '''''Password'''''<br />
# Allocate '''''ram''''' and '''''core number''''' based on your pc <br />
# [[File:GUI vm1.png|thumb]]Allocate '''''at least 60-80 GB''''' of solid memory<br />
<br />
After that you should see your new machine in the main window. <br />
<br />
<br />
<br />
<br />
=== Installing Debian ===<br />
Now it's time to launch your virtual machine. During the initial startup, the VM will begin the Debian installation process and prompt you to enter some information. The most important step is to '''''install Debian as the primary operating system''''' within the VM, not as a dual-boot partition. Don’t worry,this won't affect your Windows installation, as everything is contained within the virtual environment. At a certain point, Debian will ask you to choose a desktop environment. We recommend selecting the '''''KDE desktop''''' due to its visual and functional similarity to Windows.<br />
<br />
=== Installing Debian as dual-boot ===<br />
If you prefer not to use a virtual machine, you can install Debian as a dual-boot system on your PC, or you can remove Windows entirely to unlock the full potential of Debian.<br />
<br />
The process is relatively straightforward. First, you’ll need a USB drive, which must be formatted with the Debian ISO image. A tool like [https://etcher.balena.io/ balenaEtcher]can be used for this purpose. Once the USB is ready, you’ll need to create a new partition on your hard drive. Keep in mind that '''''Debian typically requires 20–25 GB''''' after installation. We recommend allocating '''''100–150 GB''''' of storage space ('''HDD''' or '''SSD''') for optimal performance.<br />
<br />
Next, insert the prepared USB drive, reboot your PC, and boot from the USB. To do this, press '''F12''', '''F2''', or the appropriate key for your system during startup to access the BIOS/boot menu and select the USB device.<br />
<br />
Debian will then begin the installation process. This time, make sure to choose '''''dual-boot installation''''', not "use entire disk" or "replace existing OS," as that would remove Windows. Select the new partition you created earlier for Debian. From this point onward, the installation steps are the same as described in the virtual machine section.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Aerodynamics&diff=170Aerodynamics2025-06-13T16:50:19Z<p>Argonon: </p>
<hr />
<div>== Department: ==<br />
[[File:Arodinamic Logo.jpg|thumb|180x180px|Aerodynamic department logo]]<br />
The Aerodynamics department of SRT ''[https://www.sasa-aerospace.it/rocket-team/ (Sapienza Rocket Team)]'' aim to study and analyze the air flow around the rocket-model. The goal of these studies is to predict the position of [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/cp.html Center of Pressure] ''(CoP),'' as well as all aerodynamics force coefficients, body force coefficients and and the overall pressure distribution around the rocket. <br />
<br />
The Center of Pressure is the point where the aerodynamic forces acting on a body are concentrated. Understanding where this point is located and how it shifts along the rocket allows for the evaluation of moments, which is essential for assessing static stability. <br />
<br />
Aerodynamic coefficients, such as the [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/dragco.html Drag Coefficient] ''(CD)'' and [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/liftco.html Lift Coefficient] ''(CL)'', are important for estimating a rocket's behavior. For example, evaluating the drag coefficient (CD) is crucial for predicting the apogee reached by the rocket, especially when the body does not have an Angle of Attack ''(AoA''). <br />
<br />
In summary, all of these studies are essential for predicting the behavior of the rocket model during its flight. They also help evaluate the appropriate materials and structure to use. Both of these studies are conducted by the [[Mission Analysis]] and [[Structures]] departments. <br />
<br />
== Preliminary Studies: == <br />
<br />
== CFD Simulation with OpenFOAM: ==<br />
<br />
This section provides a practical approach to CFD. The following pages will guide you through setting up a simulation step-by-step for different cases, all conducted in [https://www.openfoam.com/ OpenFOAM], an open-source software written in C++. <br />
<br />
Before getting started, you can install OpenFOAM [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian here], which is designed for Linux environment, such as Ubuntu or Debian. If you are working on Windows, OpenFOAM is also available through the [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/windows WSL Virtual Machine](Windows Subsystem for Linux).<br />
<br />
==== OpenFOAM ====<br />
<br />
* [[Linux Introduction|Linux Installing]]<br />
* [[Getting Started]]<br />
* Run in Batch<br />
<br />
==== Meshing ====<br />
<br />
* [[ANSA]]<br />
* cfMesh<br />
* Salome<br />
<br />
==== Steady-State Simulations : ====<br />
* Compressible:<br />
** [[Subsonic]]<br />
** [[Sonic]]<br />
** [[Supersonic]]<br />
* Uncompressible:<br />
** [[Subsonic]]<br />
<br />
==== Transient Simulations : ====</div>Argononhttp://wiki.aperturelab.science/index.php?title=Aerodynamics&diff=169Aerodynamics2025-06-13T16:49:22Z<p>Argonon: /* OpenFOAM */</p>
<hr />
<div>== Department: ==<br />
[[File:Arodinamic Logo.jpg|thumb|180x180px|Aerodynamic department logo]]<br />
The Aerodynamics department of SRT ''[https://www.sasa-aerospace.it/rocket-team/ (Sapienza Rocket Team)]'' aim to study and analyze the air flow around the rocket-model. The goal of these studies is to predict the position of [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/cp.html Center of Pressure] ''(CoP),'' as well as all aerodynamics force coefficients, body force coefficients and and the overall pressure distribution around the rocket. <br />
<br />
The Center of Pressure is the point where the aerodynamic forces acting on a body are concentrated. Understanding where this point is located and how it shifts along the rocket allows for the evaluation of moments, which is essential for assessing static stability. <br />
<br />
Aerodynamic coefficients, such as the [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/dragco.html Drag Coefficient] ''(CD)'' and [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/liftco.html Lift Coefficient] ''(CL)'', are important for estimating a rocket's behavior. For example, evaluating the drag coefficient (CD) is crucial for predicting the apogee reached by the rocket, especially when the body does not have an Angle of Attack ''(AoA''). <br />
<br />
In summary, all of these studies are essential for predicting the behavior of the rocket model during its flight. They also help evaluate the appropriate materials and structure to use. Both of these studies are conducted by the [[Mission Analysis]] and [[Structures]] departments. <br />
<br />
== Preliminary Studies: == <br />
<br />
== CFD Simulation with OpenFOAM: ==<br />
<br />
This section provides a practical approach to CFD. The following pages will guide you through setting up a simulation step-by-step for different cases, all conducted in [https://www.openfoam.com/ OpenFOAM], an open-source software written in C++. <br />
<br />
Before getting started, you can install OpenFOAM [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian here], which is designed for Linux environment, such as Ubuntu or Debian. If you are working on Windows, OpenFOAM is also available through the [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/windows WSL Virtual Machine](Windows Subsystem for Linux).<br />
<br />
==== OpenFOAM ====<br />
<br />
* [[Linux Introduction]]<br />
* [[Getting Started]]<br />
* Run in Batch<br />
<br />
==== Meshing ====<br />
<br />
* [[ANSA]]<br />
* cfMesh<br />
* Salome<br />
<br />
==== Steady-State Simulations : ====<br />
* Compressible:<br />
** [[Subsonic]]<br />
** [[Sonic]]<br />
** [[Supersonic]]<br />
* Uncompressible:<br />
** [[Subsonic]]<br />
<br />
==== Transient Simulations : ====</div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=168Linux Introduction2025-06-13T16:47:12Z<p>Argonon: </p>
<hr />
<div>[[File:GUI vm2.png|thumb|301x301px|Gui of VM Box]]<br />
<br />
=== Installing VM-Box Oracle ===<br />
[[File:Creazione vm1.png|thumb]]<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software. You should see an interface similar to the one shown in the image beside this text.<br />
<br />
=== Upload ISO file ===<br />
Your next step is to upload the ISO file downloaded in the previous section. Press the '''''New''''' button and a pop up as showed on the left will appear. Select a name and on '''''ISO image''''' select the downloaded file. For the next steps: <br />
<br />
# Update '''''User''''' and '''''Password'''''<br />
# Allocate '''''ram''''' and '''''core number''''' based on your pc <br />
# [[File:GUI vm1.png|thumb]]Allocate '''''at least 60-80 GB''''' of solid memory<br />
<br />
After that you should see your new machine in the main window. <br />
<br />
<br />
<br />
<br />
=== Installing Debian ===<br />
Now it's time to launch your virtual machine. During the initial startup, the VM will begin the Debian installation process and prompt you to enter some information. The most important step is to '''''install Debian as the primary operating system''''' within the VM, not as a dual-boot partition. Don’t worry,this won't affect your Windows installation, as everything is contained within the virtual environment. At a certain point, Debian will ask you to choose a desktop environment. We recommend selecting the '''''KDE desktop''''' due to its visual and functional similarity to Windows.<br />
<br />
=== Installing Debian as dual-boot ===<br />
If you prefer not to use a virtual machine, you can install Debian as a dual-boot system on your PC, or you can remove Windows entirely to unlock the full potential of Debian.<br />
<br />
The process is relatively straightforward. First, you’ll need a USB drive, which must be formatted with the Debian ISO image. A tool like [https://etcher.balena.io/ balenaEtcher]can be used for this purpose. Once the USB is ready, you’ll need to create a new partition on your hard drive. Keep in mind that '''''Debian typically requires 20–25 GB''''' after installation. We recommend allocating '''''100–150 GB''''' of storage space ('''HDD''' or '''SSD''') for optimal performance.<br />
<br />
Next, insert the prepared USB drive, reboot your PC, and boot from the USB. To do this, press '''F12''', '''F2''', or the appropriate key for your system during startup to access the BIOS/boot menu and select the USB device.<br />
<br />
Debian will then begin the installation process. This time, make sure to choose '''''dual-boot installation''''', not "use entire disk" or "replace existing OS," as that would remove Windows. Select the new partition you created earlier for Debian. From this point onward, the installation steps are the same as described in the virtual machine section.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=167Linux Introduction2025-06-13T16:25:19Z<p>Argonon: </p>
<hr />
<div>[[File:GUI vm2.png|thumb|301x301px|Gui of VM Box]]<br />
<br />
=== Installing VM-Box Oracle ===<br />
[[File:Creazione vm1.png|thumb]]<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software. You should see an interface similar to the one shown in the image beside this text.<br />
<br />
=== Upload ISO file ===<br />
Your next step is to upload the ISO file downloaded in the previous section. Press the '''''New''''' button and a pop up as showed on the left will appear. Select a name and on '''''ISO image''''' select the downloaded file. For the next steps: <br />
<br />
# Update '''''User''''' and '''''Password'''''<br />
# Allocate '''''ram''''' and '''''core number''''' based on your pc <br />
# [[File:GUI vm1.png|thumb]]Allocate '''''at least 60-80 GB''''' of solid memory<br />
<br />
After that you should see your new machine in the main window. <br />
<br />
<br />
<br />
<br />
=== Installing Debian ===<br />
Now it's time to launch your VM. During your first launch the VM will install debian and will ask you some info. The most important thing is to install debian as main OS and not as a partition. This will not delete Windows because you are installing it in a VM. At some point Debian will ask which Desktop you want. We advice to use KDE Desktop, because it's preatty</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:Creazione_vm1.png&diff=166File:Creazione vm1.png2025-06-13T16:13:16Z<p>Argonon: </p>
<hr />
<div>a</div>Argononhttp://wiki.aperturelab.science/index.php?title=Linux_Introduction&diff=165Linux Introduction2025-06-13T15:59:49Z<p>Argonon: Created page with "=== Installing Linux Debian === In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installati..."</p>
<hr />
<div>=== Installing Linux Debian ===<br />
In this section will guide you through the installation of Debian 12 using Oracle VM VirtualBox. First, download the Debian 12 ISO image by visiting the official website of [https://www.debian.org/distrib/ Debian] and selecting the appropriate file. Next, install [https://www.oracle.com/it/virtualization/technologies/vm/downloads/virtualbox-downloads.html Oracle VM VirtualBox] from the following link (insert link) and follow the installation instructions provided. Once the installation is complete, launch the software—you should see an interface similar to the one shown in the image beside this text.<br />
[[File:GUI vm1.png|thumb|625x625px|Gui of VM Box]]</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:GUI_vm1.png&diff=164File:GUI vm1.png2025-06-13T15:59:04Z<p>Argonon: </p>
<hr />
<div>a</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:GUI_vm2.png&diff=163File:GUI vm2.png2025-06-13T15:58:29Z<p>Argonon: </p>
<hr />
<div>a</div>Argononhttp://wiki.aperturelab.science/index.php?title=ANSA&diff=131ANSA2025-04-29T20:56:01Z<p>Argonon: </p>
<hr />
<div>=== Introduction : ===<br />
ANSA is the pre-processing suite made by ''[https://www.beta-cae.com/ BETA-CAE].'' This suite offer several instruments to make 3D models and meshes. In these pages we will see how generate different meshes and how which one should be use. <br />
<br />
This guide is based on ANSA-2025, where the GUI is changed from its previous versions. <br />
<br />
=== Overview : ===<br />
This is an overview of the new GUI of CFD suite : <br />
<br />
<br />
<br />
As we can see the lateral menu has moved in the top and some macros on the left, like the '''''PIDs''''' or the '''''batch mesh .'''''<br />
<br />
=== CAD import and fix : ===<br />
First thing is to import the CAD. This is simply made</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=130Getting Started2025-04-29T20:53:36Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
<syntaxhighlight lang="bash"><br />
mpirun -np "N" "methodName" -parallel<br />
</syntaxhighlight>The above command run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Aerodynamics&diff=129Aerodynamics2025-04-29T20:51:40Z<p>Argonon: </p>
<hr />
<div>== Department: ==<br />
[[File:Arodinamic Logo.jpg|thumb|180x180px|Aerodynamic department logo]]<br />
The Aerodynamics department of SRT ''[https://www.sasa-aerospace.it/rocket-team/ (Sapienza Rocket Team)]'' aim to study and analyze the air flow around the rocket-model. The goal of these studies is to predict the position of [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/cp.html Center of Pressure] ''(CoP),'' as well as all aerodynamics force coefficients, body force coefficients and and the overall pressure distribution around the rocket. <br />
<br />
The Center of Pressure is the point where the aerodynamic forces acting on a body are concentrated. Understanding where this point is located and how it shifts along the rocket allows for the evaluation of moments, which is essential for assessing static stability. <br />
<br />
Aerodynamic coefficients, such as the [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/dragco.html Drag Coefficient] ''(CD)'' and [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/liftco.html Lift Coefficient] ''(CL)'', are important for estimating a rocket's behavior. For example, evaluating the drag coefficient (CD) is crucial for predicting the apogee reached by the rocket, especially when the body does not have an Angle of Attack ''(AoA''). <br />
<br />
In summary, all of these studies are essential for predicting the behavior of the rocket model during its flight. They also help evaluate the appropriate materials and structure to use. Both of these studies are conducted by the [[Mission Analysis]] and [[Structures]] departments. <br />
<br />
== Preliminary Studies: == <br />
<br />
== CFD Simulation with OpenFOAM: ==<br />
<br />
This section provides a practical approach to CFD. The following pages will guide you through setting up a simulation step-by-step for different cases, all conducted in [https://www.openfoam.com/ OpenFOAM], an open-source software written in C++. <br />
<br />
Before getting started, you can install OpenFOAM [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian here], which is designed for Linux environment, such as Ubuntu or Debian. If you are working on Windows, OpenFOAM is also available through the [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/windows WSL Virtual Machine](Windows Subsystem for Linux).<br />
<br />
==== OpenFOAM ====<br />
<br />
* [[Getting Started]]<br />
* Run in Batch<br />
<br />
==== Meshing ====<br />
<br />
* [[ANSA]]<br />
* cfMesh<br />
* Salome<br />
<br />
==== Steady-State Simulations : ====<br />
* Compressible:<br />
** [[Subsonic]]<br />
** [[Sonic]]<br />
** [[Supersonic]]<br />
* Uncompressible:<br />
** [[Subsonic]]<br />
<br />
==== Transient Simulations : ====</div>Argononhttp://wiki.aperturelab.science/index.php?title=ANSA&diff=128ANSA2025-04-29T20:51:30Z<p>Argonon: Created page with "=== Introduction : === ANSA is the pre-processing suite made by ''[https://www.beta-cae.com/ BETA-CAE].'' This suite offer several instruments to make 3D models and meshes. In these pages we will see how generate different meshes and how which one should be use. This guide is based on ANSA-2025, where the GUI is changed from its previous versions. === Overview : === This is an overview of the new GUI of CFD suite : As we can see the lateral menu has moved in the..."</p>
<hr />
<div>=== Introduction : ===<br />
ANSA is the pre-processing suite made by ''[https://www.beta-cae.com/ BETA-CAE].'' This suite offer several instruments to make 3D models and meshes. In these pages we will see how generate different meshes and how which one should be use. <br />
<br />
This guide is based on ANSA-2025, where the GUI is changed from its previous versions. <br />
<br />
=== Overview : ===<br />
This is an overview of the new GUI of CFD suite : <br />
<br />
<br />
<br />
As we can see the lateral menu has moved in the top and some macros on the left, like the '''''PIDs''''' or the '''''batch mesh'''''</div>Argononhttp://wiki.aperturelab.science/index.php?title=Aerodynamics&diff=113Aerodynamics2025-04-14T20:15:50Z<p>Argonon: /* OpenFOAM */</p>
<hr />
<div>== Department: ==<br />
[[File:Arodinamic Logo.jpg|thumb|180x180px|Aerodynamic department logo]]<br />
The Aerodynamics department of SRT ''[https://www.sasa-aerospace.it/rocket-team/ (Sapienza Rocket Team)]'' aim to study and analyze the air flow around the rocket-model. The goal of these studies is to predict the position of [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/cp.html Center of Pressure] ''(CoP),'' as well as all aerodynamics force coefficients, body force coefficients and and the overall pressure distribution around the rocket. <br />
<br />
The Center of Pressure is the point where the aerodynamic forces acting on a body are concentrated. Understanding where this point is located and how it shifts along the rocket allows for the evaluation of moments, which is essential for assessing static stability. <br />
<br />
Aerodynamic coefficients, such as the [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/dragco.html Drag Coefficient] ''(CD)'' and [https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/liftco.html Lift Coefficient] ''(CL)'', are important for estimating a rocket's behavior. For example, evaluating the drag coefficient (CD) is crucial for predicting the apogee reached by the rocket, especially when the body does not have an Angle of Attack ''(AoA''). <br />
<br />
In summary, all of these studies are essential for predicting the behavior of the rocket model during its flight. They also help evaluate the appropriate materials and structure to use. Both of these studies are conducted by the [[Mission Analysis]] and [[Structures]] departments. <br />
<br />
== Preliminary Studies: == <br />
<br />
== CFD Simulation with OpenFOAM: ==<br />
<br />
This section provides a practical approach to CFD. The following pages will guide you through setting up a simulation step-by-step for different cases, all conducted in [https://www.openfoam.com/ OpenFOAM], an open-source software written in C++. <br />
<br />
Before getting started, you can install OpenFOAM [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian here], which is designed for Linux environment, such as Ubuntu or Debian. If you are working on Windows, OpenFOAM is also available through the [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/windows WSL Virtual Machine](Windows Subsystem for Linux).<br />
<br />
==== OpenFOAM ====<br />
<br />
* [[Getting Started]]<br />
* Run in Batch<br />
<br />
==== Meshing ====<br />
<br />
* ANSA<br />
* cfMesh<br />
* Salome<br />
<br />
==== Steady-State Simulations : ====<br />
* Compressible:<br />
** [[Subsonic]]<br />
** [[Sonic]]<br />
** [[Supersonic]]<br />
* Uncompressible:<br />
** [[Subsonic]]<br />
<br />
==== Transient Simulations : ====</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=112Getting Started2025-04-14T19:45:32Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
'''mpirun -np "N" "methodName" -parallel''' run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
if mpi is not installed it is possible to get it with the following commands<syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt-get install openmpi<br />
</syntaxhighlight><br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1" lang="bash"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo update<br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=111Getting Started2025-04-14T19:39:49Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
'''mpirun -np "N" "methodName" -parallel''' run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
<br />
Now you are finally running your first simulation in OpenFOAM!<br />
<br />
=== Post processing ===<br />
When the simulation end, we are ready to give a look. On the console run this command: <syntaxhighlight lang="bash" line="1"><br />
reconstrucPar -latestTime<br />
</syntaxhighlight>This recompose your last iteration from processor directories. <br />
<br />
Last command needed it <syntaxhighlight line="1"><br />
paraFoam<br />
</syntaxhighlight>This will load mesh and result in [https://www.paraview.org/ paraview]. If it is not installed on your device, it is possible to obtain with <syntaxhighlight lang="bash" line="1"><br />
sudo upgrade <br />
sudo apt install paraview<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=110Getting Started2025-04-14T19:26:26Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
We are finally ready to start the simulation. In the case directory, you will find two files named '''''Allrun''''' and '''''Allclean'''''. These are bash scripts that enable the user to clean up the case and initiate the simulation. However, it's beneficial to learn how to perform these actions manually. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
'''mpirun -np "N" "methodName" -parallel''' run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=109Getting Started2025-04-14T19:22:57Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''cp ./0.orig ./0''' simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''decomposePa'''r start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
'''mpirun -np "N" "methodName" -parallel''' run the case in parallel. ''N'' are your core numbers, ''methodName'' is the method selected in the '''''controlDict''''' file. In this example we are using '''''simpleFoam'''''.<br />
<br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=108Getting Started2025-04-14T19:21:33Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>'''1''' cp ./0.orig ./0 simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
<br />
'''2''' decomposePar start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
<br />
'''3''' mpirun -np "N" "methodName" -parallel run the case in parallel. N are your core numbers, methodName is the method selected in the controlDict file. In this example we are using simpleFoam.<br />
<br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=107Getting Started2025-04-14T19:20:01Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight><br />
<br />
*cp ./0.orig ./0 simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
* decomposePar start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
* mpirun -np "N" "methodName" -parallel run the case in parallel. N are your core numbers, methodName is the method selected in the controlDict file. In this example we are using simpleFoam.<br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=106Getting Started2025-04-14T19:19:26Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight><br />
<br />
# cp ./0.orig ./0 simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig.<br />
# decomposePar start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process.<br />
# mpirun -np "N" "methodName" -parallel run the case in parallel. N are your core numbers, methodName is the method selected in the controlDict file. In this example we are using simpleFoam.<br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=105Getting Started2025-04-14T19:18:50Z<p>Argonon: /* Run your case : */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight>cp ./0.orig ./0 simply copy the 0.orig directory in the same path and rename it in 0. That is necessary because OpenFOAM search 0 and not 0.orig. <br />
<br />
decomposePar start the decomposition of the case, splitting the mesh and apply boundaries, in order to parallelize the process. <br />
<br />
mpirun -np "N" "methodName" -parallel run the case in parallel. N are your core numbers, methodName is the method selected in the controlDict file. In this example we are using simpleFoam. <br />
<br />
Now you are finally running your first simulation in OpenFOAM!</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=104Getting Started2025-04-14T19:14:39Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.<br />
<br />
=== Run your case : ===<br />
Finally we are ready to run the simulation. in the case directory there are two files named "Allrun" and "Allclean". Both are bash executives that allow the user to clean-up the case and start it, but for now it's better understand which commands must be used. <syntaxhighlight lang="bash" line="1"><br />
cp ./0.orig ./0<br />
decomposePar<br />
mpirun -np "N" "methodName" -parallel<br />
<br />
</syntaxhighlight></div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=103Getting Started2025-04-14T19:06:12Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
=== 0 directory ===<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
=== Constant Directory ===<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
=== System directory ===<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=102Getting Started2025-04-13T10:07:50Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System directory ==<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]'''''<br />
** '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-controldict.html controlDict]''''' is the core of the simulation. It specifies the simulation method ,here '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-applications-solvers-incompressible-simpleFoam.html simpleFoam]''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''[https://www.openfoam.com/documentation/guides/latest/doc/guide-fos-forces-force-coeffs.html forceCoeffs]''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvschemes.html fvSchemes]''''' and '''''[https://www.openfoam.com/documentation/guides/latest/doc/guide-case-system-fvsolution.html fvSolution]''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''[https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-parallel.html decomposePar]''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=101Getting Started2025-04-11T23:12:03Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System directory ==<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''controlDict'''''<br />
** '''''fvSchemes'''''<br />
** '''''fvSolution'''''<br />
** '''''decomposePar'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''controlDict''''' is the core of the simulation. It specifies the simulation method ,here '''simpleFoam''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''forceCoeffs''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''fvSchemes''''' and '''''fvSolution''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''decomposePar''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=100Getting Started2025-04-11T23:10:59Z<p>Argonon: /* Constant Directory */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
[[File:Turbulentproperties image.png|thumb|300x300px]]The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System directory ==<br />
[[File:ControlDict image.png|thumb|257x257px]]<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: [[File:DecomposePar image.png|thumb|244x244px]]<br />
* '''"system"'''<br />
** '''''controlDict'''''<br />
** '''''fvSchemes'''''<br />
** '''''fvSolution'''''<br />
** '''''decomposePar'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''controlDict''''' is the core of the simulation. It specifies the simulation method ,here '''simpleFoam''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''forceCoeffs''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''fvSchemes''''' and '''''fvSolution''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''decomposePar''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=99Getting Started2025-04-11T23:06:21Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''[[File:Turbulentproperties image.png|thumb]]<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System directory ==<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: <br />
[[File:ControlDict image.png|thumb]]<br />
* [[File:DecomposePar image.png|thumb]]'''"system"'''<br />
** '''''controlDict'''''<br />
** '''''fvSchemes'''''<br />
** '''''fvSolution'''''<br />
** '''''decomposePar'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''controlDict''''' is the core of the simulation. It specifies the simulation method ,here '''simpleFoam''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''forceCoeffs''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''fvSchemes''''' and '''''fvSolution''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''decomposePar''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:Turbulentproperties_image.png&diff=98File:Turbulentproperties image.png2025-04-11T23:04:16Z<p>Argonon: </p>
<hr />
<div>.</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:ControlDict_image.png&diff=97File:ControlDict image.png2025-04-11T23:03:48Z<p>Argonon: </p>
<hr />
<div>.</div>Argononhttp://wiki.aperturelab.science/index.php?title=File:DecomposePar_image.png&diff=96File:DecomposePar image.png2025-04-11T23:02:37Z<p>Argonon: </p>
<hr />
<div>.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=95Getting Started2025-04-11T22:59:30Z<p>Argonon: /* System direcotry */</p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System directory ==<br />
The system directory can contain many files. In particular, you can create your own script in C++ using the OpenFOAM library to achieve complete customization. The main files of interest are: <br />
<br />
* '''"system"'''<br />
** '''''controlDict'''''<br />
** '''''fvSchemes'''''<br />
** '''''fvSolution'''''<br />
** '''''decomposePar'''''<br />
<br />
While there are additional files needed to create the mesh or collect information about the solution, exploring these files is not the focus of this page. <br />
<br />
The '''''controlDict''''' is the core of the simulation. It specifies the simulation method ,here '''simpleFoam''' is the ''SIMPLE'' method, along with other important details such as the iteration number, start and end times of the simulation, and more. The function key allow the user to add existing function, like '''forceCoeffs''' , to evaluate aerodynamics coefficients in a specific reference system. <br />
<br />
'''''fvSchemes''''' and '''''fvSolution''''' contains the divergence schemes for all the fields, gradients, flux, etc., as well as the solvers for each field, complete with various controls on residuals, tolerances, and other parameters. We will not delve deeply into these two files, as they are quite complex and not the focus of this section.<br />
<br />
Lastly, the '''''decomposePar''','' allow the user to decompose the case in different part using various methods. In this example the '''''hierarchical''''' method is employed, specifying how many pieces the case should be split into. This decomposition aims to parallelize the process across CPU cores, thereby speeding up the solution.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=94Getting Started2025-04-11T22:42:51Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''''U'''''<br />
** '''''p'''''<br />
** '''''nut'''''<br />
** '''''k'''''<br />
** '''''omega'''''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
== Constant Directory ==<br />
The constant directory contain the following files : <br />
<br />
* '''"constant"'''<br />
** '''''transportProperties'''''<br />
** '''''turbulenceProperties'''''<br />
** '''''ObjectFile - "polyMesh"'''''<br />
<br />
The last element in the list simply represent a 3D object or an already meshed object for OpenFOAM, underling that we need a specific mesh file/files for this software.<br />
<br />
The other two file, '''''transportProperties''''' and '''''turbulenceProperties''''' , contains respectively the fluid physic properties, such dynamic viscosity or in general transport constant, and the turbulence model. On the left are showed images for both files. <br />
<br />
In this example the '''''turbulenceProperties''''' file is set with a '''RAS''' (''Reynolds Averaged Simulation'') and the model selected is kOmegaSST. Values of k and omega are setted in the 0 directory, in the same name files. <br />
<br />
== System direcotry ==<br />
the system directory can contain a lot of files, in particular it is possible to create your own script made in C++ with OpenFOAM library to achive a complete customization. By the way the main files are : <br />
<br />
* '''"system"'''<br />
** '''''controlDict'''''<br />
** '''''fvSchemes'''''<br />
** '''''fvSolution'''''<br />
** '''''decomposePar'''''<br />
<br />
All other files are needed to create the mesh or obtain information about the solution, but explore those files is not the purpose of this page. <br />
<br />
The '''''controlDict''''' is the core of the simulation. It contains the name of the method, in this case simpleFoam is the SIMPLE method, and other stuff like iteration number, start and end time of the simulation,</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=93Getting Started2025-04-11T21:58:44Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
__NEWSECTIONLINK__</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=92Getting Started2025-04-11T21:58:30Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.<br />
<br />
__INDEX__</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=91Getting Started2025-04-11T21:56:57Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=90Getting Started2025-04-11T21:53:30Z<p>Argonon: /* Your First Case: */</p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
=== Your First Case: ===<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=89Getting Started2025-04-11T21:53:22Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
== Your First Case: ==<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=85Getting Started2025-04-11T17:32:03Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
== Your First Case: ==<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|410x410px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=84Getting Started2025-04-11T17:31:44Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
== Your First Case: ==<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the right show how the file is structured. <br />
[[File:U_file_photo.png|thumb|424x424px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=83Getting Started2025-04-11T17:31:06Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
== Your First Case: ==<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the left show how the file is structured. <br />
[[File:U_file_photo.png|thumb|424x424px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
<br />
<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argononhttp://wiki.aperturelab.science/index.php?title=Getting_Started&diff=82Getting Started2025-04-11T17:30:21Z<p>Argonon: </p>
<hr />
<div>== First Step in OpenFoam : ==<br />
Once you have installed OpenFOAM, hopefully without losing your mind, you can start its environment by typing in the terminal <syntaxhighlight lang="bash"><br />
openfoamXXXX<br />
</syntaxhighlight>where XXXX is the version selected during the download. <br />
<br />
From now on, the journey begins. <br />
<br />
== Your First Case: ==<br />
To run your first simulation, it is essential to understand how the software operates. Each simulation is organized into several sub-folders: <br />
<br />
* '''"Simulation_1"'''<br />
** '''"0"'''<br />
** '''"constant"'''<br />
** '''"system"'''<br />
<br />
The 0 directory contains specifications for the boundary fields, including patch type and initial values. <br />
<br />
The constant directory houses the geometry, mesh and files that define constant values, such as fluid or turbulence properties.<br />
<br />
The system directory hold all the instruction needed, including the Solver, numeric schemes, number of iterations, multi-processing options, and more.<br />
<br />
This is a brief overview of how a general case is structured in OpenFOAM. Below an illustration of how the directory should look. To clarify the upcoming paragraphs, we will use a tutorial located in the OpenFOAM sub-directory. You can access it by typing the following commands in your terminal : <syntaxhighlight lang="bash">cd $FOAM_TUTORIALS<br />
cd incompressible/simpleFoam/motorBike/</syntaxhighlight><br />
<br />
== 0 directory: ==<br />
The 0 directory contain the following files : <br />
<br />
* '''"0.orig"'''<br />
** '''U'''<br />
** '''p'''<br />
** '''nut'''<br />
** '''k'''<br />
** '''omega'''<br />
There is also another directory "include", but for now ignore it. <br />
The image on the left show how the file is structured. <br />
[[File:U_file_photo.png|thumb|424x424px]]<br />
In particular the image is referred to the U file, but all of them have the same structure. The file is like a key-value dictionary where the first key encountered is '''''dimension''''', following '''''internalField''''' and '''''boundaryField''''' (we skipped the "#include" for now) . The dimension, as we can imagine, define the physical dimensional unit of the field. The array [ ... ] has 7 slots that represent 7 different units in this order: <br />
{| class="wikitable mw-collapsible"<br />
|+OpenFOAM Dimensional Field Units<br />
|No.<br />
|Property<br />
|SI unit<br />
|USCS unit<br />
|-<br />
|1<br />
|Mass<br />
|kilogram (kg)<br />
|pound-mass (lbm)<br />
|-<br />
|2<br />
|Length<br />
|metre (m)<br />
|foot (ft)<br />
|-<br />
|3<br />
|Time<br />
|second (s)<br />
|second (s)<br />
|-<br />
|4<br />
|Temperature<br />
|Kelvin (K)<br />
|degree Rankine (R)<br />
|-<br />
|5<br />
|Quantity<br />
|mole (mol)<br />
|mole (mol)<br />
|-<br />
|6<br />
|Current<br />
|ampere (A)<br />
|ampere (A)<br />
|-<br />
|7<br />
|Luminous intensity<br />
|candela (cd)<br />
|candela (cd)<br />
|}<br />
The number given to the array represent the order of the dimension, for example <math>m\over s</math> is [0 1 -1 0 0 0 0].<br />
<br />
Internal field key represent the value of the field at the beginning. <br />
<br />
The boundary field key contains all the boundary conditions defined in the mesh. Each of them need a type and the relative options. Here is linked the [https://www.openfoam.com/documentation/user-guide/a-reference/a.4-standard-boundary-conditions standard boundary conditions] list for OpenFOAM.</div>Argonon