commit 0b6d856d56171eb8952d1e99bb6c286e863a40ae
parent dd7e94f9767d20a8550ad92ee11ae61d581c67f5
Author: Vincent EYMET <vincent.eymet@meso-star.com>
Date: Sun, 6 Dec 2020 19:47:57 +0100
Correction de la syntaxe
Diffstat:
| M | readme.md | | | 127 | +++++++++++++++++++++++++++++++++++++++---------------------------------------- |
1 file changed, 63 insertions(+), 64 deletions(-)
diff --git a/readme.md b/readme.md
@@ -1,18 +1,18 @@
# Stardis: Starter Pack
-The Stardis: Starter Pack is a collection of few examples of input data ready
-for computing with Stardis. It also provides GNU Bash scripts that make easier
-the invocation of the stardis program. That gives an overview of the required
+The Stardis: Starter Pack is a collection of input data sets ready
+for use with Stardis, over a few examples. It also provides GNU Bash scripts that make easier
+the invocation of the stardis program. It gives an overview of the required
input data and the features of stardis.
# Install and run
Download the Stardis: Starter-Pack archive and verify its integrity against
-its PGP signature. Then extract it. Assuming that stardis is installed and
-registered in the current shell. Then you can browse into the subdirectory and
-run stardis program. For instance you can launch the first script in cube
-directory:
+its PGP signature; then extract it. Assuming that stardis is installed and
+registered in the current shell, you can then browse into the subdirectory
+of your choice and run the stardis program. For instance you can launch the
+first script in the "cube" directory:
$ cd ~/Stardis-Starter-Pack-0.X.X/cube
~/Stardis-Starter-Pack-0.X.X/cube $ bash ./run_probe_computation.sh
@@ -20,127 +20,126 @@ $ cd ~/Stardis-Starter-Pack-0.X.X/cube
With ~/Stardis-Starter-Pack-0.6.0 the directory where the Starter Pack is
installed.
-Each example and their launching scripts are explained hereafter.
+Each example and its launching script is explained hereafter.
# The cube
-This example is simply a cube with a constant source term in whole volume. Only
-the conduction is considered in this example.
+This example is simply a cube of solid with a constant source term in the whole volume. Only
+thermal conduction is considered in this example.
-The interest of this example is to be able to compare with an analytical solution.
+The interest of this example is to be able to compare with an unstationary analytical solution.
-The 3 scripts illustrate 3 of the features of Stardis: the *probe computation*,
+The 3 provided bash scripts illustrate 3 main features of Stardis: the *probe computation*,
the *visualization of thermal paths* and the *Green function evaluation*.
## the data
-The geometrical data are described in ASCII STL format. So the cube is given by
+The geometrical data are described in ASCII STL format. The cube is provided in
the **solid.stl** file. If you visualize the stl file with a software like
-paraview or meshlab, you can see the cube is described by a basic triangulation.
+paraview or meshlab, you can see the cube is described by a basic triangulation.
Stardis does not require a fine meshing. The computation is not based on any
-geometrical meshing. The STL file must only describe the contour of a solid.
+geometrical meshing. The STL file must only describe the boundary of a solid.
You can see three other STL files: **left_bc.stl**, **right_bc.stl** and
-**center_bc.stl**. This files are required to attach the boundary conditions to
+**center_bc.stl**. These files are required to attach boundary conditions to
the geometry. We note an important constraint in the CAD process: the triangles
in these boundary STL files which coincide with the triangles in the solid STL
files must be *rigorously* the same. This *conformal mesh* constraint is also
required for adjacent solids that share a common interface.
Finally you can watch the **model.txt** file which is the Stardis input data
-files. In this file we *connect*:
+file. In this file we *connect*:
-- the physical properties (thermal conductivity, thermal capacity, ...) to the
+- physical properties (thermal conductivity, thermal capacity, ...) to the
geometrical data (here solid.stl only);
-- the boundary condition description to the geometrical data. You can see here a
- fiexd temperature is apply to the boundaries represented by right_bc.stl and
- left_bc.stl and null flux condition to the boundaries represented by
- center_bc.stl.
+- boundary conditions to the geometrical data. You can see here a
+ fixed temperature (Dirichlet boundary condition) is applied to the boundaries
+ represented by right_bc.stl and left_bc.stl, and a null flux condition is applied
+ to the boundaries represented by center_bc.stl (adiabatic boundaries).
-You can refer to stardis-input man page to read this file and modify it as you
+You can refer to the stardis-input man page to read this file and modify it as you
wish.
## Probe computation
-The script **run_probe_computation.sh** invokes the stardis program to compute
-the temperature of the center of the cube for different times. The results will
-be written in a file and plotted with gnuplot (if you it is installed) to be
-compared to the analytical solution (analytical_T.txt)
+The script **run_probe_computation.sh** invokes the stardis program in order to compute
+the temperature at the center of the cube for different values of time. The results will
+be recorded in a file and plotted with gnuplot (provided it has been installed), in order
+to compare results obtained by stardis to the analytical solution (analytical_T.txt)
Assuming the current shell directory is ~/Stardis-Starter-Pack-0.X.X/cube, you
-can run script as below:
+can run the script using the following command:
$ bash ./run_probe_computation.sh
-You can also simply invoke stardis program to compute the temperature at
-the center of the cube in the steady steady by typing in the shell:
+You can also simply invoke the stardis program in order to compute the temperature at
+the center of the cube at steady state, by using the following command:
$ stardis -M model.txt -p 0.5,0.5,0.5,INF -e
-You can refer to the stardis man page.
+Please refer to the stardis man page for an explanation about command-line options.
-You can also open and modify the bash script. There is a section "USER
-PARAMETERS SECTION" in which you can modify the numbers of Monte-Carlo
-realisations or the time of the probe.
+The bash script can be edited and modified. In section "USER PARAMETERS", the number
+of Monte-Carlo samples or the value of the probe time can be modified.
-## Dump some "thermal paths"
+## Dump some "thermal paths"
The script **run_dump_paths.sh** invokes stardis twice:
-- first to dump the scene in **vtk** format. This feature is useful to check the
- integrity of the geometrical data. For instance if the stl files describe
- non-conformal triangle mesh, some errors will be indicated in the vtk file.
+- first to dump the scene in the **vtk** format. This feature is useful for checking the
+ integrity of the geometrical data. For instance if the stl files provide a
+ non-conformal triangle mesh, some errors will be mentioned in the vtk file.
-- to produce some "thermal paths" beginnning from the probe. Vizualise these
- paths is a useful tool to analyze the thermal phenomenon. This example is
- simple but it is very interesting to see the thermal paths in complex geometry
- with radiative, convective and conductive coupled heat transfers.
+- to produce some "thermal paths", starting from the probe position and time. Vizualising these
+ paths provides useful information about the boundary or initial conditions that are
+ involved for the computation of the probe temperature, as well as their relative
+ importance. This example is simple but yet allows the visualization of thermal paths
+ in a complex geometry where radiative, convective and conductive heat transfers are coupled.
You can change the numbers of paths or the probe position in the script.
## Green function evaluation
-The last script **run_green_evaluation.sh** shows how produce a Green function
-evalutation with stardis and how use it with the sgreen program.
+The last script **run_green_evaluation.sh** shows how to produce a Green function
+evalutation with stardis and how to use it with the sgreen program.
If you launch the script a first time, stardis will produce an evaluation of the
-Green function by generating the thermal and storing some data (the end position
-of paths) in a binary file. This Green function is evaluating only for a probe
-(defined in the "USER PARAMETER SECTION"). If you change **X**, **Y**, **Z** or
-the number of Monte-Carlo realizations **NREAL**, it will produce another Green
-function.
+Green function by generating the required number of thermal paths and store some data
+(the end position of each path) in a binary file. This Green function is evaluated
+only for a probe position (defined in the "USER PARAMETER SECTION"). whenever **X**, **Y**, **Z** or
+the number of Monte-Carlo samples **NREAL** are modified, a new Green function will
+be produced.
-This Green function is independent of the value of the sources (boundary
-conditions value and heat volumic dissipation)
+This Green function is independent of the value of the sources (values of boundary and initial
+conditions, as well as the volumic source term).
-Now, if you launch the script again. The sgreen program will process the Green
-function to compute the probe temperature.
-
-If you want to compute the probe temperature for another set of the sources, you
-can change in the script the value of the line:
+If you launch the script again, the sgreen program will process the Green
+function to compute the probe temperature, for the current values of sources (no matter
+whether they have been modified or not); in order to modify the values of the sources,
+the following line should be modified in the script:
```
SOURCES_AND_BOUNDARIES="CUBE.VP = 12 LTEMP.T = 290 RTEMP.T = 310 ADIA.F = 5.2"
```
-with **CUBE.VP** the value of the heat volumic dissipation (in W/m^3). **LTEMP.T** and
-**RTEMP.T** are the temperature value of the left (LTEMP) and right (RTEMP)
-boundaries. And **ADIA.F** is the value of the heat flux density imposed to the
+with **CUBE.VP** the value of the volumic source term (in W/m^3); **LTEMP.T** and
+**RTEMP.T** are the values of the temperature on the left (LTEMP) and right (RTEMP)
+boundaries respectively; and **ADIA.F** is the value of the heat flux density imposed to the
boundary ADIA (in W/m^2).
The names **CUBE**, **RTEMP**, **LTEMP** and **ADIA** refer to the names given
in the file **model.txt**
-We note also you can not define at this stage the value ADIA.T because in the
-file model.txt, the boundary ADIA is defined with imposed value for the flux
-density with the keyword **F_BOUNDARY_FOR_SOLID**. If you want fix the
-temperature at this boundary, you must write another model.txt file and with the
-keyword **T_BOUNDARY_FOR_SOLID** for this boundary.
+Please note that it is not currently possible to define the value of ADIA.T: in the
+model.txt file, boundary ADIA has been assigned a value of flux density using the
+**F_BOUNDARY_FOR_SOLID** keyword. If this boundary should be assigned a given temperature
+(Dirichlet condition), a different model.txt file should be generated using the
+**T_BOUNDARY_FOR_SOLID** keyword for this boundary.
# Download
