Script | Spoken-Tutorial - User contributions [en]

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:47:44Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''
You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using gedit.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"|

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:44:11Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''
You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using gedit.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:41:34Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''
You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:36:27Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''
You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:24:11Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:22:42Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Open terminal. Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to solve the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-28T11:19:58Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux Operating System '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities

<nowiki>--------------------------</nowiki>

Open terminal

Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

<nowiki>-------------------------------------------------------------------------------------------</nowiki>

Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to solve the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-28T10:30:37Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''
*We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge15Ma5 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Add the following lines above convertToMeters.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Edit '''blockMeshDict.template'''
| style="border:0.25pt solid #000000;padding:0cm;"| Any line preceded with '''$$ ''' is a '''Python ''' line, and will be interpreted and executed by '''Python'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict'''
* and a '''Python '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template Files'''

We also learnt to-

# Create and use '''template files'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-28T10:24:03Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''
*We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge15Ma5 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Add the following lines above convertToMeters.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Edit '''blockMeshDict.template'''
| style="border:0.25pt solid #000000;padding:0cm;"| Any line preceded with '''$$ ''' is a '''Python ''' line, and will be interpreted and executed by '''Python'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict'''
* and a '''Python '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-28T10:18:36Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''
*We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Add the following lines above convertToMeters.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Edit '''blockMeshDict.template'''
| style="border:0.25pt solid #000000;padding:0cm;"| Any line preceded with '''$$ ''' is a '''Python ''' line, and will be interpreted and executed by '''Python'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict'''
* and a '''Python '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:57:18Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Add the following lines above convertToMeters.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Edit '''blockMeshDict.template'''
| style="border:0.25pt solid #000000;padding:0cm;"| Any line preceded with '''$$ ''' is a '''Python ''' line, and will be interpreted and executed by '''Python'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict'''
* and a '''Python '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:31:24Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Add the following lines above convertToMeters. Any line preceded with '''$$ ''' is a '''Python ''' line, and will be interpreted and executed by '''Python'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:28:59Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:27:39Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:25:34Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:24:04Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using any editor

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:23:29Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict '''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict > blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using any editor

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-23T12:21:27Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge15Ma5'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 '''
Type the path of '''your OpenFOAM directory''' and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict >'''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict > blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using any editor

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-13T11:49:36Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge5M15'''

'''/home/fossee/OpenFOAM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge15Ma5 ~/fossee/OpenFOAM/ '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict >'''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict > blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using any editor

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-02-08T12:03:25Z

Viraj20feb:

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities

<nowiki>--------------------------</nowiki>

Open terminal

Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

<nowiki>-------------------------------------------------------------------------------------------</nowiki>

Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the following '''PyFoam Utilities''' to solve the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''the editor of your choice.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-02-08T11:59:38Z

Viraj20feb:

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the spoken tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and

'''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge5M15'''

'''/home/fossee/OpenFO AM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge15Ma5 case directory '''into '''OpenFOAM directory'''

by typing

''' mkdir -p ~/fossee/OpenFOAM/'''
'''cp -r Wedge15Ma5 ~/fossee/OpenFOAM/ '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict >'''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict > blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.templat e
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-PyFoam-Utilities/English

2017-01-16T12:46:45Z

Viraj20feb: Created page with "Tutorial : 22 Name : Using PyFoam Utilities Script : Anmol Sahoo and Rahul Joshi Narration : Rahul Joshi Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTub..."

Tutorial : 22

Name : Using PyFoam Utilities

Script : Anmol Sahoo and Rahul Joshi

Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, CFD, Linux, PyFoam utilities,shockTube

