Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/source/acknowledgements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Acknowledgements
================

This software is developed and maintained by researchers at the
`National Renewable Energy Laboratory <https://www.nrel.gov>`_ with funding
`National Laboratory of the Rockies <https://www.nlr.gov>`_ with funding
from U.S. Department of Energy Wind Energy Technology Office through the
`Atmosphere to electrons (A2e) <https://a2e.energy.gov>`_ research initiative.

NREL gratefully acknowledges development contributions from the following
NLR gratefully acknowledges development contributions from the following
organizations:

- Accelerate Wind
Expand Down Expand Up @@ -43,5 +43,5 @@ organizations:
- Vestas
- Windward Engineering

NREL gratefully acknowledges additional development support through designation
NLR gratefully acknowledges additional development support through designation
as an `Intel® Parallel Computing Center (IPCC) <https://software.intel.com/en-us/ipcc>`_.
2 changes: 1 addition & 1 deletion docs/source/dev/cppapi/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ The mapping of loads and deflections to the actuator points is performed in the
Test for mapping procedure
--------------------------

The test for the implementation of the mapping procedure is as follows. OpenFAST is run using the C++ API to simulate the NREL-5MW turbine for one time step with a prescribed velocity of :math:`8 m/s` at all the velocity nodes and no induction (:samp:`WakeMod=0`). The number of actuator force nodes is varied from 10 to 100 while the number of velocity nodes is fixed at 17. :numref:`actuator-force-nodes-mapping-test-thrust` and :numref:`actuator-force-nodes-mapping-test-torque` show that the thrust and torque vary by less than :math:`1.1 \times 10^{-6}\%` and :math:`2 \times 10^{-6}\%` respectively when the number of actuator force nodes is varied from :math:`10-100`.
The test for the implementation of the mapping procedure is as follows. OpenFAST is run using the C++ API to simulate the Jonkman 5-MW (formerly known as the NREL 5-MW) turbine for one time step with a prescribed velocity of :math:`8 m/s` at all the velocity nodes and no induction (:samp:`WakeMod=0`). The number of actuator force nodes is varied from 10 to 100 while the number of velocity nodes is fixed at 17. :numref:`actuator-force-nodes-mapping-test-thrust` and :numref:`actuator-force-nodes-mapping-test-torque` show that the thrust and torque vary by less than :math:`1.1 \times 10^{-6}\%` and :math:`2 \times 10^{-6}\%` respectively when the number of actuator force nodes is varied from :math:`10-100`.


.. _actuator-force-nodes-mapping-test-thrust:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/dev/github_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on the `GitHub repository <https://github.com/openfast/openfast>`__. There,
`issues <https://github.com/openfast/openfast/issues>`__ and
`pull requests <https://github.com/openfast/openfast/pulls>`__
are discussed and new versions are released. It is the best mechanism for
engaging with the NREL OpenFAST team and other developers throughout
engaging with the NLR OpenFAST team and other developers throughout
the OpenFAST community.

Issues and work assignment
Expand All @@ -22,7 +22,7 @@ make clear any intention to complete a task.
Pull Requests
-------------
When a code modification is ready for review, a pull request should be
submitted along with all appropriate documentation and tests. An NREL OpenFAST
submitted along with all appropriate documentation and tests. An NLR OpenFAST
team member will assign a reviewer and work with the developer to have the
code merged into the main repository.

Expand Down
26 changes: 13 additions & 13 deletions docs/source/dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ documented, and self-sustaining software.** To that end, we
continually work to improve the documentation and test coverage along with
feature additions and improvements. This section of the documentation outlines
the processes and procedures we have established for external developers
to work with the NREL OpenFAST team on code development.
to work with the NLR OpenFAST team on code development.

If you'd like to help with general OpenFAST development or work on a particular
feature, then first install OpenFAST following the
Expand All @@ -20,8 +20,8 @@ understand the general workflow for individual and coordinated development.
Finally, be sure to review the :doc:`GitHub workflow <github_workflow>` to
avoid any merge or code conflicts.

With development happening in parallel between NREL, industry partners, and
universities, NREL relies on GitHub to coordinate efforts:
With development happening in parallel between NLR, industry partners, and
universities, NLR relies on GitHub to coordinate efforts:

- `GitHub Issues <https://github.com/openfast/openfast/issues>`_ is the place
to ask usage or development questions, report bugs, and
Expand Down Expand Up @@ -49,15 +49,15 @@ Development Philosophy and Guidelines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

OpenFAST is intended to be a self-sustaining, community developed software.
While the NREL OpenFAST team serves as the gatekeeper of the repository, we
While the NLR OpenFAST team serves as the gatekeeper of the repository, we
actively encourage the community to share new ideas and contribute code.
Considerations for contributing code are outlined here.

Engagement with NREL
--------------------
Engagement with NLR
-------------------

The process for community code contribution starts with engaging directly
with the NREL OpenFAST team to define the scope of the work and coordinate
with the NLR OpenFAST team to define the scope of the work and coordinate
development efforts. This is particularly important since many groups
work on OpenFAST simultaneously. By engaging early, all developers can
stay up to date and minimize conflicts during the code merge.
Expand All @@ -67,17 +67,17 @@ development work, the areas of the software that will be impacted,
and any model validation materials. See :ref:`development_plan`
for more information on describing the planned work.

The NREL OpenFAST team is always working on internal projects
The NLR OpenFAST team is always working on internal projects
that require the majority of our attention, but we will make every effort
to engage with the community and support development efforts in
a reasonable time frame. After posting an Issue, the NREL OpenFAST
a reasonable time frame. After posting an Issue, the NLR OpenFAST
team may reach out to schedule a meeting to talk through the details.

.. _development_plan:

Development Plan / Implementation Plan
--------------------------------------
Significant code development efforts at NREL begin with the development
Significant code development efforts at NLR begin with the development
of a detailed implementation plan, and a few such plans are available to
download for reference:

Expand Down Expand Up @@ -147,10 +147,10 @@ as any algorithms or lines of code that are unclear. Ask yourself
what you would need to know to fully understand your code if you don't
see it again for two years.

Submit for review and NREL feedback
Submit for review and NLR feedback
-----------------------------------

New code can be submitted for review from the NREL OpenFAST team by
New code can be submitted for review from the NLR OpenFAST team by
opening a `pull request <https://github.com/openfast/openfast/pulls>`_
as described in :ref:`github_workflow`. We will review the code for
accuracy, validity, quality, and robustness. Reviewing open source
Expand Down Expand Up @@ -225,7 +225,7 @@ Additional guidance
-------------------

The following sections provide extended guidance on developing source code,
interacting with the NREL OpenFAST team and other community contributors, and
interacting with the NLR OpenFAST team and other community contributors, and
generally debugging and building out features.

.. toctree::
Expand Down
20 changes: 10 additions & 10 deletions docs/source/dev/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ for the most computationally expensive use cases. The process generally involves
initial profiling and hotspot analysis, then identifying specific subroutines to
target for optimization in the physics modules and glue-codes.

A portion of this work was supported by Intel® through its designation of NREL as an
A portion of this work was supported by Intel® through its designation of NLR as an
`Intel® Parallel Computing Center (IPCC) <https://software.intel.com/en-us/ipcc>`_.

The procedures, findings, and recommended programming practices are presented here.
Expand Down Expand Up @@ -245,17 +245,17 @@ The physics modules used in this case are:
* AeroDyn 15
* ServoDyn

This is a land based NREL 5-MW turbine simulation using BeamDyn as the
This is a land based Jonkman 5-MW (formerly called the NREL 5-MW) turbine simulation using BeamDyn as the
structural module. It simulates 20 seconds with a time step size of 0.001
seconds and executes in `3m 55s <https://my.cdash.org/testDetails.php?test=40171217&build=1649048>`__
on NREL's `Peregrine <https://www.nrel.gov/hpc/peregrine-system.html>`__
supercomputer.
on NLR's former Peregrine
supercomputer (retired).

**5MW_OC4Jckt_DLL_WTurb_WavesIrr_MGrowth**

Download case files `here <https://github.com/OpenFAST/r-test/tree/dev/glue-codes/openfast/5MW_OC4Jckt_DLL_WTurb_WavesIrr_MGrowth>`__.

This is an offshore, fixed-bottom NREL 5-MW turbine simulation with the
This is an offshore, fixed-bottom Jonkman 5-MW (formerly called the NREL 5-MW) turbine simulation with the
majority of the computational expense occurring in the HydroDyn wave-dynamics
calculation.

