2D Julia Operators

[bewagner1]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Example
• Documentation

Description

Implementation of the 2-D operators div, grad, curl, and lap in julia as well as their periodic, mixed periodicity, and non uniform variants.

Related Issues & Documents

• I have created an Issue that is paired with this PR
• Closes 2D operators for MOLE.jl #309

QA Instructions, Screenshots, Recordings

Compare relevant code and examples to MATLAB implementaiton

Added/updated tests?

• Yes
• No, and this is why: please replace this line with details on why tests
  have not been included
• I need help with writing tests

Nullity tests for all operators

Read Contributing Guide and Code of Conduct

• 📖 I have read the MOLE Contributing Guide: https://github.com/csrc-sdsu/mole/blob/main/CONTRIBUTING.md
• 📖 I have read the MOLE Code of Conduct: https://github.com/csrc-sdsu/mole/blob/main/CODE_OF_CONDUCT.md

[optional] Are there any post deployment tasks we need to perform?

None that I can think of

[optional] What gif best describes this PR or how it makes you feel?

[jbrzensk]

@bewagner1 The curl operator seems wrong, and will be a point of contention for many. I suggest removing it (also it doesn't have a test) to speed up the approval.

[bewagner1]

Yea I was wondering how it is mimetic operator. Doesn't seem to fit in with the rest

[valeriabarra]

Hi @bewagner1 , thank you so much for your contribution!

Now that we have a few more examples, I would like them to be organized in a directory structure that reflects the same organization and categories we have chosen for our documentation. See the examples/ directory in our docs. Please update the structure of the mole/julia/MOLE.jl/examples/ directory accordingly.
Please, also use the same directory structure in the mole/julia/MOLE.jl/docs/src/ directory (where we currently do not have an examples/ subdirectory - you would need to create one)

[bewagner1]

I think that the docs in theory are good but for a reason I cannot figure out, whenever I click through the links for the examples, I encounter pages that are not .html files, so you have to click on index.html to actually render the page. Any advice would be appreciated

[valeriabarra]

Hi @bewagner1 , Thank you again for this terrific PR! In addition to my comment above, it would be nice if you could add a small blurb description at the top of every example file you added, such as we have now (see elliptic1D.jl). I know you have fully documented those examples, too, but some people, you know, don't actually read the docs, so it is helpful to have a minimal description of the problem being solved and setup (domain size and BCs - if applicable) at the top of the file.

Thank you!

[valeriabarra]

Hey @bewagner1 congratulations!

Please reduce the number of commits by running git rebase -i and following the instructions to either fix up or squash. Try to reduce to a minimum number of commits that you think represent your work and won't overwhelm the main branch when your PR is merged. After you use git rebase you need to force-push.

[bewagner1]

that may have been the opposite of what was asked

[valeriabarra]

that may have been the opposite of what was asked

Woops! Let me know if you need assistance with this.

[bewagner1]

that may have been the opposite of what was asked

Woops! Let me know if you need assistance with this.

Got it figured out @valeriabarra thank you

[valeriabarra]

that may have been the opposite of what was asked

Woops! Let me know if you need assistance with this.

Got it figured out @valeriabarra thank you

Awesome! Okay, out of these 14, would you please reduce to just a few? Thanks!