Updating the Wiki-pages for FEM equations, solvers, BCs

[RatonLaveur]

I have started filling in the pages for FEM MaterialFluid and FEM ConstraintInitialFlowVelocity.
Since these are my first entries in a wiki ever, I'm reluctant to remove the tags on the pages. Is someone curating that or should I do it if I feel i've done a good job?

[johnwang]

In short... If you like to change the complete section ... go ahead , this is not my stuff

I am just learning, but find quite a few WiKi pages hard to follow. Some are outdated, some are out stepped.

[RatonLaveur]

Hello gents,

I have taken the liberty of filling in the following wiki pages that were until now empty. These are my first wiki entries, so I may have made mistakes specifically with the indexing flags.

If you have comments don't hesitate. If you want to butcher them, don't hesitate.

https://wiki.freecadweb.org/FEM_MaterialFluid
https://wiki.freecadweb.org/FEM_Constra ... owVelocity
https://wiki.freecadweb.org/FEM_ConstraintFlowVelocity
https://wiki.freecadweb.org/FEM_SolverElmer

I intend to move forward more or less with anything Elmer related.

@bernd i still can't really touch https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary because I don't really understand what it is currently doing. Despite you trying to explain to me earlier. I feel like it is currently obsolete but I cannot be sure. Please bring enlightenment upon me.

Cheers,

J.

[vocx]

I have taken the liberty of filling in the following wiki pages that were until now empty. These are my first wiki entries, so I may have made mistakes specifically with the indexing flags. ...

They are fine. Ugly documentation is better than no documentation. The pages can be improved over time.

One suggestion, we normally distinguish between KEYs and Buttons that you press. KEYs you press on the keyboard, and Buttons you press on the graphical interface, including the toolbars.

So I'd change this

Code: Select all

{{KEY|[[Image:FEM_MaterialFluid.png|32px]] FluidMaterial}}

to this

Code: Select all

{{Button|[[Image:FEM_MaterialFluid.svg|16px]] [[FEM MaterialFluid|Material fluid]]}}

Notice that the element is a button, because you are supposed to click on it. The image should be an SVG, not a PNG. If the corresponding image doesn't exist, then you should upload it. Also, the image should be 16 px in size, so that it fits inside the button.

And the text inside the button should be a link to the corresponding command, so that the reader can go to that documentation page as well. Of course, this doesn't apply to simple buttons like {{Button|OK}}.

[RatonLaveur]

Thanks that's very good feedback!

I'll make then purrty over time, i just wanted to get the ball rolling.

[RatonLaveur]

They are fine. Ugly documentation is better than no documentation. The pages can be improved over time.

One suggestion, we normally distinguish between KEYs and Buttons that you press. KEYs you press on the keyboard, and Buttons you press on the graphical interface, including the toolbars.

I updated the Wiki pages for the pages in question with your kind propositions. Ugly...maybe (gee thanks ) but I like to think they are useful.
I now need to continue my Elmer quest by going into the different cases and equations and creating the page for them.

...

bernd I'm sorry to ping you so willy nilly, but I still have a lot of trouble with https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary

I have yet to find a use case for this, and it is right in the middle of the other "more functional" (according to my limited understanding) functions. Thus I feel like it distracts quite a lot.

[Jee-Bee]

Don't know if @Bernd react soon see: https://forum.freecadweb.org/viewtopic. ... 10#p406891

[Kunda1]

A tip when editing wiki pages:

When referencing dropdown menu commands use

Code: Select all

{{MenuCommand|Edit → Preferences → FEM → Elmer}}

instead of

Code: Select all

'''Edit''' → '''Preferences''' → '''FEM''' → '''Elmer'''

[RatonLaveur]

Don't know if @Bernd react soon see: https://forum.freecadweb.org/viewtopic. ... 10#p406891

Fantastic! Super happy for him. Hope you enjoy your vacations bernd! And thanks for the heads up JeeBee.

A tip when editing wiki pages:

When referencing dropdown menu commands use

Code: Select all

{{MenuCommand|Edit → Preferences → FEM → Elmer}}

instead of

Code: Select all

'''Edit''' → '''Preferences''' → '''FEM''' → '''Elmer'''

Yessss! Here i go polish my little uglies...i had copied existing pages. So at least thanks to you Kunda, maybe my pages will have some of the Good Wikiing Practice displayed.

[bernd]

...

bernd I'm sorry to ping you so willy nilly, but I still have a lot of trouble with https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary

I have yet to find a use case for this, and it is right in the middle of the other "more functional" (according to my limited understanding) functions. Thus I feel like it distracts quite a lot.

https://github.com/FreeCAD/FreeCAD/comm ... undary.cpp implemented by Qing Feng xia. I do not know if it is implemented in any solver?