Fixed runtime estimation printed in console for simulations with multiple lbm.run(...) calls

Author: ProjectPhysX

DOCUMENTATION.md

@@ -302,15 +302,15 @@
   ```c
   lbm.graphics.visualization_modes = VIS_FLAG_LATTICE|VIS_Q_CRITERION; // set visualization modes, see all available visualization mode macros (VIZ_...) in defines.hpp
   const uint lbm_T = 10000u; // number of LBM time steps to simulate
-  lbm.run(0u); // initialize simulation
+  lbm.run(0u, lbm_T); // initialize simulation
   while(lbm.get_t()<lbm_T) { // main simulation loop
   	if(lbm.graphics.next_frame(lbm_T, 25.0f)) { // render enough frames for 25 seconds of 60fps video
   		lbm.graphics.set_camera_free(float3(2.5f*(float)Nx, 0.0f*(float)Ny, 0.0f*(float)Nz), 0.0f, 0.0f, 50.0f); // set camera to position 1
   		lbm.graphics.write_frame(get_exe_path()+"export/camera_1/"); // export image from camera position 1
   		lbm.graphics.set_camera_centered(-40.0f, 20.0f, 78.0f, 1.25f); // set camera to position 2
   		lbm.graphics.write_frame(get_exe_path()+"export/camera_2/"); // export image from camera position 2
   	}
-  	lbm.run(1u); // run 1 LBM time step
+  	lbm.run(1u, lbm_T); // run 1 LBM time step
   }
   ```
 - To find suitable camera placement, run the simulation at low resolution in [`INTERACTIVE_GRAPHICS`](src/defines.hpp) mode, rotate/move the camera to the desired position, click the <kbd>Mouse</kbd> to disable mouse rotation, and press <kbd>G</kbd> to print the current camera settings as a copy-paste command in the console. <kbd>Alt</kbd>+<kbd>Tab</kbd> to the console and copy the camera placement command by selecting it with the mouse and right-clicking, then paste it into the [`main_setup()`](src/setup.cpp) function.
@@ -431,10 +431,11 @@ By now you're already familiar with the [additional boundary types](#initial-and
   ```
 - Then, in [initialization](#initial-and-boundary-conditions), make a loop over all particles (outside of the initialization loop that iterates over all grid cells):
   ```c
