1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
|
===========================
Generalities about CFDSTUDY
===========================
----------------
Introduction
----------------
The **CFDSTUDY** is a component for the SALOME platform. The purpose of this
software is to provide an interface between CFD (Computational Fluid Dynamics)
softwares *Code_Saturne* and NEPTUNE_CFD with other modules of the platform.
*Code_Saturne* and NEPTUNE_CFD are CFD softwares from EDF R&D. *Code_Saturne*
could be freely downloaded from ``http://code-saturne.org``.
This document provides a tutorial for the use of CFDSTUDY with *Code_Saturne*.
For a *Code_Saturne* tutorial itself and more information about user issues,
please consult the software documentation.
Note: CFDSTUDY is a pure Python module of SALOME. Only the GUI part of the module
is implemented without its engine counterpart. Therefore, the dump functionality is
not available yet.
------------------------------
Reference functionalities
------------------------------
The main purpose of **CFDSTUDY** is to embed the GUI of *Code_Saturne* inside the
SALOME desktop and to make easier the setup of a case. For that, when the module is
loaded, several hooks are available:
- Menubar
- **File > CFD code** menu:
- Save CFD Data file
- Save as CFD Data file
- **CFDSTUDY** menu:
- Set CFD study Location: allow to chose an existing study, or to create a new one.
.. image:: images/CFDSTUDY_location.png
:align: center
:width: 10cm
- Update Object Browser: refresh the directories list in the Object Browser.
- CFDSTUDY information: display information about the code.
.. image:: images/CFDSTUDY_info.png
:align: center
- Tools: display the file of parameter, open an xterm.
- **Help** menu:
- **CFDSTUDY module User's guide** menu: display this document in html format.
- **CFD module** menu: direct access to Code_Saturne (and NEPTUNE_CFD):
- theoretical guide,
- tutorial guide,
- user guide,
- doxygen documentation.
- Toolbar (from the left to the right):
.. image:: images/CFDSTUDY_toolbar.png
:align: center
- Set CFD study Location
- Add a new case in a study
- Launch the GUI
- Run a case
- Save CFD Data file
- Save as CFD Data file
- Close a GUI
- Undo
- Redo
- GUI: additional functionalities are available:
- Groups of boundary faces can be selected in the Object Browser or graphically,
- Groups of cells can be selected in the Object Browser or graphically,
- Monitoring points can be displayed in the VTK viewver.
- Object Browser: several actions are available through a specific contextual menu (open by *Right click*)
- Study directory:
.. image:: images/CFDSTUDY_context_menu_study.png
:align: center
- Mesh file:
.. image:: images/CFDSTUDY_context_menu_mesh.png
:align: center
- Case directory:
.. image:: images/CFDSTUDY_context_menu_case.png
:align: center
- *SaturneGUI* file:
.. image:: images/CFDSTUDY_context_menu_new_gui.png
:align: center
- File of parameters:
.. image:: images/CFDSTUDY_context_menu_xml.png
:align: center
- File of functions in the *SRC* directory:
.. image:: images/CFDSTUDY_context_menu_src.png
:align: center
- File of functions in the *REFERENCE* directory:
.. image:: images/CFDSTUDY_context_menu_ref.png
:align: center
- File of functions in the *DRAFT* directory:
.. image:: images/CFDSTUDY_context_menu_draft.png
:align: center
- Script of *runcase* file:
.. image:: images/CFDSTUDY_context_menu_runcase.png
:align: center
- Results directories in the *RESU* directory:
.. image:: images/CFDSTUDY_context_menu_resu.png
:align: center
|