Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

typo in UG #1822

Closed
gforney opened this issue Jun 25, 2015 · 182 comments
Closed

typo in UG #1822

gforney opened this issue Jun 25, 2015 · 182 comments
Assignees
@drjfloyd
Labels
Priority-Medium Type-Defect

Comments

@gforney
Copy link
Contributor

gforney commented Jun 25, 2015 

March 11, 2013
FDS Version 6.0
SVN Repository Revision : 15044

Describe details of the issue below:


9.1.6 Species and Species Mass Flux Boundary Conditions
These boundary conditions are MASS_FLUX(:) and MASS_FRACTION(:) If a ....
=>
These boundary conditions are MASS_FLUX(:) and MASS_FRACTION(:). If a ....

Original issue reported on code.google.com by springcb38 on 2013-03-11 14:02:58
@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

I'll take care of it.

Original issue reported on code.google.com by mcgratta on 2013-03-11 15:11:06

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Fixed. You can continue to add typos to this thread rather than opening a new one.

Original issue reported on code.google.com by mcgratta on 2013-03-11 15:54:37

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

9.2.3 HVAC Node Parameters
(in Guide)
&HVAC TYPE_ID='NODE', ID='tee', DUCT_ID='duct 1','duct 2',..'duct n',
    LOSS_ARRAY=lossarray, XYZ=x,y,z /
(Typo)
LOSS_ARRAY => LOSS 


9.2.3 HVAC Node Parameters
(in Guide)
&HVAC TYPE_ID='NODE', ID='ambient', DUCT_ID='duct 1', LOSS_ARRAY=enter,exit,
    XYZ=x,y,z /
(Typo)
&HVAC TYPE_ID='NODE', ID='ambient', DUCT_ID='duct 1', LOSS=?, AMBIENT=.TRUE., XYZ=x,y,z
/


9.2.3 HVAC Node Parameters
(in Guide)
LOSS(I,J) is the loss for flow from from duct I to duct J ....
(Typo)
from from => from


9.2.3 HVAC Node Parameters
(in Guide)
A duct node must either have two or more ducts ...
(Typo)
A node must either have two or more ducts


9.2.4 HVAC Fan Parameters
Fan Curves
(in Guide)
... a quadratic fan with VOLUME_FLUX=10 and MAX_PRESSURE=500,...
(Typo)
... a quadratic fan with MAX_FLOW=10 and MAX_PRESSURE=500,...


9.2.6 HVAC Aircoil Parameters
(in Guide)
A sample input is line is as follows:
(Typo)
A sample input line is as follows:


9.2.6 HVAC Aircoil Parameters
(in Guide)
&HVAC TYPE='AIRCOIL', ID='aircoil 1',...
(Typo)
&HVAC TYPE_ID='AIRCOIL', ID='aircoil 1',...

Original issue reported on code.google.com by springcb38 on 2013-03-15 11:26:35

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

9.2.1 (1) HVAC Duct Parameters
(in Guide)
Note that only one of AIRCOIL_ID, DAMPER_ID, or FAN_ID should be specified for a duct.
(Typo)
Note that only one of AIRCOIL_ID, DAMPER, or FAN_ID should be specified for a duct.


9.2.1 (2) HVAC Duct Parameters
(in Guide)
The pressure losses associated with all the segments of the duct can be collapsed in
to in single effective loss ....
(typo?)
Above sentence is perfect ?

Original issue reported on code.google.com by springcb38 on 2013-03-15 11:29:12

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

(No text was entered with this change)

Original issue reported on code.google.com by mcgratta on 2013-03-15 12:54:54

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

9.2.7 Louvered HVAC Vents
(in Guide)
...the keyword UVW on VENT. UWV is the...
(Typo)
...the keyword UVW on VENT. UVW is the...

Original issue reported on code.google.com by springcb38 on 2013-03-15 13:49:22

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

9.3.1 Specifying Pressure Zones
(in Guide)
A pressure zone can by any region within the computational......
(Typo)
A pressure zone can be any region within the computational......


9.3.1 Specifying Pressure Zones
(in Guide)
Example Case: Breaking Pressure Zones
This second point ought to be seen as a warning:
(Typo?)
:?