+  uint seed = 42u;
   for(ulong n=0ull; n<lbm.particles->length(); n++) {
-  	lbm.particles->x[n] = random_symmetric(0.5f*lbm.size().x); // this will palce the particles randomly anywhere in the simulation box
-  	lbm.particles->y[n] = random_symmetric(0.5f*lbm.size().y);
-  	lbm.particles->z[n] = random_symmetric(0.5f*lbm.size().z);
+  	lbm.particles->x[n] = random_symmetric(seed, 0.5f*lbm.size().x); // this will palce the particles randomly anywhere in the simulation box
+  	lbm.particles->y[n] = random_symmetric(seed, 0.5f*lbm.size().y);
+  	lbm.particles->z[n] = random_symmetric(seed, 0.5f*lbm.size().z);
   }
   ```
 - Note that the position (`0`|`0`|`0`) for particles corresponds to the simulation box center.

src/info.cpp

@@ -21,11 +21,15 @@ void Info::initialize(LBM* lbm) {
 	gpu_mem_required = lbm->lbm_domain[0]->get_device().info.memory_used;
 	print_info("Allocating memory. This may take a few seconds.");
 }
-void Info::append(const ulong steps, const ulong t) {
-	this->steps = steps; // has to be executed before info.print_initialize()
-	this->steps_last = t; // reset last step count if multiple run() commands are executed consecutively
-	this->runtime_lbm_last = runtime_lbm; // reset last runtime if multiple run() commands are executed consecutively
-	this->runtime_total = clock.stop();
+void Info::append(const ulong steps, const ulong total_steps, const ulong t) {
+	if(total_steps==max_ulong) { // total_steps is not provided/used
+		this->steps = steps; // has to be executed before info.print_initialize()
+		this->steps_last = t; // reset last step count if multiple run() commands are executed consecutively
+		this->runtime_lbm_last = runtime_lbm; // reset last runtime if multiple run() commands are executed consecutively
+		this->runtime_total = clock.stop();
+	} else { // total_steps has been specified
+		this->steps = total_steps; // has to be executed before info.print_initialize()
+	}
 }
 void Info::update(const double dt) {
 	this->runtime_lbm_timestep_last = dt; // exact dt
@@ -55,7 +59,7 @@ void Info::print_logo() const {
 	print("|                                  ");                 print("\\  \\ /  /", c);                print("                                  |\n");
 	print("|                                   ");                 print("\\  '  /", c);                 print("                                   |\n");
 	print("|                                    ");                 print("\\   /", c);                 print("                                    |\n");
-	print("|                                     ");                 print("\\ /", c);                 print("               FluidX3D Version 2.17 |\n");
+	print("|                                     ");                 print("\\ /", c);                 print("               FluidX3D Version 2.18 |\n");
 	print("|                                      ");                 print( "'", c);                 print("     Copyright (c) Dr. Moritz Lehmann |\n");
 	print("|-----------------------------------------------------------------------------|\n");
 }

src/info.hpp

@@ -14,7 +14,7 @@ struct Info { // contains redundant information for console printing
 	uint cpu_mem_required=0u, gpu_mem_required=0u; // all in MB
 	string collision = "";
 	void initialize(LBM* lbm);
-	void append(const ulong steps, const ulong t);
+	void append(const ulong steps, const ulong total_steps, const ulong t);
 	void update(const double dt);
 	double time() const; // returns either elapsed time or remaining time
 	void print_logo() const;

src/lbm.cpp

@@ -868,8 +868,8 @@ void LBM::do_time_step() { // call kernel_stream_collide to perform one LBM time
 	for(uint d=0u; d<get_D(); d++) lbm_domain[d]->increment_time_step();
 }
 
-void LBM::run(const ulong steps) { // initializes the LBM simulation (copies data to device and runs initialize kernel), then runs LBM
-	info.append(steps, get_t());
+void LBM::run(const ulong steps, const ulong total_steps) { // initializes the LBM simulation (copies data to device and runs initialize kernel), then runs LBM
+	info.append(steps, total_steps, get_t()); // total_steps parameter is just for runtime estimation
 	if(!initialized) {
 		initialize();
 		info.print_initialize(); // only print setup info if the setup is new (run() was not called before)

src/lbm.hpp

@@ -413,7 +413,7 @@ class LBM {
 	LBM(const uint3 N, const float nu, const float fx, const float fy, const float fz, const uint particles_N, const float particles_rho=1.0f); // compiles OpenCL C code and allocates memory
 	~LBM();
 
-	void run(const ulong steps=max_ulong); // initializes the LBM simulation (copies data to device and runs initialize kernel), then runs LBM
+	void run(const ulong steps=max_ulong, const ulong total_steps=max_ulong); // initializes the LBM simulation (copies data to device and runs initialize kernel), then runs LBM
 	void update_fields(); // update fields (rho, u, T) manually
 	void reset(); // reset simulation (takes effect in following run() call)
 #ifdef FORCE_FIELD

src/main.cpp

@@ -77,7 +77,7 @@ void main_label(const double frametime) {
 			draw_label(ox, oy+i, "Steps "          +alignr(31u, /************************************/ alignr(10u, info.lbm->get_t())+" ("+alignr(5, to_uint(1.0/info.runtime_lbm_timestep_smooth))+" Steps/s)"), c); i+=FONT_HEIGHT;
 			draw_label(ox, oy+i, "FPS "            +alignr(33u, /************************************************************/ alignr(4u, to_uint(1.0/frametime))+" ("+alignr(5u, camera.fps_limit)+" fps max)"), c);
 		}
-		draw_label(2, camera.height-1*(FONT_HEIGHT)-1, "FluidX3D v2.17 Copyright (c) Dr. Moritz Lehmann", c);
+		draw_label(2, camera.height-1*(FONT_HEIGHT)-1, "FluidX3D v2.18 Copyright (c) Dr. Moritz Lehmann", c);
 		if(!key_H) {
 			draw_label(camera.width-16*(FONT_WIDTH)-1, 2, "Press H for Help", c);
 		} else {

src/resource.rc

@@ -24,7 +24,7 @@ BEGIN
 			VALUE "LegalCopyright", "(c) Dr. Moritz Lehmann"
 			VALUE "OriginalFilename", "FluidX3D.exe"
 			VALUE "ProductName", "FluidX3D"
-			VALUE "ProductVersion", "v2.17"
+			VALUE "ProductVersion", "v2.18"
 		END
 	END
 	BLOCK "VarFileInfo"