commit 6ecbd3f9cc5392fb214462463ed345d6b5d499fb
parent a26bd528a6603b1235ff544c63a3fd4cc3aab67b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 22 Feb 2024 16:50:48 +0100
Wraps the README text in 72 columns
This matches the convention of plain text e-mails. It can therefore be
sent as a publication announcement e-mail without being reformatted.
Diffstat:
| M | README.md | | | 103 | +++++++++++++++++++++++++++++++++++++++++++------------------------------------ |
1 file changed, 56 insertions(+), 47 deletions(-)
diff --git a/README.md b/README.md
@@ -4,9 +4,10 @@
Stardis is a software dedicated to the resolution of coupled
convective-conductive-radiative thermal problems in 3D environments.
-It is based on [stardis-solver](https://gitlab.com/meso-star/stardis-solver)
-and exposes some of the main features of the solver in an easy to use way.
-Using stardis is a practical way of carrying out thermal studies on CAD
+It is based on
+[Stardis Solver](https://gitlab.com/meso-star/stardis-solver) and
+exposes some of the main features of the solver in an easy to use way.
+Using Stardis is a practical way of carrying out thermal studies on CAD
models which can be exported from Salomé or other similar software.
## Requirements
@@ -36,50 +37,55 @@ Edit config.mk as needed, then run:
#### Programmable properties
-Until now, physical properties as well as boundary and connection conditions
-were constant in time and space. In this version, they can be programmed, i.e.
-they are variables returned by functions implemented in user-defined libraries
-and submitted as dynamically loaded input libraries when Stardis starts. User
-libraries must also provide create/release functions that are invoked at
-start-up to allow users to load their data and build the internal data
-structures required by their libraries at run-time.
+Until now, physical properties as well as boundary and connection
+conditions were constant in time and space. In this version, they can be
+programmed, i.e. they are variables returned by functions implemented
+in user-defined libraries and submitted as dynamically loaded input
+libraries when Stardis starts. User libraries must also provide
+create/release functions that are invoked at start-up to allow users to
+load their data and build the internal data structures required by their
+libraries at run-time.
The `stardis-input` file format has been updated to provide a set of new
`_PROG` suffixed keywords used to define these programmed properties and
-conditions (e.g. `T_BOUNDARY_FOR_SOLID_PROG` or `H_BOUNDARY_FOR_FLUID_PROG`)
+conditions (e.g. `T_BOUNDARY_FOR_SOLID_PROG` or
+`H_BOUNDARY_FOR_FLUID_PROG`)
#### Miscellaneous
-- Addition of the keyword `HF_BOUNDARY_FOR_SOLID` which allows to impose a flux
- on a boundary with another condition. For example, a net flux can be defined
- in addition to a convective exchange and a radiative transfer.
-- Correct the definition of a net flux as a boundary condition: it might not be
- defined on the right side of the interface.
-- Correct the "subpath type" data of the output paths: as we attach the segment
- type to the vertices, we need to locate the type changes along the path on
- zero length segments, otherwise the colouring will show a misleading colour
- gradient.
-- Replace the Mersenne Twister random number generator with Threefry: the
- former is much less efficient at rejecting random numbers than the latter,
- which is designed for this purpose, a feature on which parallel random number
- generations depend heavily
+- Addition of the keyword `HF_BOUNDARY_FOR_SOLID` which allows to impose
+ a flux on a boundary with another condition. For example, a net flux
+ can be defined in addition to a convective exchange and a radiative
+ transfer.
+- Correct the definition of a net flux as a boundary condition: it might
+ not be defined on the right side of the interface.
+- Correct the "subpath type" data of the output paths: as we attach the
+ segment type to the vertices, we need to locate the type changes along
+ the path on zero length segments, otherwise the colouring will show a
+ misleading colour gradient.
+- Replace the Mersenne Twister random number generator with Threefry:
+ the former is much less efficient at rejecting random numbers than the
+ latter, which is designed for this purpose, a feature on which
+ parallel random number generations depend heavily
### Version 0.8
-- Add a new option to support non-linear radiative transfer computations.
-- Changes in input file's format to support non-linear radiative transfer by
- adding reference temperatures on interfaces.
-- Add optional support for MPI (must be enabled at compile time, default is OFF).
+- Add a new option to support non-linear radiative transfer
+ computations.
+- Changes in input file's format to support non-linear radiative
+ transfer by adding reference temperatures on interfaces.
+- Add optional support for MPI (must be enabled at compile time, default
+ is OFF).
- Change random number generator type to use Threefry.
-- Change the format of binary Green files. A new public header file is now
- installed that describes all types involved in binary Green files.
+- Change the format of binary Green files. A new public header file is
+ now installed that describes all types involved in binary Green files.
- Fix a crash on an exit-on-error execution path.
- Fix parsing of command-line options.
### Version 0.7.2
-Fix the binary file format of the green function: the fileformat has been
-updated without incrementing the version of the serialised data.
+Fix the binary file format of the green function: the fileformat has
+been updated without incrementing the version of the serialised data.
### Version 0.7.1
@@ -87,10 +93,10 @@ Fix debug build.
### Version 0.7
-- Remove the boundary condition `T_BOUNDARY_FOR_FLUID`: it was exactly the same
- than `H_BOUNDARY_FOR_FLUID` that should now be used instead.
-- Sets the required version of Star-SampPling to 0.12. This version fixes
- compilation errors with gcc 11 but introduces API breaks.
+- Remove the boundary condition `T_BOUNDARY_FOR_FLUID`: it was exactly
+ the same than `H_BOUNDARY_FOR_FLUID` that should now be used instead.
+- Sets the required version of Star-SampPling to 0.12. This version
+ fixes compilation errors with gcc 11 but introduces API breaks.
### Version 0.6
@@ -125,14 +131,15 @@ Fix debug build.
### Version 0.3.2
- Add the `solve_probe_boundary` feature. The `solve_probe_boundary` VS
- `solve_probe` selection is automated according the probe-geometry distance.
- `solve_probe_boundary` is called for probe points closer than 2.1 delta
- from geometry.
+ `solve_probe` selection is automated according the probe-geometry
+ distance. `solve_probe_boundary` is called for probe points closer
+ than 2.1 delta from geometry.
- Add flux boundary conditions.
### Version 0.3.1
-Add radiative transfer computations. To achieve this, media gain 2 new parameters:
+Add radiative transfer computations. To achieve this, media gain 2 new
+parameters:
- emissivity;
- `specular_fraction`.
@@ -141,10 +148,11 @@ Add radiative transfer computations. To achieve this, media gain 2 new parameter
- Upgrade stardis-solver to v0.3.
- Add volumic power sources on solids;
-- Allow to use the `fp_to_meter` parameter of the stardis-solver solve function;
+- Allow to use the `fp_to_meter` parameter of the stardis-solver solve
+ function;
- Add a dump geometry feature. It outputs the geometry as it is sent to
- stardis-solver in VTK format, together with the front and back media and
- boundary conditions information.
+ stardis-solver in VTK format, together with the front and back media
+ and boundary conditions information.
### Version 0.1
@@ -154,8 +162,9 @@ Add radiative transfer computations. To achieve this, media gain 2 new parameter
## License
-Copyright (C) 2018-2023 |Méso|Star> (<contact@meso-star.com>). Stardis is free
-software released under the GPL v3+ license: GNU GPL version 3 or later. You
-are welcome to redistribute it under certain conditions; refer to the COPYING
-file for details.
+Copyright (C) 2018-2023 |Méso|Star> (<contact@meso-star.com>)
+
+Stardis is free software released under the GPL v3+ license: GNU GPL
+version 3 or later. You are welcome to redistribute it under certain
+conditions; refer to the COPYING file for details.