{| style="border-spacing:0;"
| style="border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| <center>'''Visual Cue'''</center>
| style="border:0.05pt solid #000000;padding:0.097cm;"| <center>'''Narration'''</center>

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Title
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Welcome to the spoken tutorial on Using '''PyFoam Utilities'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : Learning Objectives
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| In this tutorial we will learn :

* About '''PyFoam Utilities'''
* How to use '''PyFoam Utilites'''
* How to run and plot''' '''data for the '''shockTube''' case using '''PyFoam Utilites'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

System Requirement
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| To record this tutorial I am using:

* '''Ubuntu Linux '''14.04
* '''OpenFOAM v2.3.0'''
* '''PyFoam 0.6.5'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide :

Pre-requisite
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| As a prerequisite user should have :

* basic knowledge of running commands on the '''Linux terminal'''
* And some experience of running and analyzing '''OpenFOAM''' cases

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Introduction to PyFoam Utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me introduce you to '''PyFoam utilities.'''

* '''Utilities '''are''' Python programs '''which come inbuilt with '''PyFoam.''' 

* Each '''utility''' has a specific function. 

* '''Utilities''' are executed from the '''command line.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of Utilities

Open terminal

Type '''pyFoam''' and press '''Tab''' twice
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| List of '''utilites''' that can be viewed using '''tab completion'''

Open the terminal

The list of '''utilities''' can be viewed by

* typing '''pyFoam '''
* and then pressing '''Tab '''key twice

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : List of utilities
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let me switch back to the slides.

Each '''utility''' can be executed with the '''–help''' option

This helps us to find out what it does and what its options are

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide : using utilties

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We are going to use the below '''PyFoam Utilities''' to run the '''Shock Tube''' case.

We will use -

* '''PyFoamRunner.py'''
* '''PyFoamSamplePlot.py'''

And then plot the necessary data using '''PyFoam'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamRunner.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''PyFoamRunner.py''' can be used to run '''cases'''

It also generates '''log files '''for later use

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : PyFoamSamplePlot.py
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This '''utility''' is used to plot the various data obtained from the previously set up '''sampleDict.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Problem definition

Diagram
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| '''Shock Tube '''is an '''instrument''' -

* used to replicate and direct blast waves at a sensor
* to model actual explosion and their effects

In this case, the rectangular tube has low pressure on the right side and high pressure on the left side.

Both the pressures zones are seperated by a thin diaphgram.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''run/tutorials/compressible/rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''Terminal''' and type the path for '''rhoCentralFoam''' inside '''compressible solver.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type the command shown in Narration column
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type:

'''cd $FOAM_TUTORIALS/compressible/rhoCentralFoam/'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now type '''ls'''. You can see the '''shockTube''' case

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd shockTube'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''cd shockTube'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Point to the 3 files
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| You can see three folders '''0.org , constant '''and''' system.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| On Terminal type

'''cp -r 0.org 0'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We need to copy the '''0 '''file from''' 0.org'''

So type '''cp -r 0.org 0'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type''' cd system'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now, go to the '''system''' folder by typing

'''cd system'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''gedit sampleDict'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Open the '''sampleDict''' file using '''gedit.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| In '''sampleDict '''file, do as narrated

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go to the bottom of the file and '''Remove U.Component(0).'''

Replace it with '''Ux Uy '''and '''Uz.'''

Remove '''rho''' as well.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Save the file and exit
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Save and exit the file.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''cd ..'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go one level back by typing cd ..

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''blockMesh '''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Run the command '''blockMesh''' to '''mesh''' the '''geometry.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''setFields'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this type '''setFields''' to set the pressure boundary condition.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamRunner.py rhoCentralFoam'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will use the '''pyFoam utility of pyFoamRunner.py'''

Type '''pyFoamRunner.py <'''followed by name of the '''solver > i.e. RhoCentralFoam'''

This runs the '''case''' and creates a '''postProcessing log.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Switch to the '''terminal '''and type '''ls'''

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Go back to the terminal and type '''ls.'''

We can see the log files which are generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''sample'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now '''type sample''' to run the '''sample utility.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| After this we can plot for various '''time steps''' using-

'''pyFoamSamplePlot.py ./ --dir=postProcessing/sets –info'''

This will show which fields we have with us.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Then type '''pyFoamSamplePlot.py ./ --dir=postProcessing/sets --field=T --mode=timesInOne | gnuplot'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"|
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The output generated will be a '''png file.'''

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Type '''ls'''

Highlight/point to the '''png file'''
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Type '''ls'''.

We can see the '''png''' file which is generated.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show slide : Summary
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Utilities.'''

We also learnt to-

# Check for various '''pyFoam utilities'''
# '''pyFoamRunner.py''' to run the '''solver'''
# '''pyFoamSamplePlot''' utility to generate a '''png''' file

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Forum to answer questions
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on '''OpenFOAM''' in this forum.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Textbook Companion
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide

Acknowledgement

| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Thank You
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}

OpenFOAM/C3/Using-Template-files-in-PyFoam/English

2017-01-16T12:34:45Z

Viraj20feb: Created page with "Tutorial 21: C2 Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi Keywords : OpenFOAM, PyFoam, Python, Template, supersonic fl..."

Tutorial 21: C2

Title : Using Template files in PyFoam Script : Anmol Sahoo, Rahul Joshi Narration : Rahul Joshi

Keywords : OpenFOAM, PyFoam, Python, Template, supersonic flow, wedge