Expand All @@ -270,8 +270,8 @@ The physics modules used in this case are:

It simulates 60 seconds with a time step size of 0.01 seconds and executes in
`20m 27s <https://my.cdash.org/testDetails.php?test=40171219&build=1649048>`__
on NREL's `Peregrine <https://www.nrel.gov/hpc/peregrine-system.html>`__
supercomputer.
on NLR's former Peregrine
supercomputer (retired).

Profiling
+++++++++
Expand Down Expand Up @@ -324,7 +324,7 @@ Some keys outcomes from the first year of the IPCC project are as follows:
* Core algorithms need significant modification to enable OpenMP and SIMD
benefits

Tuning the Intel® tools to perform best on NREL's hardware and adding high level
Tuning the Intel® tools to perform best on NLR's hardware and adding high level
multithreading yielded a maximum 3.8x time-to-solution improvement for one
of the benchmark cases.

Expand Down Expand Up @@ -373,14 +373,14 @@ areas:
.. has continuously contributed code and expertise in this area.


.. Furthermore, NREL is optimizing OpenFAST for the future through profiling on
.. Furthermore, NLR is optimizing OpenFAST for the future through profiling on
.. Intel next generation platform (NGP) simulators.

.. bd_5MW_dynamic
.. ~~~~~~~~~~~~~~
.. Download files `here <https://github.com/OpenFAST/r-test/tree/dev/modules/beamdyn/bd_5MW_dynamic>`__.

.. This is a standalone BeamDyn case of the NREL 5MW wind turbine. It simulates 30
.. This is a standalone BeamDyn case of the Jonkman 5-MW (formerly called the NREL 5-MW) wind turbine. It simulates 30
.. seconds with a time step size of 0.002 seconds and executes in 24s on NREL's
.. Peregrine supercomputer.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/dev/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For example, ``OpenFAST-v1.0.0-123-gabcd1234-dirty`` describes OpenFAST as:
=================== =============
Version Component Explanation
=================== =============
v1.0.0 MAJOR.MINOR.PATCH numbering system; corresponds to a tagged commit made by NREL on GitHub
v1.0.0 MAJOR.MINOR.PATCH numbering system; corresponds to a tagged commit made by NREL (now called NLR after 2025) on GitHub
123-g Number of additional commits after the most recent tag for a build (the ``-g`` is for ``git``)
abcd1234 First 8 characters of the current commit hash
dirty Denotes that local changes have been made but not committed; omitted if there are no local changes
Expand Down
8 changes: 2 additions & 6 deletions docs/source/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ Getting Help
For possible bugs, enhancement requests, or code questions, please submit an issue at
the `OpenFAST Github repository <https://github.com/OpenFAST/OpenFAST>`_.

For OpenFAST usage questions, users should consider the `FAST Forum <https:// wind.nrel.gov/forum/wind/>`_, which provides a large 10+ year legacy of FAST-related Q&A; the forum's search functionality should be used before posting questions to either github issues or the forum.

Users may find the established FAST v8 through the NWTC Information Portal:
https://nwtc.nrel.gov/

Please contact `Michael.A.Sprague@NREL.gov <mailto:Michael.A.Sprague@NREL. gov>`_. with questions regarding the OpenFAST development plan or how to contribute.
For OpenFAST usage questions, users should consider the `FAST Forum <https://forums.nlr.gov/>`_, which provides a large 10+ year legacy of FAST-related Q&A; the forum's search functionality should be used before posting questions to either GitHub issues or the forum.

Please contact `Jason.Jonkman@nlr.gov <mailto:jason.jonkman@nlr.gov>`_ or `Andy.Platt@nlr.gov <mailto:andy.platt@nlr.gov>`_ with questions regarding the OpenFAST development plan or how to contribute.
8 changes: 4 additions & 4 deletions docs/source/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,9 @@ openfast_x64.exe 64-bit single precision
openfast_x64_double.exe 64-bit double precision
Map_Win32.dll 32-bit MAP++ library
Map_x64.dll 64-bit MAP++ library
DISCON_DLLS/<64bit or Win32>/DISCON.dll Controller library for NREL 5MW
DISCON_DLLS/<64bit or Win32>/DISCON_ITIBarge.dll Controller library for NREL 5MW - ITI Barge
DISCON_DLLS/<64bit or Win32>/DISCON_OC3Hywind.dll Controller library for NREL 5MW - OC3 Hywind
DISCON_DLLS/<64bit or Win32>/DISCON.dll Controller library for Jonkman 5-MW (formerly called the NREL 5-MW)
DISCON_DLLS/<64bit or Win32>/DISCON_ITIBarge.dll Controller library for Jonkman 5-MW (formerly called the NREL 5-MW) - ITI Barge
DISCON_DLLS/<64bit or Win32>/DISCON_OC3Hywind.dll Controller library for Jonkman 5-MW (formerly called the NREL 5-MW) - OC3 Hywind
================================================== ==============================================

