You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We should do a step-by-step tutorial on how to create a module. This exercise will also allow not so recent collaborators ( like me and Alejandro ) to learn more about COOLFluiD and find problem with the Framework API (like too verbose boilerplate code, quick-fixs, etc ). I propose the following guide:
"Hello world" module: A module that only prints hello world. It will teach how to define the modules, the CMake file, to register the module and the minimal set of methods to make the code compile. Finally add the method on the CFcase file and get the "Hello World" string.
Add config options to the module. Change the module so that the string to output can be set from the CFcase file. Add another option for an array of ints and a bool. If the bool is true, the module will also print the array.
Access some mesh data. Here the fun starts! We will provide a simple mesh with different TRS's. The module will print the cell volume, its faces, vertices, and neighboring cell of all TRS's. The module will be changed to allow for the TRS names to be specified from the CFcase file.
Data sockets: We will alter step 3. to use the pre-calculated values from the data sockets. we'll explain them and add the necessary methods.
Physical System: Here, we'll grab a compressible Couette flow testcase and teach how to read the temperatures, velocities and access the viscosity and density from the physical properties library. We can even export the information to a cvs file and plot it through MATLAB or so.
Numerics: I didn't work with those modules yet, so I don't know what is the best. Maybe use the Poisson solver to get some Magnetic values?
What do you think?
The text was updated successfully, but these errors were encountered:
I really think we should do this, 100%, but I would like to do it after having restructured some things in the framework. Some things now are not as clean and easy as I would like them to be. But, yes, should be done soon.
We should do a step-by-step tutorial on how to create a module. This exercise will also allow not so recent collaborators ( like me and Alejandro ) to learn more about COOLFluiD and find problem with the Framework API (like too verbose boilerplate code, quick-fixs, etc ). I propose the following guide:
What do you think?
The text was updated successfully, but these errors were encountered: