mistakes in the Manual

Clearly defined bug reports and their fixes
Post Reply
uwestoehr
Posts: 16
Joined: 05 Aug 2022, 14:42
Antispam: Yes

mistakes in the Manual

Post by uwestoehr »

Dear Elmer team, many thanks for your new manuals (the ones from August 2nd)! (I like the new structure of the models manual.)

Here are some mistakes I found:

1. ElmerModelsManual.pdf, page 15:
"Heat Equation String
If set to True, solve the heat equation."

This does not work. When I input this to the case.sif:

Equation 1
Heat Equation = String "False"
Active Solvers(4) = Integer 1 2 3 4
End

I get this error:
"ERROR:: CheckKeyword: Keyword: [heat equation] in section: [equation 1] is given wrong type: [string], should be of type: [logical]"

It works, if I write therefore

Equation 1
Heat Equation = Logical False
Active Solvers(4) = Integer 1 2 3 4
End

2. ElmerSolverManual.pdf, page 34:
"below unity is sometimes required to achive convergence of the nonlinear system."
___________________________________ ^

3. all manuals the keyword "Steady State" is inconsistent, sometimes it is "Steady State", sometimes "Steady state". For the case.sif the difference doesn't matter but for me it was confusing.

At least 1. should be fixed.

thanks and regards
Uwe
Last edited by uwestoehr on 08 Aug 2022, 20:54, edited 1 time in total.
raback
Site Admin
Posts: 4449
Joined: 22 Aug 2009, 11:57
Antispam: Yes
Location: Espoo, Finland
Contact:

Re: mistakes in the Manual

Post by raback »

Hi

Just fixed 1). Thanx! The "Heat Solver = True" and "Active Solvers(1) = 1" are btw interchangeable.

The sif file of Elmer is not case sensitive. The only thing case sensitive may be some filenames. To keep the case one can give, for example:

Code: Select all

Output File = "BigCaseExample.vtu"  ! known keyword of type File
Filename = File "MyFile.dat"
The type "File" will keep the case while type "String" will not. Otherwise it would be difficult to refer to files names with large caps.

-Peter
uwestoehr
Posts: 16
Joined: 05 Aug 2022, 14:42
Antispam: Yes

Re: mistakes in the Manual

Post by uwestoehr »

raback wrote: 08 Aug 2022, 12:15 Just fixed 1). Thanx! The "Heat Solver = True" and "Active Solvers(1) = 1" are btw interchangeable.
Thanks!

If they are interchangeable, do they overwrite each other? I mean does this:

Equation 1
Active Solvers(4) = Integer 1 2 3 4
Heat Equation = Logical "False"
End

and Solver 1 is Heat means the heat solver in effect not executed?

I tired this but then I get this error:

Code: Select all

LoadInputFile: Reading base load of sif file
ERROR:: SectionContents: Problem reading logical keyword: heat equation: False
when I try this:

Equation 1
Active Solvers(4) = Integer 1 2 3 4
Heat Solver = Logical "False"
End

I get this error:

Code: Select all

LoadInputFile: Reading base load of sif file
CheckKeyword:  Unlisted keyword: [heat solver] in section: [equation 1]
ERROR:: SectionContents: Problem reading logical keyword: heat solver: False
Rich_B
Posts: 228
Joined: 24 Aug 2009, 20:18

Re: mistakes in the Manual

Post by Rich_B »

Hello,

Item 2 has been fixed. Several typos have been corrected in the Solver manual and the Models manual. The latest pdf is dated 17 October 2022 and is located here:

https://www.nic.funet.fi/pub/sci/physics/elmer/doc/

Rich.
Post Reply