17.30
OUTLINE | Logical | Section 7.3.1. | .FALSE. |        |
=>
OUTLINE | Logical | Section 7.3.1. |         |.FALSE. |

Original issue reported on code.google.com by springcb38 on 2013-03-18 13:38:21

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Thank you again for your careful reading of the User's Guide.

Original issue reported on code.google.com by drjfloyd on 2013-03-18 14:38:50

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

10.3 Arrhenius Parameter Functions
(in Guide)
the pre-exponential is large and the activation is energy is 0,
(Typo)
the pre-exponential is large and the activation of energy is 0,

Original issue reported on code.google.com by springcb38 on 2013-03-19 14:04:43

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

11.1 Specifying Primitive Species
(in Guide)
Once defined that species can be tacked  as a single species and/or the species can
   used as part of one or more...
(Typo)
Once defined that species can be tracked as a single species and/or the species can
be used as part of one or more...


11.1 Specifying Primitive Species
(in Guide)
a primitive species with BACKGROUND=.TRUE. can be also be used
(Typo)
a primitive species with BACKGROUND=.TRUE. can also be used

Original issue reported on code.google.com by springcb38 on 2013-03-20 09:18:30

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

11.1.2 Specifying Gas and Liquid Species Properties
Option 2: User-Specified Properties
Two Gas Species with the Same Properties
(in Guide)
Note that the ID you provide for for a lumped species cannot ....
(Typo)
Note that the ID you provide for a lumped species cannot ....


11.1.2 Specifying Gas and Liquid Species Properties
Option 2: User-Specified Properties
Two Gas Species with the Same Properties
(in Guide)
If instead the primitive species ID was used, then the that output would sum ...
(Typo)
If instead the primitive species ID was used, then the output would sum ...


11.2 Specifying Lumped Species (Mixtures of Primitive Species)
(in Guide)
...individually. The parameters to defined a lumped species are::
(Typo)
...individually. The parameters to define a lumped species are::

Original issue reported on code.google.com by springcb38 on 2013-03-21 10:56:13

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Table 17.14
(in Guide)
INITIAL_UNMIXED_FRACION |   |   |1.0    |
(Typo)
INITIAL_UNMIXED_FRACION |   |   |   | 1.0

Original issue reported on code.google.com by springcb38 on 2013-03-22 16:36:17

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

12.3 Finite Rate Combustion
(in Guide)
The array SPEC_ID_N_S contains the list of species with the exponents, N_S, in Eq.
(12.14).
(Typo)
The array SPEC_ID_N_S contains the list of species with the exponents, N_S, in Eq.
(12.13).


12.4 Special Topic: Aerosol Deposition
(in Guide)
... QUANTITY='DEPOSITION VELOCITY' for a wall cell DEVC or with BNDF.
(Typo)
... QUANTITY='DEPOSITION VELOCITY' for a wall cell with DEVC or BNDF.


13.2.3 Wide Band Model
(in Guide)
the output QUANTITY 'ABSORPTION COEFFICIENT' output quantity becomes practically useless...
(Typo)
the output QUANTITY 'ABSORPTION COEFFICIENT' becomes practically useless...


14.3.4 Size Distribution
(Question)
What is the parameter CDF_CUTOFF ?


14.3.4 Size Distribution
(in Guide)
You can specify your own cumulative number fraction (CNF)2 by specifying a USER_CNF_RAMP
on the...
(Typo)
You can specify your own cumulative number fraction (CNF)2 by specifying a CNF_RAMP_ID
on the...


14.4.1 Basic Geometry and Boundary Conditions
(in Guide)
If the SURF line includes a MATL_ID, the particle mass will be based upon the value
or values of DENSITY of the ...
(Typo)
If the SURF line includes a MATL_ID, the particle mass will be based upon the value
of DENSITY of the ...

Original issue reported on code.google.com by springcb38 on 2013-03-24 14:14:42

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

14.4.7 Screens
(in Guide)
&PART ID='SCREEN', DRAG_LAW='SCREEN', ......, ORIENTATION(1:1,3)=1,0,0
(Typo)
&PART ID='SCREEN', DRAG_LAW='SCREEN', ......, ORIENTATION(1,1:3)=1,0,0

