1 ******************************
2 About SALOME SIERPINSKY sample
3 ******************************
5 SIERPINSKY is a simple example of SALOME module written in C++ and
6 implementing services via CORBA interface. It works in conjunction
7 with SALOME RANDOMIZER sample module; with latter it interfers by means
8 of CORBA services (see below).
10 RANDOMIZER and SIERPINSKY modules implement simple interface to calculate
13 For more information please visit the SALOME platform web site:
15 <http://www.salome-platform.org/>
21 SALOME platform is distributed under the GNU Lesser General Public License.
22 See COPYING file for more details.
24 Also, additional information can be found at SALOME platform web site:
26 <http://www.salome-platform.org/downloads/license/>
36 SALOME platform relies on a set of third-party softwares; some of them are needed
37 at build time only, while other ones are needed in runtime also.
39 For more information about the pre-requisites please visit SALOME platform web
42 * Check Release Notes and Software Requirements of the latest SALOME release at
44 <http://www.salome-platform.org/downloads/current-version/>
46 * Pre-requisites page at SALOME web site:
48 <http://www.salome-platform.org/downloads/license/>
50 Note: SALOME SIERPINSKY needs SALOME KERNEL, SALOME GUI, SALOME RANDOMIZER and,
51 optionally, SALOME Mesh modules as pre-requisites.
57 The build procedure of the SALOME platform is implemented with CMake.
58 In order to build the module you have to do the following actions:
60 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
62 2. Create a build directory:
64 % mkdir SIERPINSKY_BUILD
66 3. Configure the build procedure:
69 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
72 - <mode> is either Release or Debug (default: Release);
73 - <installation_directory> is a destination folder to install SALOME SIERPINSKY
74 module (default: /usr);
75 - <path_to_src_dir> is a path to the SALOME SIERPINSKY sources directory.
77 Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME SIERPINSKY
78 module will be configured for installation to the /usr directory that requires
79 root permissions to complete the installation.
86 This will install SALOME SIERPINSKY module to the <installation_directory>
87 specified to cmake command on the previous step.
93 SALOME SIERPINSKY module supports a set of advanced configuration options;
94 for more details learn CMakeLists.txt file in the root source directory.
96 You can also use other options of cmake command to customize your installation.
97 Learn more about available options by typing
107 SALOME RANDOMIZER module is implemented as pure Python module. It does not have
108 any GUI. The IDL interface includes two methods:
110 - void InitPoint( out double theX, out double theY );
112 to generate a random 2D point; X and Y coordinates are in [0,1) range;
114 - long NextIteration();
116 to calculate next random iteration step: the integer value in range {1,3}.
118 The functionality of this module is used by SIERPINSKY module to calculate
123 The engine interface includes the following methods:
125 - void Init( in double X1, in double Y1, in double X2, in double Y2, in double X3,
128 to initialize the engine with three points which will be used as reference points
133 to initializes the engine with three default reference points: (0.5, 1), (0, 0),
136 - void NextPoint( in double X, in double Y, in long iter, out double nextX,
139 calculates next iteration point, basing on the previous one and the iteration
140 step given from RANDOMIZER engine; this method is called subsequently in the loop
141 to generate the points cloud;
143 - boolean ExportToJPEG( in string fileName, in long size );
145 exports the collected points data to the JPEG file;
147 - boolean ExportToMED( in string fileName, in double size );
149 exports the collected points data to the MED file.
151 The Init() and Reset() methods clear the collected points data and prepare engine
152 to the new calculations. The JPEG file can be viewed with help of any image viewer
153 supporting JPEG format. The MED files created by ExportToMED() method can be then
154 imported in the SALOME ParaVis module for the visualization (see below).
162 ${KERNEL_ROOT_DIR}/bin/salome/runSalome --modules=SMESH,RANDOMIZER,SIERPINSKY
164 * Create new study: menu File - New
166 * Activate SIERPINSKY module: click the corresponding button on the 'Components' toolbar
167 or select it in the "Components" combo-box.
169 The only action of the SIERPINSKY module's GUI is available via 'Sierpinsky' main menu
170 - it is a 'Run' command (there is also corresponding button on the toolbar).
171 This command opens 'Run Sierpinsky Algo' dialog box which allows:
172 - Defining a start point for the calculations; if 'Random' checkbox is turned on, the
173 start point will be generated automatically via RANDOMIZER module functionality.
174 - Defining three reference points for the algo; if 'Random' checkbox is turned on, the
175 reference points will be generated automatically via RANDOMIZER module functionality;
176 if 'Default' checkbox is turned on the default values will be used.
177 - Entering the number of the points to be calculated.
178 - Creating JPEG image after the calculcations are finished; 'Image size' parameter defines
179 the size of the image side in pixels.
180 - Exporting results to the MED file after the calculcations are finished; 'Mesh size'
181 parameter defines the mesh range.
183 After pressing the 'Start' button the calculation begins. It is possible to stop the
184 calculation by pressing 'Stop' button. The progress bar in the lower part of the dialog
185 box displays the calculation status.
191 Please, send a mail to webmaster.salome@opencascade.com.