{| style="border-spacing:0;"
| style="border:0.25pt solid #000000;padding:0cm;"| '''Visual Cue'''
| style="border:0.25pt solid #000000;padding:0cm;"| <center>'''Narration'''</center>

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Title
| style="border:0.25pt solid #000000;padding:0cm;"| Hello and welcome to the Spoken Tutorial on '''Using Template files in PyFoam.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : Learning Objective
| style="border:0.25pt solid #000000;padding:0cm;"| In this tutorial we will:

* Understand the function of '''PyFoam Utilities'''
* Create and use template files
* Use '''PyFoamFromTemplate.py '''for solving the '''supersonic flow over wedge'''

We can run this for different '''wedge angles '''using '''template '''files.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide : System requirement
| style="border:0.25pt solid #000000;padding:0cm;"| To record this tutorial I am using

* '''Ubuntu Linux '''Operating System 14.04
* '''OpenFOAM''' 2.3.0
* '''PyFoam-0.6.5'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Prerequisite
| style="border:0.25pt solid #000000;padding:0cm;"| To practice this tutorial the user should have :

* Basic Knowledge of using '''Linux terminal'''
* Experience of running and analyzing '''OpenFOAM '''cases

If not, please refer to the spoken tutorial series on '''Linux '''and '''OpenFOAM'''.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template Files
| style="border:0.25pt solid #000000;padding:0cm;"| What are '''template '''files?

'''Template '''files are used to generate '''OpenFOAM '''files like

'''blockMeshDict or controlDict'''

'''Template '''files can be programmed, hence we can procedurally generate data.
|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Syntax of Template files
| style="border:0.25pt solid #000000;padding:0cm;"| A '''template '''file should be an '''OpenFOAM '''file, with the following -

* Any line beginning with '''$$ '''is a '''Python program '''line.
* It will be executed by '''Python'''
* Any variable can be substituted in the file by using the syntax

'''| -varname - |'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Using a template file
| style="border:0.25pt solid #000000;padding:0cm;"| The following steps should be followed to use a '''template '''file :

* First copy an existing file
* After this create a '''template '''file
* Then run '''PyFoamFromTemplate.py'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Creating a template file
| style="border:0.25pt solid #000000;padding:0cm;"| '''Template '''file will be created for '''blockMeshDict.'''

We will use the '''supersonic flow '''over a wedge as an example case. The case file is available in the '''rhoCentralFoam solver.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''run/tutorials/compres sible/rhoCentralFoam'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''terminal'''.

Type the '''path '''for the '''rhoCentralFoam '''inside '''compressible solvers.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type

'''cp -r Wedge5M15'''

'''/home/fossee/OpenFO AM/'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now copy the '''Wedge5M15 case directory '''into '''OpenFOAM directory'''

by typing

'''cp -r Wedge5M15 /home/fossee/OpenFOAM/ '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| '''Cd OpenFOAM/Wedge5 M15'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal, '''type the path for '''Wedge5M15 folder '''inside

'''OpenFOAM directory.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh/bl ockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type the '''path '''for '''blockMeshDict file '''inside '''polyMesh directory '''inside

'''constant.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| Open the '''blockMeshDict '''file in any editor of your choice.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the vertices section
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the '''vertices '''section.

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Show slide : vertices to

be changed
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| We need to calculate the '''co-ordinates '''of the end points of the '''slope'''.

Based on the '''angle, '''change the following lines

( 0.3048 0.081670913853 -0.005)

( 0.3048 0.081670913853 0.005)

|-
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''cp -r blockMeshDict >'''

'''blockMeshDict.templ'''

'''ate'''
| style="border-top:0.25pt solid #000000;border-bottom:none;border-left:0.25pt solid #000000;border-right:0.25pt solid #000000;padding:0cm;"| Switch back to the terminal

Copy your '''blockMeshDict '''file into a file called

'''blockMeshDict.template, '''type the following-

'''cp -r blockMeshDict > blockMeshDict.template'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| gedit blockMeshDict.template
| style="border:0.25pt solid #000000;padding:0cm;"| Open the blockMeshDict.template file using gedit

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| '''Add the following lines above convertToMeters'''

'''$$import math'''

'''$$thetaDegrees <nowiki>=</nowiki> 10.0'''

'''$$thetaRadians <nowiki>=</nowiki> math . radians ( thetaDegrees )'''

'''$$y_coord <nowiki>=</nowiki> 0.3048* math . tan ( thetaRadians )'''

Any line preceded with '''$$ '''is a '''Python '''line, and will be interpreted and executed by '''Python'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Template file syntax
| style="border:0.25pt solid #000000;padding:0cm;"| Modify the '''vertices '''entry as

'''( 0.3048 |-y_coord-| -0.005)'''

'''( 0.3048 |-y_coord-| 0.005)'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''Python variables '''assigned in the '''template '''file, should be substituted at any location in the file.

To do so, use '''| −varname− | '''in the file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Highlight or point to the changes
| style="border:0.25pt solid #000000;padding:0cm;"| We can see the changes made into this file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| Now, let's create a blank file

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''gedit templateFileConst'''
| style="border:0.25pt solid #000000;padding:0cm;"| On the '''terminal''', type '''gedit templateFileConst '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| templateFileConst
| style="border:0.25pt solid #000000;padding:0cm;"| Create a dummy entry inside it by typing

'''dummy 1.0;'''

A dummy entry is mandatory.

An external '''dict '''has to be provided with any '''constant '''that is to be used in the '''template '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Press Ctrl+S and close
| style="border:0.25pt solid #000000;padding:0cm;"| Save and close the both the files

|-
| style="border:0.25pt solid #000000;padding:0cm;"| cd ../../
| style="border:0.25pt solid #000000;padding:0cm;"| Now go 2 levels back to your '''case '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Switch back to slides
| style="border:0.25pt solid #000000;padding:0cm;"| Let me switch back to slides

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Running PyFoam command
| style="border:0.25pt solid #000000;padding:0cm;"| We have to run the template command now.

'''pyFoamFromTemplate.py --template-file<nowiki>=</nowiki>./blockMeshDict.template'''

'''--output=./blockMeshDict --values-dictionary=templateFileConst'''

'''--allow-exec-instead-of-assignment'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''>> press '''Enter'''
| style="border:0.25pt solid #000000;padding:0cm;"| Type this command in '''terminal '''and press '''Enter'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Type '''cd constant/polyMesh'''
| style="border:0.25pt solid #000000;padding:0cm;"| Now again go inisde the '''polyMesh folder '''inside '''constant'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to '''blockMeshDict '''and a python file
| style="border:0.25pt solid #000000;padding:0cm;"| We can see that

* 2 new files are generated
* the '''blockMeshDict.template '''file is replaced by '''blockMeshDict'''
* and '''.py '''file is also generated.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to the '''Python'''

file.
| style="border:0.25pt solid #000000;padding:0cm;"| Do not edit the '''Python '''file.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| On the terminal type

'''gedit blockMeshDict'''
| style="border:0.25pt solid #000000;padding:0cm;"| In the '''terminal''', open the '''blockMeshDict '''file by typing -

|-
| style="border:0.25pt solid #000000;padding:0cm;"|
| style="border:0.25pt solid #000000;padding:0cm;"| '''gedit blockMeshDict '''and press '''Enter.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to wedge angle
| style="border:0.25pt solid #000000;padding:0cm;"| We had changed the '''wedge angle '''from '''15 deg '''to '''10 deg.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Point to end points
| style="border:0.25pt solid #000000;padding:0cm;"| The end points of the '''slope '''have also changed.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide :Running the case file
| style="border:0.25pt solid #000000;padding:0cm;"| We can now run the '''case '''file by executing the '''OpenFOAM commands'''

* '''blockMesh'''
* '''rhoCentralFoam'''
* visualize the results using '''Paraview.'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Assignment
| style="border:0.25pt solid #000000;padding:0cm;"| As an assignment, use the following '''wedge angles '''and run the '''template'''

commands.

- '''0deg, 5 deg, 20 deg, 25 deg'''

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show slide : Summary
| style="border:0.25pt solid #000000;padding:0cm;"| Let us summarize.

In this tutorial, we learnt about '''PyFoam Template'''

We also learnt to-

# check the installation of '''script for using template'''
# and using the '''PyFoamFromTemplate.py '''command

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your timed queries in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide

Forum to answer questions
| style="border:0.25pt solid #000000;padding:0cm;"| Please post your general queries on '''OpenFOAM '''in this forum.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Textbook Companion
| style="border:0.25pt solid #000000;padding:0cm;"| The '''FOSSEE '''team coordinates the TBC project.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Show Slide Acknowledgement
| style="border:0.25pt solid #000000;padding:0cm;"| The Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India

For more details , visit this website.

|-
| style="border:0.25pt solid #000000;padding:0cm;"| Thank You
| style="border:0.25pt solid #000000;padding:0cm;"| This is Rahul Joshi from IIT Bombay signing off. Thanks for watching

|}