Original issue reported on code.google.com by springcb38 on 2013-03-25 12:40:41

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Thanks again.

Original issue reported on code.google.com by drjfloyd on 2013-03-25 13:00:39

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

17.30 VENT
(in Guide)
PBX, PBY, PBZ |Real |Section 7.3.1  |   |   |
(Typo)
PBX, PBY, PBZ |Real |Section 7.3.1  |m  |   |

Original issue reported on code.google.com by springcb38 on 2013-03-26 12:58:40

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Table 17.20 PROP
(in Guide)
LENGTH  |Real   |Section 15.3.5 |   |1.8
(Typo)
LENGTH  |Real   |Section 15.3.5 |m  |1.8


15.3.5 Smoke Detectors
Defining Smoke
(in Guide)
&SURF ID='SMOLDER', TMP_FRONT=1000., MASS_FLUX(1)=0.0001, COLOR='RED' /
(Typo?)
&SURF ID='SMOLDER', TMP_FRONT=1000., MASS_FLUX(1)=0.0001, SPEC_ID='MY SMOKE', COLOR='RED'
/

Original issue reported on code.google.com by springcb38 on 2013-03-28 12:21:12

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

thanks once again.

Original issue reported on code.google.com by drjfloyd on 2013-03-28 18:24:47

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

15.4.2 Activating and Deactivating Vents
(in Guide)
the purpose is to either activate or deactivate any time ramp associated with the VENT
via its SURF_ID.
(Typo)
the purpose is to either activate or deactivate any time ramp associated with the VENT
via its DEVC_ID.


15.5.5 Control Function: CUSTOM
(in Guide)
&CTRL ID='cycling timer', FUNCTION_TYPE='CUSTOM, INPUT_ID='TIMER', RAMP_ID='cycle'
/
(Typo)
&CTRL ID='cycling timer', FUNCTION_TYPE='CUSTOM', INPUT_ID='TIMER', RAMP_ID='cycle'
/


Happy to do something for FDS6 !!

Original issue reported on code.google.com by springcb38 on 2013-03-29 11:07:36

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

15.5.3 Control Function: DEADBAND
(in Guide)
when the value of the INPUT_ID drops below the lower value in DEADBAND
(Typo)
when the value of the INPUT_ID drops below the lower value in SETPOINT

Original issue reported on code.google.com by springcb38 on 2013-04-01 11:58:34

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Chapter 16
Output
(in Guide)
It is important to remember that you must explicitly declare in the input file most
of the FDS output data.
(Question)
Above sentence is perfect ?


16.1 Output Control Parameters: The DUMP Namelist Group
(in Guide)
Note that DT_SLCF controls Smoke3D output.
(Typo)
Note that DT_SLCF controls SMOKE3D output.


16.1 Output Control Parameters: The DUMP Namelist Group
(in Guide)
EB_DUMP_FILE If .TRUE. write out the particle output file using 8 byte reals.
(Typo)
EB_DUMP_FILE If .TRUE., write out the particle output file using 8 byte reals.

Original issue reported on code.google.com by springcb38 on 2013-04-02 12:54:10

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

table 17.6
(in Guide)
DT_DEVC_LINE    | Real  | Section 16.2.2    |   | 1     |
(Typo)
DT_DEVC_LINE    | Real  | Section 16.2.2    | s | delta t / 4   |

Original issue reported on code.google.com by springcb38 on 2013-04-03 09:12:46

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

16.9.6 Particle Output Quantities
Solid Phase
(in Guide)
In this case case each grid cell on the floor....
(Typo)
In this case each grid cell on the floor....


16.9.6 Particle Output Quantities
Solid Phase
(in Guide)
analogous to actual buckets the size of a grid cell.
(Question)
Above sentence is perfect ?


Table 17.20
(Typo)
There is no PDPA_HISTOGRAM_LIMITS.

Original issue reported on code.google.com by springcb38 on 2013-04-09 13:28:22

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

