Matlab to C++ Example Contribution

[CaywoodR]

Hello everyone,

I was looking through Issue 141. #141

Instead of solely adding documentation, I would like to contribute to the examples in MOLE by translating from Matlab to C++.

Potential examples to implement in C++:

van_der_pol.m
https://github.com/csrc-sdsu/mole/blob/main/examples/matlab_octave/van_der_pol.m

helmholtz2D_wifi.m
https://github.com/csrc-sdsu/mole/blob/main/examples/matlab_octave/helmholtz2D_wifi.m

hyperbolic1D.m
https://github.com/csrc-sdsu/mole/blob/main/examples/matlab_octave/hyperbolic1D.m

parabolic2D.m
https://github.com/csrc-sdsu/mole/blob/main/examples/matlab_octave/parabolic2D.m

Any extra information would be greatly appreciated, and if I should move forward.

[jbrzensk]

They all seem like good examples. Check out this example to see how to make a plot window.

[Tony-Drummond]

Thank you @CaywoodR! Glad to see that you are interested in contributing to MOLE.
These examples would results in great contributions to the library. I recommend any of the three latter examples in your list (i.e., helmholtz2D_wifi.m, hyperbolic1D.m, and parabolic2D.m) because they showcase new functionality already implemented in the C++ library implementation.

One item for your consideration, in the future the Robin BC will be deprecated and instead we will use the addscalarbc functional implementations. Also, while in MATLAB/Octave the functions have the dimensionality in the name (e.g., div2D), the C++ counterparts are written using functional overloading and there is only one name per operator (e.g., divergence),

All best!

[CaywoodR]

Thank you for your comment @Tony-Drummond. Just the three latter examples and not the former?

Best!

[CaywoodR]

@jbrzensk Thank you for this! It was extremely helpful to have that example for the plot window.

[CaywoodR]

Hello! @jbrzensk and @valeriabarra. I ran helmholtz2D_wifi.m, but I get 1 of 2 results for the plot. I didn't change anything within the MATLAB code except changing i to 1*i within the coefficient, so I wanted to double-check what the intended result is.

[jbrzensk]

@CaywoodR I'm not able to get the second picture.
In MATLAB,

i == 1i

and it complains because it wants the imaginary 'i' separate from the index 'i'.

I changed it to all three and got the same plots. Maybe you need a "clear all" command on line 1?

[CaywoodR]

@jbrzensk adding "clear all" seems to have fixed it. I ran it a few times to try and replicate the plot with no propagation, and the issue appears to have been remedied.

Thank you for the quick feedback!

[CaywoodR]

Hey! @jbrzensk, For the documentation link in regard to Helmholtz2D_wifi - Can I add a link to the current Helmholtz2D md as a variant?
Also, there is no example folder for Parabolic2D documentation. How do I go about adding a folder for that specific md?

[valeriabarra]

Also, there is no example folder for Parabolic2D documentation. How do I go about adding a folder for that specific md?

Regarding creating the folder for 2D parabolic examples is pretty easy. From the parent folder from the command line, just do

mkdir 2D

and add the pertinent index.md and specific example doc files in there. Then, remember to update the relative index.md file with the correct path.

Let us know if you have any further questions!

[CaywoodR]

Awesome! Thank you @valeriabarra for the quick response.