Apply variable naming convention to Richards local operator (#113) · Issues · dorie / dorie

Apply variable naming convention to Richards local operator

Summary

The following discussions from !93 (merged) should be addressed:

@sospinar started a discussion: (+2 comments)

Before removing the WIP again, I will modify the name convention within the local operator. In !112 (merged) finally I got to a name convention that I think is more expressive:

Convention Meaning

<description> + _i <description> with respect to the inside entity.

<description> + _o <description> with respect to the outside entity.

<description> + _f <description> with respect to the face entity (or intersection).

<description> + _g <description> with respect to the global grid.

<description> + _n <description> in normal direction.

Notice that when working with gradients, the suffix for normal direction can be combined with the first three suffixes (_n_i, _n_o, and _n_f). When it's not specified, is understood that it is with respect to the face (_n \equiv_n_f).

Convention	Meaning
`<description>` + `_i`	`<description>` with respect to the inside entity.
`<description>` + `_o`	`<description>` with respect to the outside entity.
`<description>` + `_f`	`<description>` with respect to the face entity (or intersection).
`<description>` + `_g`	`<description>` with respect to the global grid.
`<description>` + `_n`	`<description>` in normal direction.

Proposal

Adjust the local operator of the Richards model to this naming convention.

How to test the implementation?

Everything works as before 😉

Related issues/MRs

!93 (merged)

### Summary
The following discussions from !93 should be addressed:

- [ ] @sospinar started a [discussion](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/merge_requests/93#note_16474):  (+2 comments)

> Before removing the WIP again, I will modify the name convention within the local operator. In !112 finally I got to a name convention that I think is more expressive:
    > 
    > | Convention | Meaning |
    > |---|---|
    > | `<description>` + `_i` | `<description>` with respect to the **inside** entity. |
    > | `<description>` + `_o` | `<description>` with respect to the **outside** entity. |
    > | `<description>` + `_f` | `<description>` with respect to the **face** entity (or intersection).  |
    > | `<description>` + `_g` | `<description>` with respect to the **global** grid. |
    > | `<description>` + `_n` | `<description>` in **normal** direction. |
    > 
    > Notice that when working with gradients, the suffix for normal direction can be combined with the first three suffixes (`_n_i`, `_n_o`, and `_n_f`). When it's not specified, is understood that it is with respect to the face (`_n` $`\equiv`$`_n_f`).

### Proposal
Adjust the local operator of the Richards model to this naming convention.

### How to test the implementation?
Everything works as before :wink:

### Related issues/MRs
!93

Discussion
Designs

The one place for your designs

To enable design management, you'll need to meet the requirements. If you need help, reach out to our support team for assistance.