9.2.5 HVAC Filter Parameters
(in Guide)
RAMP_ID identifies the RAMP that contains a table of pressure drop across the filter
as a function of total loading (see summation in LOSS.
(Typo?)
(summation in LOSS)  ?


Table 17.9
(in Guide)
LOADING_MULITPLIER  | Real Array    | Section 9.2.5 | kg    | 0.0
(Typo?)
LOADING_MULITPLIER  | Real Array    | Section 9.2.5 | kg^-1 | 0.0

K_filter = K_CLEAN_LOSS + K_LOSS sum(Li Mi) (9.2.5 HVAC Filter Parameters)

K_filter : implicitly in FDS code (non-dimensional)
K_CLEAN_LOSS : CLEAN_LOSS (non-dimensional)
K_LOSS : LOSS (non-dimensional)
Li : LOADING (kg)
Mi : LOADING_MULTIPLIER (kg? -> kg^-1)

Original issue reported on code.google.com by springcb38 on 2013-04-12 09:02:11

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Y_CO2_INFTY=0.0058(manual) ? 0.000595(code)
Y_O2_INFTY=0.232428(manual) ? 0.232378(code)

MAX_PRESSURE_ITERATIONS=10000(manual)? 10(code)

Which is correct?

(In this issue site, I didn't get a response in case of such a question. Please reply
to me via mail.)
Thank you ~

Original issue reported on code.google.com by springcb38 on 2013-04-25 04:12:55

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

LES_FILTER_WIDTH = 'MAX' (manual) ? 'MEAN' (code)

Which is correct?

Original issue reported on code.google.com by springcb38 on 2013-04-25 06:08:45

@gforney
Copy link
Contributor Author

gforney commented Jun 25, 2015 

Thanks again.  In general if there is a discrepancy between the manual and the code,
the code is correct and manual just wasn't updated.

Original issue reported on code.google.com by drjfloyd on 2013-04-25 12:51:45

@mcgratta
Copy link
Contributor

Yes, you're right. I'll fix. Thanks

@Er9y714
Copy link

Er9y714 commented May 15, 2017

Refering to the topic: https://groups.google.com/forum/#!topic/fds-smv/YqEj7erosbw

Is there a reason that copy-paste (from UG) results to problems in fds? I mean is it on purpose that this kind of apostrophe is used?

Thank you.

@sbenkorichi
Copy link
Collaborator

There might be incompatibilities sometimes with different programs and text editors, I recall for instance, I copied something into Latex file, and then found the apostrophes were not recognised and had to redefine them inside the latex Texmaker itself. There is a different when you are in code mode for example web design, you get it as ( ` ) Whereas in regular text it's as ( '). So, this is depending on the mode of your code you are using. For instance, on github here, when you use the < > for code, you get this special parenthesis for special code.
Hope this help.

@Er9y714
Copy link

Er9y714 commented May 19, 2017

  • [ ]
    QUANTITY2 has few links. There might be some typo.

Table 18.5
Links to 17.2.2 > Does not mention about the parameter

§18.24 SLCF
Links to 17**.12** > Does not mention about the parameter

  • [ ]
    MAXIMUM_VALUE in § 18.24
    It is referred to SMV userguide. I am not familiar with SMV in detail but I had a look and I could not find exact parameter description in user guide. Is it discarding above values as it is mentioned few topics in SMV UG?

  • [ ]
    MESH_NUMBER in §18.24
    Refers to 17.4 but it is not mentioned how to use.

Thanks!

@sbenkorichi
Copy link
Collaborator

Thanks for reporting these points.

QUANTITY usually is considered as a title for the different output of temp, velocity etc.. Not sure what it has to do inside the table.

  1. The MAXIMUM_VALUE refers to the maximum range value of certain QUANTITIES. You can check how you get it from the SMV user guide.

  2. MESH_NUMBER , I don't know what's doing in Table 18.24, it's already described in Table 18.29.

I would let other members to fix this since they know why it's there.

@chulann
Copy link

chulann commented May 31, 2017 •
edited
Loading

Section 18.10.11 Fractional Effective Dose (FED) and Fractional Irritant Concentration (FIC)
The section isn't clear regarding whether or not species need to be included in the FDS script (I assume they do). With some testing, I believe FDS will calculate the FED without them included - you just get an FED that only includes the species you have included in the script.

I think there is a typo in the fed_test.fds example, but I can't find it in the source so don't know where to check and comment (Basically, comma missing on the SLCF lines separating the QUANTITY and SPEC_ID)

@Er9y714
Copy link

Er9y714 commented Jul 14, 2017

I think that 15.3 Background (User guide of SMV) should be in FDS User Guide instead of SMV. What do you think?

@gforney
Copy link
Contributor Author

gforney commented Jul 14, 2017

I would rather keep it and along with other utilities such as smokezip and smokediff in the smokeview user's guide

@Er9y714
Copy link

Er9y714 commented Jul 25, 2017

§16.3.1 = SPRAY_ANGLE(1,1:2), SPRAY_PATTERN_TABLE,

It is detailed at great amount but is it possible to add few figures to explain the parameters above by showing which angles they correspond?
Thank you for consideration.

@rmcdermo
Copy link
Contributor

Is this in the FDS User Guide? Are you looking at the latest guide?

@Er9y714
Copy link

Er9y714 commented Jul 25, 2017

Yes User Guide,
How can I check the most up to date file?

This is the info on the cover page of the document:

January 18, 2017
FDS Version 6.5.3
Revision: FDS6.5.3-569-ge3d0d6c

@sbenkorichi
Copy link
Collaborator

You can check the latest files here.
https://drive.google.com/drive/folders/0B_wB1pJL2bFQUlJwMmNfaHlqME0

@rmcdermo
Copy link
Contributor

rmcdermo commented Jul 25, 2017 via email

@Er9y714
Copy link

Er9y714 commented Jul 25, 2017

First time I see this link. Thank you!

Is there any way to see the changelog of these new versions of the Guides?

The link on the front page directing me to the FDS4 user guide. Is that normal?
http://dx.doi.org/10.6028/NIST.SP.1019

I thought I would find figures about my request in the up-to-date guide but I do not see. Please let me know if I miss it or is it a good idea to add or not.

Thank you

@rmcdermo
Copy link
Contributor

rmcdermo commented Jul 25, 2017 via email

@Er9y714
Copy link

Er9y714 commented Jul 25, 2017

Sorry, I did not mean the link you sent. I mean the link in the front page of the pdf file of FDS User Guide.

image

@sbenkorichi
Copy link
Collaborator

Oh, that's the DOI,

@rmcdermo
Copy link
Contributor

rmcdermo commented Jul 25, 2017 via email

@sbenkorichi
Copy link
Collaborator

Yeah, normally, it should be linked with the latest version. Unless, it's set for a purpose.

@chulann
Copy link

chulann commented Jul 26, 2017 via email

@sbenkorichi
Copy link
Collaborator

Yes, they're included in the third page. Check my previous link for example

July 26, 2017
FDS Version 6.5.3
Revision: FDS6.5.3-2166-gc88e7ce

@chulann
Copy link

chulann commented Jul 26, 2017 via email

@rmcdermo
Copy link
Contributor

For the release document the date is the release date (or very close to it). The document that Salah cites is the nightly build.

@chulann
Copy link

chulann commented Jul 26, 2017 via email

@rmcdermo
Copy link
Contributor

The official release manual does not change. It is located here:

https://pages.nist.gov/fds-smv/manuals.html

These are the same documents that are downloaded with the bundle.

@Er9y714
Copy link

Er9y714 commented Aug 17, 2017

Is there any way to see the changelog of these new versions of the Guides? It is hard to compare what is added/removed.

@drjfloyd
Copy link
Contributor

drjfloyd commented Aug 17, 2017 via email

@mcgratta
Copy link
Contributor

mcgratta commented Sep 7, 2017

Closing this issue. If there are new typos, start a new issue.

@mcgratta mcgratta closed this as completed Sep 7, 2017
@sbenkorichi sbenkorichi mentioned this issue Oct 19, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@drjfloyd drjfloyd

Labels
Priority-Medium Type-Defect
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@rmcdermo @mcgratta @gforney @drjfloyd @springcb @chulann @sbenkorichi @Er9y714