From 9f7565a791efa8f8fad89126be6ac6bdd9493ca2 Mon Sep 17 00:00:00 2001 From: NNatarajan0717 <80609370+NNatarajan0717@users.noreply.github.com> Date: Sat, 30 Sep 2023 22:52:02 -0400 Subject: [PATCH 1/2] Added code descriptions to readme file --- readme.mediawiki | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/readme.mediawiki b/readme.mediawiki index b2cbc74..bd033a4 100644 --- a/readme.mediawiki +++ b/readme.mediawiki @@ -2,11 +2,25 @@ Author: Brandon Pelfrey (''[brandonpelfrey@gmail.com]'') ==Description== -The Construct is a C++-based library for prototyping volume effects and simulations for computer graphics applications. It enables fast and spontaneous ways to try new mathematical ideas regarding continuum dynamics and supports reading and writing results to disk. +The Construct is a C++-based library for prototyping volume effects and simulations for computer graphics applications. It enables fast and efficient ways to try new mathematical ideas regarding dynamics and supports reading and writing results to disk. It is a power tool for prototyping the effects of volume and simulations for computer graphics applications. -==Longer Description== -I have made [http://www.brandonpelfrey.com/blog/?p=1 a short write-up] to complement the examples here on my own personal blog. +===Fluid Simulation=== +This section demonstrates a fluid simulation and system. It simulates the behavior of a fluid in a 3D domain. The key components include the density field, velocity field, time stepping, and force/projection. + - The density field is the concentration of fluid at each individual grid point. + - Velocity field is defined the flow direction and magnitude of the fluid at each individual point. + - Time stepping is a the simulation progressing in time steps. Based on these steps, the velocity and time fields are updated. + - Force and projection are an upward force that is applied to the fluid. + +Overall, this section will show the fluid's general behavior at each given time step. + +===Mathematical Operations and Field Deratives=== +This section demonstrates various mathematical operations and field derivatives using the Construct library. The library allows fast and intuintive ways to experiment with mathematical concepts related to dynamics. It essentially explores and manipulates fields, performs algebraic operations, and calculates the derivatives of those fields. + +This will show you how to use the Construct library for mathematical manipulation of fields in computer graphics simulations in order to understand how it perform the specified operations and display the results. + +=Getting Started= + +To begin using The Construct, here are more details and in-depth documentation in this blog: http://www.brandonpelfrey.com . ==License== This software is released under the GNU Public License. - From 473f02896e52f3478c2b2f3d6073aa799afb2868 Mon Sep 17 00:00:00 2001 From: NNatarajan0717 <80609370+NNatarajan0717@users.noreply.github.com> Date: Sat, 30 Sep 2023 22:55:19 -0400 Subject: [PATCH 2/2] Added some changes to wording for readme --- readme.mediawiki | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.mediawiki b/readme.mediawiki index bd033a4..988eb48 100644 --- a/readme.mediawiki +++ b/readme.mediawiki @@ -5,7 +5,7 @@ Author: Brandon Pelfrey (''[brandonpelfrey@gmail.com]'') The Construct is a C++-based library for prototyping volume effects and simulations for computer graphics applications. It enables fast and efficient ways to try new mathematical ideas regarding dynamics and supports reading and writing results to disk. It is a power tool for prototyping the effects of volume and simulations for computer graphics applications. ===Fluid Simulation=== -This section demonstrates a fluid simulation and system. It simulates the behavior of a fluid in a 3D domain. The key components include the density field, velocity field, time stepping, and force/projection. +This section demonstrates a fluid simulation and system. It simulates the behavior of a fluid in a 3D domain. The key components included are the density field, velocity field, time stepping, and force/projection. - The density field is the concentration of fluid at each individual grid point. - Velocity field is defined the flow direction and magnitude of the fluid at each individual point. - Time stepping is a the simulation progressing in time steps. Based on these steps, the velocity and time fields are updated. @@ -23,4 +23,4 @@ This will show you how to use the Construct library for mathematical manipulatio To begin using The Construct, here are more details and in-depth documentation in this blog: http://www.brandonpelfrey.com . ==License== -This software is released under the GNU Public License. +This software is released under the GNU Public License. \ No newline at end of file