View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0001671 | OpenFOAM | Bug | public | 2015-04-24 19:35 | 2015-07-21 13:23 |
| Reporter | wyldckat | Assigned To | chris | ||
| Priority | low | Severity | text | Reproducibility | N/A |
| Status | closed | Resolution | fixed | ||
| Summary | 0001671: Typo in the User Guide, regarding "minRefinementCells" | ||||
| Description | A colleague of mine spotted this today in the OpenFOAM User Guide, Table 5.7: minRefinementCells If ≥ number of cells to be refined, surface refinement stops If we compare with the comment in the reference dictionary file: https://github.com/OpenFOAM/OpenFOAM-2.3.x/blob/master/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMeshDict#L93 it states this: // The surface refinement loop might spend lots of iterations refining just a // few cells. This setting will cause refinement to stop if <= minimumRefine // are selected for refinement. Note: it will at least do one iteration // (unless the number of cells to refine is 0) minRefinementCells 0; AFAIK, the typo is in the User Guide, where the >= should be <=. | ||||
| Tags | User Guide | ||||
|
|
I understand the entry in table 5.7 to mean: "If minRefinementCells (typically set to 10) is >= the number of cells selected to be refined, e.g. 6, refinement stops" This is correct, right? |
|
|
Yes, that's correct. May I suggest: - Adding "then" before the last part of the sentence: "e.g. 6, then refinement stops" - The note provided in the comment in the dictionary would also come in handy... namely the one referring to always doing at least one iteration, unless this parameter is set to 0. Although, I guess you're aiming for the table to only have summary descriptions? |
|
|
I think this is resolved now. |
|
|
@chris: Sorry to say that unfortunately this issue is not fixed yet, or at least the fixed version isn't public yet? In the User Guide PDF for OpenFOAM 2.4.0, the table has a different number, namely it's Table 5.8 and still reads the reported description. The online version of the User Guide is still using the OpenFOAM 2.3 numbering (it's Table 5.7) and also reads the same issue as reported: http://cfd.direct/openfoam/user-guide/snappyhexmesh/#x26-1550227 |
|
|
I was not proposing a change to the text in my initial response, just clarifying the meaning. It is in a table so needs to be compact and I think it makes sense and is correct. (I thought you agreed, Bruno) There is no need to add the word "then", e.g. If ≥ number of cells to be refined, THEN surface refinement stops ... it is grammatically correct without it. |
|
|
My sincere apologies Chris, I did misunderstand the logical statement. The documentation is indeed correct on both sides and yes it makes sense the description is compact for the table. What I failed to interpret was that the comment on the dictionary file has: if selected <= minimumRefine then stop and the User Guide has: if minimumRefine >= selected then stop Again, my apologies. |
|
|
No problem Bruno. Will close this one. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2015-04-24 19:35 | wyldckat | New Issue | |
| 2015-04-25 23:29 | chris | Note Added: 0004655 | |
| 2015-04-25 23:29 | chris | Assigned To | => chris |
| 2015-04-25 23:29 | chris | Status | new => feedback |
| 2015-04-26 10:16 | wyldckat | Note Added: 0004656 | |
| 2015-04-26 10:16 | wyldckat | Status | feedback => assigned |
| 2015-07-12 13:02 | chris | Note Added: 0005069 | |
| 2015-07-12 13:02 | chris | Status | assigned => closed |
| 2015-07-12 13:02 | chris | Resolution | open => fixed |
| 2015-07-12 19:50 | wyldckat | Note Added: 0005073 | |
| 2015-07-12 19:50 | wyldckat | Status | closed => feedback |
| 2015-07-12 19:50 | wyldckat | Resolution | fixed => reopened |
| 2015-07-18 21:30 | wyldckat | Tag Attached: User Guide | |
| 2015-07-21 09:41 | chris | Note Added: 0005103 | |
| 2015-07-21 11:50 | wyldckat | Note Added: 0005107 | |
| 2015-07-21 11:50 | wyldckat | Status | feedback => assigned |
| 2015-07-21 11:51 | wyldckat | Note Edited: 0005107 | |
| 2015-07-21 13:23 | chris | Note Added: 0005112 | |
| 2015-07-21 13:23 | chris | Status | assigned => closed |
| 2015-07-21 13:23 | chris | Resolution | reopened => fixed |
