commit 67e13d974d0589644c50833ee9b13ae77b6654ed
parent 0b6d856d56171eb8952d1e99bb6c286e863a40ae
Author: Benjamin Piaud <benjamin.piaud@meso-star.com>
Date: Mon, 7 Dec 2020 09:58:45 +0100
retour en 80 colonnes ;)
Diffstat:
| M | readme.md | | | 109 | ++++++++++++++++++++++++++++++++++++++++++------------------------------------- |
1 file changed, 58 insertions(+), 51 deletions(-)
diff --git a/readme.md b/readme.md
@@ -1,7 +1,7 @@
# Stardis: Starter Pack
-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 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.
@@ -24,13 +24,15 @@ Each example and its launching script is explained hereafter.
# The cube
-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.
+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 unstationary analytical solution.
+The interest of this example is to be able to compare with an unstationary
+analytical solution.
-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 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
@@ -54,92 +56,97 @@ file. In this file we *connect*:
- physical properties (thermal conductivity, thermal capacity, ...) to the
geometrical data (here solid.stl only);
-- 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).
+- 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 the stardis-input man page to read this file and modify it as you
-wish.
+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 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)
+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 the script using the following command:
$ bash ./run_probe_computation.sh
-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:
+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
-Please refer to the stardis man page for an explanation about command-line options.
+Please refer to the stardis man page for an explanation about command-line
+options.
-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.
+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"
The script **run_dump_paths.sh** invokes stardis twice:
-- 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.
+- 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", 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.
+- 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 to produce a Green function
-evalutation with stardis and how to 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 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.
+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 (values of boundary and initial
-conditions, as well as the volumic source term).
+This Green function is independent of the value of the sources (values of
+boundary and initial conditions, as well as the volumic source term).
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:
+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 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).
+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**
-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.
+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
