OpenFAST / openfast

Main repository for the NREL-supported OpenFAST whole-turbine and FAST.Farm wind farm simulation codes.
http://openfast.readthedocs.io
Apache License 2.0
663 stars 452 forks source link

Revise OpenFAST output file numbering scheme in main OpenFAST file #656

Open andrew-platt opened 3 years ago

andrew-platt commented 3 years ago

The output file designations for OpenFAST is a bit confusing at present.

1 -  text
2 -  binary
3 -  text+binary
4 -  uncompressed binary
5 -  uncompressed binary+text
The sample input files say OutFileFmt = 0 is uncompressed binary (which is odd, because0 is
typically reserved for "None"), but this is actually treated as OutFileFmt = 5 by the source code.  

I propose we change to the following:

0 - none (for cases when results are passed directly back to a calling code) 1 - text 2 - binary 2u - uncompressed binary 3 - text + binary 3u - text + uncompressed binary 4 - future format #1 (TBD) 8 - future format #2 (TBD)

In the above, 3 and 3u are simply additive combinations of 1 and 2/2u. Similarly a later option 7u would be 4 + 1 + 2u.

andrew-platt commented 3 years ago

The issue with the currently output format specification was noticed by @jjonkman.