After extracting the contents, the OpenFAST executables
Expand Down Expand Up @@ -248,7 +248,7 @@ For more information and installation options, see the `OpenFAST Python readme <

Compile from source
~~~~~~~~~~~~~~~~~~~
To compile from source code, the NREL OpenFAST team has developed an
To compile from source code, the NLR OpenFAST team has developed an
approach that uses CMake to generate build files for all platforms. Currently,
CMake support for Visual Studio while doing active development
is not well supported, so OpenFAST maintains a Visual Studio Solution
Expand Down
12 changes: 6 additions & 6 deletions docs/source/testing/regression_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ executing with the help option:

.. note::

For the NREL 5MW turbine test cases, an external ServoDyn controller must
be compiled and included in the appropriate directory or all NREL 5MW
For the Jonkman 5-MW (formerly called the NREL 5-MW) turbine test cases, an external ServoDyn controller must
be compiled and included in the appropriate directory or all Jonkman 5-MW (formerly called the NREL 5-MW)
cases will fail without starting. More information is available in the
documentation for the `r-test repository <https://github.com/openfast/r-test#note---servodyn-external-controllers-for-5mw_baseline-cases>`__,
but be aware that these three DISCON controllers must exist
Expand Down Expand Up @@ -200,8 +200,8 @@ be sure to execute the build command with the ``install`` target:

.. note::

REMINDER: For the NREL 5MW turbine test cases, an external ServoDyn controller must
be compiled and included in the appropriate directory or all NREL 5MW
REMINDER: For the 5MW turbine test cases, an external ServoDyn controller must
be compiled and included in the appropriate directory or all 5MW
cases will fail without starting. More information is available in the
documentation for the `r-test repository <https://github.com/openfast/r-test#note---servodyn-external-controllers-for-5mw_baseline-cases>`__,
but be aware that these three DISCON controllers must exist
Expand Down Expand Up @@ -443,7 +443,7 @@ with the naming scheme ``execute<Module>RegressionTest.py``.
The first step to adding a new regression test case is to verify that
a script exists for the target module. If it does not, an issue
should be opened in `OpenFAST Issues <https://github.com/openfast/openfast/issues>`_
to coordinate with the NREL team on creating this script.
to coordinate with the NLR team on creating this script.

The next step is to add the test case in the appropriate location in
the `r-test` submodule. The directory structure in r-test mirrors the
Expand Down Expand Up @@ -481,4 +481,4 @@ CMake driver, so follow the instructions above to edit ``CTestList.cmake``.

Finally, the new test cases in the r-test submodule must be added to the
r-test repository. To do this, open a new issue in `r-test Issues <https://github.com/openfast/r-test/issues>`_
requesting for support from the NREL team to commit your test.
requesting for support from the NLR team to commit your test.
2 changes: 1 addition & 1 deletion docs/source/user/aerodyn-aeroacoustics/02-noise-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ at high frequency, :math:`\overline{D}` is:
{\left( 1 + M\cos\Theta_{e} \right)^{3}}
:label: aa-eq:33

Note that this equation was not reported in the NREL Tech Report NREL/TP-5000-75731!
Note that this equation was not reported in the NLR Tech Report NREL/TP-5000-75731!
Comment thread
andrew-platt marked this conversation as resolved.

At low frequency, the equation is identical for both leading and trailing edges:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ trailing edge (low :math:`\Theta_e`).


.. [2]
https://github.com/NREL/ROSCO
https://github.com/NatLabRockies/ROSCO

.. [3]
https://github.com/OpenFAST/python-toolbox
Expand Down
Loading
Loading