Modeling Options Inputs
Overview
The WEIS modeling options specify inputs for the various simulation models, the ROSCO controller, and other modules of WEIS that are not directly related to turbine components, which are defined in the Geometry Inputs. The modeling options includes
Simulation settings
Controller parameters
Load case parameters
Detailed descriptions of the modeling options can be found below. In the following, we will provide an overview of each modeling input section and some tips for setting up simulations using WEIS.
General
The General section of the modeling options primarily contains information related to the OpenFAST simulation_configuration, including the
Output file name base (
OF_run_fst)Output folder location (
OF_run_dir). If not provided, WEIS will generate a folder calledopenfast_runsin thefolder_outputset in the analysis options.A flag to use the OpenFAST executable (
use_exe: True) or the dynamic library.A flag to allow failed OpenFAST runs during a WEIS run (
allow_fails: True), and continue the current workflow.
Some post-processing settings are also contained in the General section, like whether to use a goodman_correction during fatigue calculations.
WISDEM
The WISDEM section of the modeling options in WEIS is inhereted from the modeling options of WISDEM.
In this section, users can toggle the flag value for the various SE (system engineering) components of WISDEM, like RotorSE.
Users can also specify elastic properties for inidividual components by toggle the user_elastic option. This way, WISDEM will pass through the elastic properties from the geomtry input, rather than generate them from component models.
Users should note:
The spar cap and trailing edge pressure and suction layers (
spar_cap_ss,spar_cap_ps,te_ss, andte_ps) must be defined and correspond to blade layers in the geometry option.In the
RotorSEsection, users can determine the number of sampling points in the Cp surface through then_pitch_perf_surfacesandn_tsr_perf_surfacesinputs. The performance surfaces, generated using cc-blade, are used to automatically tune the ROSCO controller and provide aerodynamci modeling to RAFT. If too few (less than 20) points are used in each dimension, the gains and limits of the ROSCO controller can be adversely affected.By default,
symmetric_mooringsin theFloatingSEsection of WISDEM isTrue. In many cases, including lines with multiple segments, this should be set toFalse.
OpenFAST
The OpenFAST section of the modeling options should reflect the OpenFAST iputs in a yaml format.
The simulation section corresponds to the .fst input of OpenFAST, and all the modules of OpenFAST (e.g., ElastoDyn) should have a corresponding subsection in the OpenFAST schema.
In this section, users can supply their own OpenFAST model using the from_openfast: True flag.
For example, the input:
OpenFAST:
flag: True
from_openfast: True
regulation_trajectory: IEA-15-240-RWT-outputs.yaml
openfast_file: IEA-15-240-RWT-UMaineSemi.fst
openfast_dir: ../01_aeroelasticse/OpenFAST_models/IEA-15-240-RWT/IEA-15-240-RWT-UMaineSemi
Will set up WEIS to run the OpenFAST model specified by the openfast_file in the openfast_dir.
File paths in WEIS are relative to the file from which they originate.
The regulation_trajectory is an optional input that can be used to specify initial conditions to simulations.
RAFT
The RAFT section of the modeling options is primarily used for RAFT simulation settings and also potential flow modeling using pyHAMS.
The potential_model_override input is set here and used in both RAFT and OpenFAST.
More details about potential flow modeling and hybrid models can be found here bem-modeling.
Selecting which members will be used in a potential flow solution is also specified in the RAFT modeling options.
For example:
RAFT:
flag: True
min_freq: 0.1
max_freq: 2.0
potential_bem_members: [spar]
Will model the spar member in pyHAMS and use it to model the hydrodynamics using potential flow in both RAFT and OpenFAST.
WEIS now includes the capability to create more complicated intersected meshes for the BEM modeling. Users can set the intersection_mesh value to 1 if wanting to use this capability. Note this capabilty relies on using external packages, pygmsh and meshmagick, and are not part of WEIS installation. Please make sure you install these separately beforehand. If users want to plot the intermediate meshes, toggle the plot_designs and save_designs options to True while using intersection_mesh. This mesh plotting relies on using trimesh.
ROSCO
The ROSCO modeling options in WEIS inheret the controller_parameters section of the ROSCO toolbox schema.
Users can also specify a tuning_yaml to set the controller parameters of ROSCO.
Any options specified in the WEIS modeling options will override the tuning_yaml options.
If a user provides their own OpenFAST turbine model, the tuning_yaml is required and the turbine_parameters section will be used to generate a DISCON.IN input.
Otherwise, the turbine_parameters are determined from WISDEM and only the controller_parameters are used.
DLC Driver
Finally, the DLC_Driver section of the modeling options is where users specify metocean conditions and the list of design load case (DLCs) to be simulated.
A user can specify multiple cases of the same DLC.
A more detailed documentation of the DLC_Driver can be found here: Design Load Cases in WEIS.
The full set of DLCs that can be simulated can be seen in the modeling options of this unit test.
Detailed modeling option descriptions
The following is automatically generated from the weis modeling schema:
WISDEM wind turbine modeling options schema
Type: objectSchema that describes the modeling options for WISDEM
Prints additional outputs to screen (and to a file log in the future)
Number of iterations for the top-level coupling solver
Filename prefix for output files
Path to place FAST output files (e.g. /home/user/myturbines/output)
Flag to write airfoil coordinates out or not
Use openfast executable instead of library
Flag to only generate an OpenFAST model and stop
Save openfast output timeseries
Keep timeseries in openmdao_openfast for post-processing
Save summary stats and other info for each openfast iteration. Could bump this up to a more global post-processing input.
Path to FAST executable to override default WEIS value (e.g. /home/user/OpenFAST/bin/openfast). Note that if you use this, ROSCO must use the same compilation configuration. You can specify the ROSCO dll with path2dll.
Path to FAST dynamic library to override default WEIS value (e.g. /home/user/OpenFAST/lib/libopenfast.so)
Path to turbsim executable to override default WEIS value (e.g. /home/user/OpenFAST/bin/turbsim)
Path to controller shared library (e.g. /home/user/myturbines/libdiscon.so)
Allow WEIS to continue if OpenFAST fails All outputs will be filled with fail_value. Use with caution!
Write standard output to own file. Output will not print to screen.
Number of parallel finite differencing performed by OpenMDAO. WEIS sets this number once the preMPI keyword argument is set
Number of parallel OpenFAST runs performed by OpenMDAO. WEIS sets this number once the preMPI keyword argument is set
Location of previously generated wind inputs
If False, will check for existing .outb file before running OpenFAST.
Flag whether to apply the Goodman correction for mean stress value to the stress amplitude value in fatigue calculations
Flag for using streamlined models in the WEIS simulation.
Options for potential flow modeling of submerged members
User override for potential boundary element modeling. 0 = uses the potentialbemmembers list for inviscid force and computes viscous drag with strip theory (members not listed use only strip theory), 1 = no potential BEM modeling for any member (just strip theory), 2 = potential BEM modeling for all members (no strip theory), 3 = use potential BEM modeling only for inviscid forces
Must be one of:
- 0
- 1
- 2
- 3
List of submerged member names to model with potential flow boundary element methods. Members not listed here will be modeled with strip theory
No Additional ItemsEach item of this array must be:
Base filename (no extension) for potential BEM mesh files. WEIS will look for <bem_file_base>.* files. If not present, they will be generated using pyHAMS.
Options for running WISDEM. No further options are included in this file. They are populated using the modeling schema in the WISDEM project in python.
Number of load cases
Value must be greater or equal to 0
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Number of angles of attack in a common grid to define polars
Number of coordinate point used to define airfoils
Number of spanwise stations in a common grid used to define blade properties
Number of wind speeds to compute the power curve
Number of wind speeds to spline the power curve
Number of pitch angles to determine the Cp-Ct-Cq-surfaces
Min pitch angle of the Cp-Ct-Cq-surfaces
Max pitch angle of the Cp-Ct-Cq-surfaces
Number of tsr values to determine the Cp-Ct-Cq-surfaces
Min TSR of the Cp-Ct-Cq-surfaces
Max TSR of the Cp-Ct-Cq-surfaces
Number of wind speeds to determine the Cp-Ct-Cq-surfaces
Flag to derive the regulation trajectory in region III in terms of pitch and TSR
If True, pitch is fixed in region I1/2, i.e. when min rpm is enforced.
Composite layer modeling the spar cap on the suction side in the geometry yaml. This entry is used to compute ultimate strains.
Composite layer modeling the spar cap on the pressure side in the geometry yaml. This entry is used to compute ultimate strains.
Composite layer modeling the trailing edge reinforcement on the suction side in the geometry yaml. This entry is used to compute ultimate strains.
Composite layer modeling the trailing edge reinforcement on the pressure side in the geometry yaml. This entry is used to compute ultimate strains.
Partial safety factor on modal frequencies
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Number of standard deviations for strength of gust
Value must be greater or equal to 0.0 and lesser or equal to 15.0
Safety factor for the max stress of blade root fasteners
Value must be greater or equal to 0.1 and lesser or equal to 100.0
Include Prandtl hub loss model in CCBlade calls
Include Prandtl tip loss model in CCBlade calls
Include effect of wake rotation (i.e., tangential induction factor is nonzero) in CCBlade calls
Use drag coefficient in computing induction factors in CCBlade calls
Number of sectors to divide rotor face into in computing thrust and power.
Value must be greater or equal to 1 and lesser or equal to 10
Flag switching on and off the 3d DU-Selig airfoil correction implemented in Polar.py
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Partial safety factor on loads
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for materials
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for consequence of failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Value of desired torque density of the gearbox. If zero, DrivetrainSE sizes the gearbox.
Partial safety factor for hub sizing
Value must be greater or equal to 1.0 and lesser or equal to 7.0
Partial safety factor for spinner sizing
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Type of generator architecture for detailed property, performance, and cost modeling
Must be one of:
- "dfig"
- "eesg"
- "scig"
- "pmsg_outer"
- "pmsg_arms"
- "pmsg_disc"
- "DFIG"
- "EESG"
- "SCIG"
- "PMSG_Outer"
- "PMSG_Arms"
- "PMSG_Disc"
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Wind scaling relationship with height
Must be one of:
- "PowerWind"
- "LogisticWind"
Partial safety factor on loads
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for materials
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for consequence of failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for buckling
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor on modal frequencies
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for fatigue failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Buckling utilization calculation method- Eurocode 1994 or DNVGL RP-C202
Must be one of:
- "Eurocode"
- "Euro-code"
- "eurocode"
- "euro-code"
- "DNVGL"
- "dnvgl"
- "DNV-GL"
- "dnv-gl"
Buckling length factor in Eurocode safety check
Value must be greater or equal to 1.0 and lesser or equal to 100.0
Set of Frame3DD options used for tower analysis
Inclusion of shear area for symmetric sections
Inclusion of shear stiffening through axial loading
Eigenvalue solver 1=Subspace-Jacobi iteration, 2=Stodola (matrix iteration)
Must be one of:
- 1
- 2
Convergence tolerance for modal eigenvalue solution
Value must be greater or equal to 1e-12 and lesser or equal to 0.1
Number of Frame3DD element refinements for every specified section along tower/member
Nikhar's method for modal identification
Can be monopile or jacket.
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Wind scaling relationship with height
Must be one of:
- "PowerWind"
- "LogisticWind"
Partial safety factor on loads
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for materials
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for consequence of failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for buckling
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor on modal frequencies
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for fatigue failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Buckling utilization calculation method- Eurocode 1994 or DNVGL RP-C202
Must be one of:
- "Eurocode"
- "Euro-code"
- "eurocode"
- "euro-code"
- "DNVGL"
- "dnvgl"
- "DNV-GL"
- "dnv-gl"
Buckling length factor in Eurocode safety check
Value must be greater or equal to 1.0 and lesser or equal to 100.0
Set of Frame3DD options used for tower analysis
Inclusion of shear area for symmetric sections
Inclusion of shear stiffening through axial loading
Eigenvalue solver 1=Subspace-Jacobi iteration, 2=Stodola (matrix iteration)
Must be one of:
- 1
- 2
Convergence tolerance for modal eigenvalue solution
Value must be greater or equal to 1e-12 and lesser or equal to 0.1
If False, then a monopile is modeled with a perfectly clamped foundation. If True, then spring-stiffness equivalents are computed from soil properties for all DOF.
Model the monopile base as a gravity-based foundation with no pile embedment
Number of Frame3DD element refinements for every specified section along tower/member
Number of legs for the jacket. Only used if type==jacket.
Number of bays for the jacket, or x-joints per tower leg pair. Only used if type==jacket.
If true, add a mud brace at the bottom of each jacket leg. Only used if type==jacket.
If true, save .pngs of the jacket truss during analysis or optimization. Jacket only.
Nikhar's method for modal identification
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Distance between turbines in the primary grid streamwise direction in rotor diameters
Value must be greater or equal to 1 and lesser or equal to 100
Distance between turbine rows in the cross-wind direction in rotor diameters
Value must be greater or equal to 1 and lesser or equal to 100
Distance from centroid of plant to substation in km
Value must be greater or equal to 0 and lesser or equal to 1000
Distance from substation to grid connection in km
Value must be greater or equal to 0 and lesser or equal to 1000
Distance from plant centroid to export cable landfall for offshore plants
Value must be greater or equal to 0 and lesser or equal to 1000
Distance from port to plant centroid for offshore plants
Value must be greater or equal to 0 and lesser or equal to 1000
Voltage of cabling to grid interconnection
Value must be greater or equal to 0 and lesser or equal to 1000
Additional contingency cost during project construction
Value must be greater or equal to 0 and lesser or equal to 10000.0
Additional insurance cost during project construction
Value must be greater or equal to 0 and lesser or equal to 10000.0
Additional financing cost during project construction
Value must be greater or equal to 0 and lesser or equal to 10000.0
Additional BOS cost to commission the turbines and wind farm
Value must be greater or equal to 0 and lesser or equal to 10000.0
Additional BOS cost to decommission the turbines and wind farm
Value must be greater or equal to 0 and lesser or equal to 10000.0
Monthly port rental fees
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Cost to secure site lease
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Cost to do engineering site assessment
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Cost for additional review by permitting agencies, such as the U.S. Dept of Interior Bureau of Ocean Energy Management (BOEM)
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Cost to do construction planning
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Cost to do installation planning
Value must be greater or equal to 0 and lesser or equal to 1000000000.0
Suppress screen output (currently only works for ORBIT)
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Hour of the day where any work-related activities begin.
Value must be greater or equal to 0 and lesser or equal to 24
Hour of the day where any work-related activities end.
Value must be greater or equal to 0 and lesser or equal to 24
Distance, in km, that servicing equipment must travel daily to reach the wind farm.
Value must be greater or equal to 0 and lesser or equal to 1000.0
Number of crew transfer vessels (offshore) or onsite trucks (land-based) that should be made available to the wind farm.
Value must be greater or equal to 1 and lesser or equal to 20
Number of heavy lift vessels (fixed-bottom offshore) or crawler cranes (land-based) that should be made available to the wind farm.
Value must be greater or equal to 1 and lesser or equal to 10
Number of tugboat groups that should be available to the port to tow floating turbines to port and back.
Value must be greater or equal to 1 and lesser or equal to 10
Hour of the day where any work-related activities begin for port-side repairs.
Value must be greater or equal to 0 and lesser or equal to 24
Hour of the day where any work-related activities end for port-side repairs.
Value must be greater or equal to 0 and lesser or equal to 24
Number of port-side crews available to work on simultaneous repairs for any at-port turbine.
Value must be greater or equal to 1 and lesser or equal to 100
Number of turbines that can be at port at once.
Value must be greater or equal to 1 and lesser or equal to 100
Distance, in km, that tugboats must travel to reach the wind farm for tow-to-port repairs.
Value must be greater or equal to 0 and lesser or equal to 1000.0
Starting date, in MM/DD format; year will be inserted automatically based on input to years.
Starting date, in MM/DD format, for an annual period where the site is inaccessible.
Ending date, in MM/DD format, for an annual period where the site is inaccessible.
Starting date, in MM/DD format, for an annual period where traveling speed is reduced.
Ending date, in MM/DD format, for an annual period where traveling speed is reduced.
Reduced speed applied to servicing equipment in the reduced speed period.
Value must be greater or equal to 0 and lesser or equal to 100
Random seed for the internal random generator.
Value must be greater or equal to 1 and lesser or equal to 4294967295
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Number of Frame3DD element refinements for every specified section along tower/member
Set of Frame3DD options used for floating tower analysis
Inclusion of shear area for symmetric sections
Inclusion of shear stiffening through axial loading
Eigenvalue solver 1=Subspace-Jacobi iteration, 2=Stodola (matrix iteration)
Must be one of:
- 1
- 2
Numerical matrix diagonal adder for eigenvalue solve of unrestrained structure
Convergence tolerance for modal eigenvalue solution
Value must be greater or equal to 1e-12 and lesser or equal to 0.1
If true, skip duplicate modes during identification
Partial safety factor on loads
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for materials
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for consequence of failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for buckling
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor on modal frequencies
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Partial safety factor for fatigue failure
Value must be greater or equal to 1.0 and lesser or equal to 5.0
Nikhar's method for modal identification
Whether or not to assume a symmetric mooring system
Data for a levelized cost of energy analysis.
Whether or not to run this module or pull from elastic properties
Must be one of:
- true
- false
- true
- false
- true
- false
- 0
- 1
- "user_elastic"
- "User_Elastic"
- "USER_ELASTIC"
Factor to model losses in annual energy production in a wind farm compared to the annual energy production at the turbine level (wakes mostly).
Value must be greater or equal to 0 and lesser or equal to 1
Fixed charge rate to compute the levelized cost of energy. See this for inspiration https://www.nrel.gov/docs/fy20osti/74598.pdf
Value must be greater or equal to 0 and lesser or equal to 1
Balance of stations costs expressed in USD per kW. See this for inspiration https://www.nrel.gov/docs/fy20osti/74598.pdf
Value must be greater or equal to 0 and lesser or equal to 10000
Operational expenditures expressed in USD per kW. See this for inspiration https://www.nrel.gov/docs/fy20osti/74598.pdf
Value must be greater or equal to 0 and lesser or equal to 1000
Number of turbines in the park, used to compute levelized cost of energy. Often wind parks are assumed of 600 MW. See this for inspiration https://www.nrel.gov/docs/fy20osti/74598.pdf
Value must be greater or equal to 0 and lesser or equal to 10000
Hourly loaded wage per worker including all benefits and overhead. This is currently only applied to steel, column structures.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Cost per unit area for finishing and surface treatments. This is currently only applied to steel, column structures.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Regression-based blade cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based hub cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based pitch system cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based spinner cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based low speed shaft cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based bearing cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based gearbox cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based cost of gearboxes based on torque, tuned in 2024
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Regression-based high speed side cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based generator cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based bedplate cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based yaw system cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based converter cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based transformer cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based HVAC system cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based nacelle cover cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based electrical plant connection cost/rating ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based nacelle platform cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based tower cost/mass ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Regression-based controller and sensor system cost/rating ratio
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
crane cost if present
Value must be greater or equal to 0.0 and lesser or equal to 1000000.0
Electricity price used to compute value in beyond lcoe metrics
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Reserve margin price used to compute value in beyond lcoe metrics
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Capacity credit used to compute value in beyond lcoe metrics
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Benchmark price used to nondimensionalize value in beyond lcoe metrics
Value must be greater or equal to 0.0 and lesser or equal to 1.0
This is only used if not running the full WISDEM turbine Group and you need to input the mass properties, forces, and moments for a tower-only analysis
Mass at external boundary of the system. For the tower, this would be the RNA mass.
Distance from system boundary to center of mass of the applied load. For the tower, this would be the RNA center of mass in tower-top coordinates.
No Additional ItemsEach item of this array must be:
Moment of inertia of external mass in coordinate system at the system boundary. For the tower, this would be the RNA MoI in tower-top coordinates.
No Additional ItemsEach item of this array must be:
The loading scenarios associated with the applied mass. For the tower, this would be operating, parked, etc.
No Additional ItemsEach item of this array must be:
Force vector applied at system boundary
No Additional ItemsEach item of this array must be:
Force vector applied at system boundary
No Additional ItemsEach item of this array must be:
Applied wind reference velocity, if necessary
Options for WEIS fidelity level 1 = frequency domain (RAFT)
Whether or not to run WEIS fidelity level 1 = frequency domain (RAFT)
Minimum frequency to evaluate (frequencies will be minfreq:minfreq:max_freq)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Maximum frequency to evaluate (frequencies will be minfreq:minfreq:max_freq)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Enable intersection mesh for potential BEM modeling. 0 = no intersection mesh, 1 = intersection mesh; turn on plot_design option for visualizing the mesh.
Must be one of:
- 0
- 1
Minimum characteristic length of the mesh for potential BEM modeling.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Maximum characteristic length of the mesh for potential BEM modeling. This is the dominant length scale for the mesh.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Initial amplitude of each DOF for all frequencies
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of iterations to solve dynamics
Value must be greater or equal to 1 and lesser or equal to 100
Maximum node splitting section amount
Value must be greater or equal to 1 and lesser or equal to 100
lowest frequency and frequency interval to use in BEM analysis
Value must be greater or equal to 0.0 and lesser or equal to 2.0
Use RAFT to trim ballast so that average heave is near 0 (0 - no trim, 1 - adjust compartment fill values, 2 - adjust ballast density, recommended for now)
Heave tolerance for trim_ballast
Value must be greater or equal to 0
Save RAFT design iterations in <outputs>/raft_designs
Plot RAFT design iterations in <outputs>/raft_designs
Flag to run pyHAMS
Options for WEIS fidelity level 3 = nonlinear time domain
Whether or not to run WEIS fidelity level 3 = nonlinear time domain (Linearize OpenFAST)
Echo input data to '<RootName>.ech' (flag)
Error level when simulation should abort (string) {'WARNING', 'SEVERE', 'FATAL'}
Must be one of:
- "WARNING"
- "SEVERE"
- "FATAL"
Integration time step (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Interpolation order for input/output time history (-) {1=linear, 2=quadratic}
Must be one of:
- "1"
- "2"
- "linear"
- "Linear"
- "LINEAR"
- "quadratic"
- "Quadratic"
- "QUADRATIC"
Number of correction iterations (-) {0=explicit calculation, i.e., no corrections}
Value must be greater or equal to 0 and lesser or equal to 10
Time between calls to get Jacobians (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Scaling factor used in Jacobians (-)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Compute structural dynamics (switch) {1=ElastoDyn; 2=ElastoDyn + BeamDyn for blades}
Must be one of:
- 0
- 1
- 2
Compute inflow wind velocities (switch) {0=still air; 1=InflowWind; 2=external from OpenFOAM}
Must be one of:
- 0
- 1
- 2
Compute aerodynamic loads (switch) {0=None; 1=AeroDyn v14; 2=AeroDyn v15}
Must be one of:
- 0
- 1
- 2
Compute control and electrical-drive dynamics (switch) {0=None; 1=ServoDyn}
Must be one of:
- 0
- 1
Compute sea state information (switch) {0=None; 1=SeaState}
Must be one of:
- 0
- 1
Compute hydrodynamic loads (switch) {0=None; 1=HydroDyn}
Must be one of:
- 0
- 1
Compute sub-structural dynamics (switch) {0=None; 1=SubDyn; 2=External Platform MCKF}
Must be one of:
- 0
- 1
- 2
Compute mooring system (switch) {0=None; 1=MAP++; 2=FEAMooring; 3=MoorDyn; 4=OrcaFlex}
Must be one of:
- 0
- 1
- 2
- 3
- 4
Compute ice loads (switch) {0=None; 1=IceFloe; 2=IceDyn}
Must be one of:
- 0
- 1
- 2
MHK turbine type (switch) {0=Not an MHK turbine; 1=Fixed MHK turbine; 2=Floating MHK turbine}
Must be one of:
- 0
- 1
- 2
Gravitational acceleration (m/s^2)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Air density (kg/m^3)
Water density (kg/m^3)
Kinematic viscosity of working fluid (m^2/s)
Speed of sound in working fluid (m/s)
Atmospheric pressure (Pa) [used only for an MHK turbine cavitation check]
Vapour pressure of working fluid (Pa) [used only for an MHK turbine cavitation check]
Water depth (m)
Offset between still-water level and mean sea level (m) [positive upward]
Name of file containing ElastoDyn input parameters (quoted string)
Name of file containing BeamDyn input parameters for blade 1 (quoted string)
Name of file containing BeamDyn input parameters for blade 2 (quoted string)
Name of file containing BeamDyn input parameters for blade 3 (quoted string)
Name of file containing inflow wind input parameters (quoted string)
Name of file containing aerodynamic input parameters (quoted string)
Name of file containing control and electrical-drive input parameters (quoted string)
Name of file containing sea state input parameters (quoted string)
Name of file containing hydrodynamic input parameters (quoted string)
Name of file containing sub-structural input parameters (quoted string)
Name of file containing mooring system input parameters (quoted string)
Name of file containing ice input parameters (quoted string)
Print summary data to '<RootName>.sum' (flag)
Amount of time between screen status messages (s)
Value must be greater or equal to 0.01 and lesser or equal to 1000.0
Amount of time between creating checkpoint files for potential restart (s)
Value must be greater or equal to 0.01 and lesser or equal to 1000000.0
Time step for tabular output (s) (or 'default')
Format for tabular (time-marching) output file (switch) {1 text file [<RootName>.out], 2 binary file [<RootName>.outb], 3 both}
Must be one of:
- 0
- 1
- 2
- 3
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Linearization analysis (flag)
Calculate a steady-state periodic operating point before linearization [unused if Linearize=False] (flag)
Controller parameter to be trimmed {1:yaw; 2:torque; 3:pitch} [used only if CalcSteady=True] (-)
Must be one of:
- "1"
- "2"
- "3"
- "yaw"
- "Yaw"
- "YAW"
- "torque"
- "Torque"
- "TORQUE"
- "pitch"
- "Pitch"
- "PITCH"
Tolerance for the rotational speed convergence [used only if CalcSteady=True] (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Proportional gain for the rotational speed error (>0) [used only if CalcSteady=True] (rad/(rad/s) for yaw or pitch; Nm/(rad/s) for torque)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Damping factor for the tower [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Damping factor for the blades [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Number of times to linearize (-) [>=1] [unused if Linearize=False]
Value must be greater or equal to 0 and lesser or equal to 10
List of times at which to linearize (s) [1 to NLinTimes] [used only when Linearize=True and CalcSteady=False]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Inputs included in linearization (switch) {0=none; 1=standard; 2=all module inputs (debug)} [unused if Linearize=False]
Must be one of:
- "0"
- "1"
- "2"
- "none"
- "None"
- "NONE"
- "standard"
- "Standard"
- "STANDARD"
- "all"
- "All"
- "ALL"
Outputs included in linearization (switch) {0=none; 1=from OutList(s); 2=all module outputs (debug)} [unused if Linearize=False]
Must be one of:
- "0"
- "1"
- "2"
- "none"
- "None"
- "NONE"
- "standard"
- "Standard"
- "STANDARD"
- "all"
- "All"
- "ALL"
Include full Jacobians in linearization output (for debug) (flag) [unused if Linearize=False; used only if LinInputs=LinOutputs=2]
Write module-level linearization output files in addition to output for full system (flag) [unused if Linearize=False]
VTK visualization data output (switch) {0=none; 1=initialization data only; 2=animation}
Must be one of:
- 0
- 1
- 2
Type of VTK visualization data (switch) {1=surfaces; 2=basic meshes (lines/points); 3=all meshes (debug)} [unused if WrVTK=0]
Must be one of:
- 1
- 2
- 3
Write mesh fields to VTK data files (flag) {true/false} [unused if WrVTK=0]
Frame rate for VTK output (frames per second){will use closest integer multiple of DT} [used only if WrVTK=2]
Value must be greater or equal to 0.0
Echo input data to '<RootName>.ech' (flag)
Switch for wind file type (1=steady; 2=uniform; 3=binary TurbSim FF; 4=binary Bladed-style FF; 5=HAWC format; 6=User defined; 7=native Bladed FF)
Must be one of:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Direction of wind propagation (meteoroligical rotation from aligned with X (positive rotates towards -Y) -- degrees)
Value must be greater or equal to 0.0 and lesser or equal to 360.0
Upflow angle (degrees) (not used for native Bladed format WindType=7)
Value must be greater or equal to -90.0 and lesser or equal to 90.0
Use cubic interpolation for velocity in time (false=linear, true=cubic) [Used with WindType=2,3,4,5,7]
Number of points to output the wind velocity (0 to 9)
Value must be greater or equal to 0 and lesser or equal to 9
Horizontal windspeed, for WindType = 1
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Power law exponent (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Filename of time series data for uniform wind field [used only for WindType = 2]
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference length for linear horizontal and vertical sheer (-) [used only for WindType = 2]
Value must be greater or equal to 1e-06 and lesser or equal to 1000.0
Name of the Full field wind file to use (.bts) [used only for WindType = 3]
Rootname of the full-field wind file to use (.wnd, .sum) [used only for WindType = 4]
Have tower file (.twr) (flag) [used only for WindType = 4]
Name of the file containing the u-component fluctuating wind (.bin) [Only used with WindType = 5]
Name of the file containing the v-component fluctuating wind (.bin) [Only used with WindType = 5]
Name of the file containing the w-component fluctuating wind (.bin) [Only used with WindType = 5]
Number of grids in the x direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Number of grids in the y direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Number of grids in the z direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Distance (in meters) between points in the x direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Distance (in meters) between points in the y direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Distance (in meters) between points in the z direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling method [0 = none, 1 = direct scaling, 2 = calculate scaling factor based on a desired standard deviation]
Must be one of:
- 0
- 1
- 2
Turbulence scaling factor for the x direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling factor for the y direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling factor for the z direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in x direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in y direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in z direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Mean u-component wind speed at the reference height (m/s) [HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Wind profile type (0=constant;1=logarithmic,2=power law)
Must be one of:
- 0
- 1
- 2
Power law exponent (-) (used for PL wind profile type only)[HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Surface roughness length (m) (used for LG wind profile type only)[HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Initial offset in +x direction (shift of wind box)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Print summary data to '<RootName>.sum' (flag)
Switch for lidar configuration (0 = None, 1 = Single Point Beam(s), 2 = Continuous, 3 = Pulsed)
Must be one of:
- 0
- 1
- 2
- 3
Number of lidar measurement gates (used when SensorType = 3)
Distance between range gates (m) (used when SensorType = 3)
Number of lidar measurement beams (0-5)(used when SensorType = 1)
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
Focal distance coordinates of the lidar beam in the x direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsFocal distance coordinates of the lidar beam in the y direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsFocal distance coordinates of the lidar beam in the z direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsOffset of the lidar from hub height (m)
No Additional ItemsEach item of this array must be:
Reference average wind speed for the lidar [m/s]
Value must be greater or equal to 0.0
Time between each measurement [s]
Value must be greater or equal to 0.0
TRUE => return radial component, FALSE => return 'x' direction estimate
Flag whether to consider the hub motion's impact on Lidar measurements
Whether or not to run AeroDyn
Echo input data to '<RootName>.ech' (flag)
Time interval for aerodynamic calculations. Set it to 0. for default (same as main fst)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Type of wake/induction model (switch) {0=none, 1=BEMT, 3=OLAF}
Must be one of:
- 0
- 1
- 2
- 3
- 11
- 12
- 13
Type of blade airfoil aerodynamics model (switch) {1=steady model, 2=Beddoes-Leishman unsteady model} [must be 1 when linearizing]
Must be one of:
- 0
- 1
- 2
Type tower influence on wind based on potential flow around the tower (switch) {0=none, 1=baseline potential flow, 2=potential flow with Bak correction}
Must be one of:
- 0
- 1
- 2
Calculate tower influence on wind based on downstream tower shadow (switch) {0=none, 1=Powles model, 2=Eames model}
Must be one of:
- 0
- 1
- 2
Calculate tower aerodynamic loads (flag)
Assume frozen wake during linearization (flag) [used only when Wake_Mod=1 and when linearizing]
Perform cavitation check (flag) TRUE will turn off unsteady aerodynamics
Include buoyancy effects (flag)
Include Nacelle Drag effects (flag)
Flag to compute AeroAcoustics calculation [only used when Wake_Mod=1 or 2]
Aeroacoustics input file
BEM model {1=legacy NoSweepPitchTwist, 2=polar} (switch) [used for all Wake_Mod to determine output coordinate system]
Must be one of:
- 1
- 2
Type of skewed-wake correction model (switch) {1=uncoupled, 2=Pitt/Peters, 3=coupled} [used only when Wake_Mod=1]
Must be one of:
- 1
- 2
- 3
Skew model {0=No skew model, -1=Remove non-normal component for linearization, 1=skew model active}
Must be one of:
- -1
- 0
- 1
Turn the skew momentum correction on or off [used only when Skew_Mod=1]
Type of skewed-wake correction model (switch) {0=no redistribution, 1=Glauert/Pitt/Peters} [used only when Skew_Mod=1]
Must be one of:
- 0
- 1
Constant used in Pitt/Peters skewed wake model {or 'default' is 15/32*pi} (-) [used only when SkewMod=1 and SkewRedistrMod=1]
Constant used in Pitt/Peters skewed wake model {or 'default' is 15/32*pi} (-) [used only when SkewMod=2; unused when Wake_Mod=0]
Use the Prandtl tip-loss model (flag) [used only when Wake_Mod=1]
Use the Prandtl hub-loss model (flag) [used only when Wake_Mod=1]
Include tangential induction in BEMT calculations (flag) [used only when Wake_Mod=1]
Include the drag term in the axial-induction calculation (flag) [used only when Wake_Mod=1]
Include the drag term in the tangential-induction calculation (flag) [used only when Wake_Mod=1 and TanInd=TRUE]
Convergence tolerance for BEMT nonlinear solve residual equation {or 0.0 for default} (-) [used only when Wake_Mod=1]
Maximum number of iteration steps (-) [used only when Wake_Mod=1]
Use sector averaging (flag)
Weighting function for sector average {1=Uniform, default=1} within a sector centered on the blade (switch) [used only when SectAvg=True]
Must be one of:
- 1
Number of points per sectors (-) {default=5} [used only when SectAvg=True]
Backward azimuth relative to blade where the sector starts (<=0) {default=-60} (deg) [used only when SectAvg=True]
Forward azimuth relative to blade where the sector ends (>=0) {default=60} (deg) [used only when SectAvg=True]
Type of dynamic BEMT (DBEMT) model {0=No Dynamic Wake, -1=Frozen Wake for linearization, 1:constant tau1, 2=time-dependent tau1, 3=constant tau1 with continuous formulation} (-)
Must be one of:
- -1
- 0
- 1
- 2
- 3
Time constant for DBEMT (s) [used only when WakeMod=2 and DBEMTMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Input file for OLAF [used only when Wake_Mod=3]
Integration method 1 RK4, 5 Forward Euler 1st order, default 5 switch
Time interval for wake propagation. {default dtaero} (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Time when wake is free. (-) value = always free. {default 0.0} (s)
Time at which full circulation is reached. {default 0.0} (s)
Circulation solving method {1 Cl-Based, 2 No-Flow Through, 3 Prescribed, default 1 }(switch)
Convergence criteria {default 0.001} [only if CircSolvMethod=1] (-)
Relaxation factor {default 0.1} [only if CircSolvMethod=1] (-)
Maximum number of iterations for circulation solving {default 30} (-)
File containing prescribed circulation [only if CircSolvMethod=3] (quoted string)
Number of near-wake panels [integer] (-)
Value must be greater or equal to 0
Number of free near-wake panels (-) {default nNWPanels}
Value must be greater or equal to 0
Number of far-wake panels (-) {default 0}
Value must be greater or equal to 0
Number of free far-wake panels (-) {default nFWPanels}
Value must be greater or equal to 0
Include shed vorticity in the far wake {default false}
Diffusion method to account for viscous effects {0 None, 1 Core Spreading, 'default' 0}
Method to determine the regularization parameters {0 Manual, 1 Optimized, 2 chord, 3 span default 0 }
Viscous diffusion function {0 None, 1 Rankine, 2 LambOseen, 3 Vatistas, 4 Denominator, 'default' 3} (switch)
Wake regularization method {1 Constant, 2 Stretching, 3 Age, default 1} (switch)
Wake regularization factor (m)
Wing regularization factor (m)
Eddy viscosity in core spreading methods, typical values 1-1000
Include tower flow disturbance effects on wake convection {default:false} [only if TwrPotent or TwrShadow]
Shear Model {0 No treatment, 1 Mirrored vorticity, default 0}
Method to determine the velocity {1Biot-Savart Segment, 2Particle tree, default 1}
Branch radius fraction above which a multipole calculation is used {default 2.0} [only if VelocityMethod=2]
Value must be greater or equal to 0.0
Number of particles per segment [only if VelocityMethod=2]
Value must be greater or equal to 0
Outputs Visualization Toolkit (VTK) (independent of .fst option) {0 NoVTK, 1 Write VTK at each time step} (flag)
Number of blades for which VTK files are exported {0 No VTK per blade, n VTK for blade 1 to n} (-)
Coordinate system used for VTK export. {1 Global, 2 Hub, 3 Both, 'default' 1}
Frame rate for VTK output (frames per second) {"all" for all glue code timesteps, "default" for all OLAF timesteps} [used only if WrVTK=1]
(GB DEBUG 7/8) Number of grid points for VTK output
Sample the angle of attack (AoA) at the 3/4 chord or the AC point {default=True} [always used]
Unsteady Aero Model Switch (switch) {1=Baseline model (Original), 2=Gonzalez's variant (changes in Cn,Cc,Cm), 3=Minemma/Pierce variant (changes in Cc and Cm)} [used only when AFAeroMod=2]
Must be one of:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Unsteady Aero Model Switch (switch) {0=Quasi-steady (no UA), 2=B-L Gonzalez, 3=B-L Minnema/Pierce, 4=B-L HGM 4-states, 5=B-L HGM+vortex 5 states, 6=Oye, 7=Boeing-Vertol}
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Flag to indicate whether a lookup for f' will be calculated (TRUE) or whether best-fit exponential equations will be used (FALSE); if FALSE S1-S4 must be provided in airfoil input files (flag) [used only when AFAeroMod=2]
Switch to indicate which integration method UA uses (1=RK4, 2=AB4, 3=ABM4, 4=BDF2)
Must be one of:
- 1
- 2
- 3
- 4
Starting radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Ending radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Interpolation method for multiple airfoil tables {1=1D interpolation on AoA (first table only); 2=2D interpolation on AoA and Re; 3=2D interpolation on AoA and UserProp} (-)
Must be one of:
- 1
- 2
- 3
The column in the airfoil tables that contains the angle of attack (-)
The column in the airfoil tables that contains the lift coefficient (-)
The column in the airfoil tables that contains the drag coefficient (-)
The column in the airfoil tables that contains the pitching-moment coefficient; use zero if there is no Cm column (-)
The column in the airfoil tables that contains the Cpmin coefficient; use zero if there is no Cpmin column (-)
Include aerodynamic pitching moment in calculations (flag)
Hub volume (m^3)
Value must be greater or equal to 0.0
Hub center of buoyancy x direction offset (m)
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Nacelle volume (m^3)
Value must be greater or equal to 0.0
Position of nacelle center of buoyancy from yaw bearing in nacelle coordinates (m)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Projected area of the nacelle in X, Y, Z in the nacelle coordinate system (m^2)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Drag coefficient for the nacelle areas defined above (-)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Position of aerodynamic center of nacelle drag in nacelle coordinates (m)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Calculate tail fin aerodynamics model (flag)
Input file for tail fin aerodynamics [used only when TFinAero=True]
Atmospheric pressure (Pa) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Vapour pressure of fluid (Pa) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Water depth above mid-hub height (m) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Turbulence intensity used in the Eames tower shadow model. Values of TwrTI between 0.05 and 0.4 are recommended.
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Turbulence buoyancy coefficient
Print summary data to '<RootName>.sum' (flag)
Echo input data to '<RootName>.ech' (flag)
Must be one of:
- "1"
- "2"
- "3"
- "RK4"
- "AB4"
- "ABM4"
Integration time step, 0.0 for default (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
First flapwise blade mode DOF (flag)
Second flapwise blade mode DOF (flag)
First edgewise blade mode DOF (flag)
Rotor-teeter DOF (flag) [unused for 3 blades]
Drivetrain rotational-flexibility DOF (flag)
Generator DOF (flag)
Yaw DOF (flag)
First fore-aft tower bending-mode DOF (flag)
Second fore-aft tower bending-mode DOF (flag)
First side-to-side tower bending-mode DOF (flag)
Second side-to-side tower bending-mode DOF (flag)
Platform horizontal surge translation DOF (flag)
Platform horizontal sway translation DOF (flag)
Platform vertical heave translation DOF (flag)
Platform roll tilt rotation DOF (flag)
Platform pitch tilt rotation DOF (flag)
Platform yaw rotation DOF (flag)
Initial out-of-plane blade-tip displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial in-plane blade-tip deflection (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade 1 initial pitch (radians)
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Blade 2 initial pitch (radians)
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Blade 3 initial pitch (radians) [unused for 2 blades]
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Initial or fixed teeter angle (radians) [unused for 3 blades]
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Initial azimuth angle for blade 1 (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed rotor speed (rpm)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed nacelle-yaw angle (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial fore-aft tower-top displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 50.0
Initial side-to-side tower-top displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 50.0
Initial or fixed horizontal surge translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed horizontal sway translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed vertical heave translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed roll tilt rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed pitch tilt rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed yaw rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Undersling length [distance from teeter pin to the rotor apex] (meters) [unused for 3 blades]
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Delta-3 angle for teetering rotors (degrees) [unused for 3 blades]
Value must be greater or equal to -30.0 and lesser or equal to 30.0
Azimuth value to use for I/O when blade 1 points up (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Distance from rotor apex [3 blades] or teeter pin [2 blades] to shaft strain gages [positive for upwind rotors] (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Downwind distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Lateral distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Vertical distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Number of blade nodes (per blade) used for analysis (-)
Value must be greater or equal to 10 and lesser or equal to 200
Rotor-teeter spring/damper model {0: none, 1: standard, 2: user-defined from routine UserTeet} (switch) [unused for 3 blades]
Must be one of:
- 0
- 1
- 2
Rotor-teeter damper position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter damping constant (N-m/(rad/s)) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter rate-independent Coulomb-damping moment (N-m) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter soft-stop position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter hard-stop position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter soft-stop linear-spring constant (N-m/rad) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter hard-stop linear-spring constant (N-m/rad) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Yaw-friction model {0: none, 1: friction independent of yaw-bearing force and bending moment, 2: friction with Coulomb terms depending on yaw-bearing force and bending moment, 3: user defined model} (switch)
Must be one of:
- 0
- 1
- 2
Maximum static Coulomb friction torque (N-m) [MCSmax when YawFrctMod=1; |Fz|*MCSmax when YawFrctMod=2 and Fz<0]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Maximum static Coulomb friction torque proportional to yaw bearing shear force (N-m) [sqrt(Fx^2+Fy^2)*M_FCSmax; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Maximum static Coulomb friction torque proportional to yaw bearing bending moment (N-m) [sqrt(Mx^2+My^2)*M_MCSmax; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment (N-m) [MCD when YawFrctMod=1; |Fz|*MCD when YawFrctMod=2 and Fz<0]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment proportional to yaw bearing shear force (N-m) [sqrt(Fx^2+Fy^2)*M_FCD; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment proportional to yaw bearing bending moment (N-m) [sqrt(Mx^2+My^2)*M_MCD; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Linear viscous friction coefficient (N-m/(rad/s))
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Quadratic viscous friction coefficient (N-m/(rad/s)^2)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Yaw angular velocity cutoff below which viscous friction is linearized (rad/s)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Read in additional model properties for furling turbine (flag) [must currently be FALSE)
Name of file containing furling properties (quoted string) [unused when Furling=False]
Number of tower nodes used for analysis (-)
Value must be greater or equal to 10 and lesser or equal to 200
Print summary data to '<RootName>.sum' (flag)
Switch to determine where output will be placed 1 in module output file only; 2 in glue code output file only; 3 both (currently unused)
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Decimation factor for tabular output 1 output every time step} (-) (currently unused)
Time to begin tabular output (s) (currently unused)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Blade flap mode 1 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flap mode 2 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade edge mode 1 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade mass density (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade flap stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade edge stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 1st fore-aft mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 2nd fore-aft mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 1st side-to-side mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 2nd side-to-side mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower fore-aft modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower fore-aft modal stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower side-to-side stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower side-to-side stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower mass density (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower fore-aft stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower side-to-side stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Echo input data to '<RootName>.ech' (flag)
Use quasistatic pre-conditioning with centripetal accelerations in initialization (flag) [dynamic solve only]
Numerical damping parameter for generalized-alpha integrator
Value must be greater or equal to 0.0 and lesser or equal to 10000000000.0
Quadrature method: 1=Gaussian; 2=Trapezoidal (switch)
Must be one of:
- 1
- 2
Refinement factor for trapezoidal quadrature (-). DEFAULT = 1 [used only when quadrature=2]
Value must be greater or equal to 1 and lesser or equal to 10
Factorization frequency (-). DEFAULT = 5
Value must be greater or equal to 1 and lesser or equal to 50
Time step size (s). Use 0.0 for Default
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Number of factored load retries before quitting the simulation. Use 0 for Default
Value must be greater or equal to 0 and lesser or equal to 50
Max number of iterations in Newton-Ralphson algorithm (-). DEFAULT = 10
Value must be greater or equal to 1 and lesser or equal to 100
Tolerance for stopping criterion (-) [DEFAULT = 1E-5]
Value must be greater or equal to 1e-16 and lesser or equal to 1e+16
Flag to use finite differenced tangent stiffness matrix (-)
Flag to compare analytical finite differenced tangent stiffness matrix (-)
perturbation size for finite differencing (-). Use 0.0 for DEFAULT
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Maximum allowable relative difference between analytical and fd tangent stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Orient states in the rotating frame during linearization (flag) [used only when linearizing]
Order of interpolation (basis) function (-)
Value must be greater or equal to 0 and lesser or equal to 50
Whether a pitch actuator should be used (flag)
Pitch actuator inertia (kg-m^2) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Pitch actuator stiffness (kg-m^2/s^2) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Pitch actuator damping (kg-m^2/s) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Print summary data to '<RootName>.sum' (flag)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Number of nodes to output to file [0 - 9] (-)
Value must be greater or equal to 0 and lesser or equal to 9
Nodes whose values will be output (-)
No Additional ItemsDamping type, 0 no damping; 1 damped
Must be one of:
- 0
- 1
Stiffness proportional damping coefficient in shear x direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in shear y direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in axial z direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in edgewise bending (around x). mu4 is often assumed equal to mu2.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in flapwise bending (around y). mu5 is often assumed equal to mu1.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in torsional direction (around z). mu6 is often assumed equal to mu3.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Echo input data to '<RootName>.ech' (flag)
Potential-flow model {0 = none=no potential flow, 1 = frequency-to-time-domain transforms based on Capytaine/NEMOH/WAMIT output, 2 = fluid-impulse theory (FIT)} (switch)
Must be one of:
- 0
- 1
- 2
Wave Excitation model {0 = None, 1 = DFT, 2 = state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ssexctn INPUT FILE]
Must be one of:
- 0
- 1
- 2
Method of computing Wave Excitation {0: use undisplaced position, 1: use displaced position, 2: use low-pass filtered displaced position) [only used when PotMod=1 and ExctnMod>0 and SeaStates WaveMod>0]} (switch)
Must be one of:
- 0
- 1
- 2
Cutoff (corner) frequency of the low-pass time-filtered displaced position (Hz) [>0.0] [used only when PotMod=1, ExctnMod>0, and ExctnDisp=2]) [only used when PotMod=1 and ExctnMod>0 and SeaState's WaveMod>0]} (switch)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Model for large platform yaw offset {0: Static reference yaw offset based on PtfmRefY, 1: dynamic reference yaw offset based on low-pass filtering the PRP yaw motion with cutoff frequency PtfmYCutOff} (switch)
Must be one of:
- 0
- 1
Constant (if PtfmYMod=0) or initial (if PtfmYMod=1) platform reference yaw offset (deg)
Cutoff frequency for the low-pass filtering of PRP yaw motion when PtfmYMod=1 [unused when PtfmYMod=0] (Hz)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of evenly distributed platform yaw/heading angles over the range of [-180, 180) deg for which the wave excitation shall be computed [only used when PtfmYMod=1] (-)
Value must be greater or equal to 1 and lesser or equal to 360
Radiation memory-effect model {0 = no memory-effect calculation, 1 = convolution, 2 = state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ss INPUT FILE]
Must be one of:
- 0
- 1
- 2
Analysis time for wave radiation kernel calculations (sec) [only used when PotMod=1; determines RdtnDOmega=Pi/RdtnTMax in the cosine transform; MAKE SURE THIS IS LONG ENOUGH FOR THE RADIATION IMPULSE RESPONSE FUNCTIONS TO DECAY TO NEAR-ZERO FOR THE GIVEN PLATFORM!]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Time step for wave radiation kernel calculations, use 0.0 for default (sec) [only used when PotMod=1; DT<=RdtnDT<=0.1 recommended; determines RdtnOmegaMax=Pi/RdtnDT in the cosine transform]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of WAMIT bodies to be used (-) [>=1; only used when PotMod=1. If NBodyMod=1, the WAMIT data contains a vector of size 6NBody x 1 and matrices of size 6NBody x 6*NBody; if NBodyMod>1, there are NBody sets of WAMIT data each with a vector of size 6 x 1 and matrices of size 6 x 6]
Value must be greater or equal to 1 and lesser or equal to 100
Body coupling model {1: include coupling terms between each body and NBody in HydroDyn equals NBODY in WAMIT, 2: neglect coupling terms between each body and NBODY=1 with XBODY=0 in WAMIT, 3: Neglect coupling terms between each body and NBODY=1 with XBODY=/0 in WAMIT} (switch) [only used when PotMod=1]
Must be one of:
- 1
- 2
- 3
Will be automatically filled in with HAMS output unless a value here overrides it; WAMIT output files containing the linear, nondimensionalized, hydrostatic restoring matrix (.hst), frequency-dependent hydrodynamic added mass matrix and damping matrix (.1), and frequency- and direction-dependent wave excitation force vector per unit wave amplitude (.3) (quoted string) [MAKE SURE THE FREQUENCIES INHERENT IN THESE WAMIT FILES SPAN THE PHYSICALLY-SIGNIFICANT RANGE OF FREQUENCIES FOR THE GIVEN PLATFORM; THEY MUST CONTAIN THE ZERO- AND INFINITE-FREQUENCY LIMITS]
Characteristic body length scale used to redimensionalize WAMIT output (meters) [1 to NBody if NBodyMod>1] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The xt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The yt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The zt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1. If NBodyMod=2,PtfmRefzt=0.0]
No Additional ItemsEach item of this array must be:
The rotation about zt of the body reference frame(s) from xt/yt (degrees) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
Displaced volume of water when the body is in its undisplaced position (m^3) [1 to NBody] [only used when PotMod=1; USE THE SAME VALUE COMPUTED BY WAMIT AS OUTPUT IN THE .OUT FILE!]
No Additional ItemsEach item of this array must be:
The xt offset of the center of buoyancy (COB) from the platform reference point (meters) [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The yt offset of the center of buoyancy (COB) from the platform reference point (meters) [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
Mean-drift 2nd-order forces computed {0 = None; [7, 8, 9, 10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero]
Must be one of:
- 0
- 7
- 8
- 9
- 10
- 11
- 12
Mean- and slow-drift 2nd-order forces computed with Newman's approximation {0 = None; [7, 8, 9, 10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero. Used only when WaveDirMod=0]
Must be one of:
- 0
- 7
- 8
- 9
- 10
- 11
- 12
Full difference-frequency 2nd-order forces computed with full QTF {0 = None; [10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero]
Must be one of:
- 0
- 10
- 11
- 12
Full summation -frequency 2nd-order forces computed with full QTF {0 = None; [10, 11, or 12] = WAMIT file to use}
Must be one of:
- 0
- 10
- 11
- 12
Additional preload (N, N-m)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Method of computing Wave Kinematics {0: use undisplaced position, 1: use displaced position) } (switch)
Must be one of:
- 0
- 1
Method of computing distributed added-mass force. (0: Only and always on nodes below SWL at the undisplaced position. 2: Up to the instantaneous free surface) [overwrite to 0 when WaveMod = 0 or 6 or when WaveStMod = 0 in SeaState]
Must be one of:
- 0
- 2
Number of member outputs (-) [must be < 10]
Value must be greater or equal to 0 and lesser or equal to 9
Number of joint outputs [Must be < 10]
Value must be greater or equal to 0 and lesser or equal to 9
List of JointIDs which are to be output (-)[unused if NJOutputs=0]
No Additional ItemsEach item of this array must be:
Output a summary file [flag]
Output all user-specified member and joint loads (only at each member end, not interior locations) [flag]
Output requested channels to [1=Hydrodyn.out, 2=GlueCode.out, 3=both files]
Must be one of:
- 1
- 2
- 3
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings (quoted string) [not checked for validity]
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 0.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 0.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Echo input data to '<RootName>.ech' (flag)
Local Integration Step. If 0.0, the glue-code integration step will be used.
Value must be lesser or equal to 100.0
Integration Method [1/2/3/4 = RK4/AB4/ABM4/AM2].
Must be one of:
- 1
- 2
- 3
- 4
Solve dynamics about static equilibrium point
Include extra moment from lever arm at interface and rotate FEM for floating.
FEM switch = element model in the FEM. [1= Euler-Bernoulli(E-B); 2=Tapered E-B (unavailable); 3= 2-node Timoshenko; 4= 2-node tapered Timoshenko (unavailable)]
Must be one of:
- 1
- 2
- 3
- 4
Number of sub-elements per member
Value must be greater or equal to 1 and lesser or equal to 100
If True perform C-B reduction, else full FEM dofs will be retained. If True, select Nmodes to retain in C-B reduced system.
Number of internal modes to retain (ignored if CBMod=False). If Nmodes=0 --> Guyan Reduction.
Value must be greater or equal to 0 and lesser or equal to 50
Damping Ratios for each retained mode (% of critical) If Nmodes>0, list Nmodes structural damping ratios for each retained mode (% of critical), or a single damping ratio to be applied to all retained modes. (last entered value will be used for all remaining modes).
No Additional ItemsEach item of this array must be:
Guyan damping {0=none, 1=Rayleigh Damping, 2=user specified 6x6 matrix}
Must be one of:
- 0
- 1
- 2
Mass and stiffness proportional damping coefficients (Rayleigh Damping) [only if GuyanDampMod=1]
No Additional ItemsEach item of this array must be:
Guyan damping matrix (6x6) [only if GuyanDampMod=2]
Value must be greater or equal to 0 and lesser or equal to 6
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Print summary data to '<RootName>.sum' (flag)
Output Guyan and Craig-Bampton modes {0 No output, 1 JSON output}, (flag)
Must be one of:
- 0
- 1
Output first 30 FEM modes {0 No output, 1 JSON output} (flag)
Must be one of:
- 0
- 1
Output cosine matrices with the selected output member forces (flag)
Output all members' end forces (flag)
Output requested channels to 1=<rootname>.SD.out; 2=<rootname>.out (generated by FAST); 3=both files.
Must be one of:
- 1
- 2
- 3
Generate a tab-delimited output in the <rootname>.SD.out file
Decimation of output in the <rootname>.SD.out file
Value must be greater or equal to 0
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings in the <rootname>.SD.out file (quoted string) [not checked for validity]
Number of members whose forces/displacements/velocities/accelerations will be output (-) [Must be <= 9].
Value must be greater or equal to 0 and lesser or equal to 9
Echo input data to '<RootName>.ech' (flag)
Time step to use in mooring integration (s)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Bottom stiffness (Pa/m)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Bottom damping (Pa/m)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Time interval for analyzing convergence during IC gen (s)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Max time for ic gen (s)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Factor by which to scale drag coefficients during dynamic relaxation (-)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Threshold for IC convergence (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
NumSegs in MoorDyn input for modeling mooring lines. If array, should match number of lines.
ServoDyn modelling options in OpenFAST
Echo input data to '<RootName>.ech' (flag)
Communication interval for controllers (s) (or 'default')
Pitch control mode {0 = none, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Time to enable active pitch control (s) [unused when PCMode=0]
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 1 and end standard pitch control (s)
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 2 and end standard pitch control (s)
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 3 and end standard pitch control (s)
Value must be greater or equal to 0.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 1 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 2 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 3 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Blade 1 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Blade 2 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Blade 3 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Variable-speed control mode {0 = none, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Generator model {1 = simple, 2 = Thevenin, 3 = user-defined from routine UserGen}
Must be one of:
- 1
- 2
Method to start the generator {True - timed using TimGenOn, False - generator speed using SpdGenOn} (flag)
Method to stop the generator {True - timed using TimGenOf, False - when generator power = 0} (flag)
Generator speed to turn on the generator for a startup (HSS speed) (rpm) [used only when GenTiStr=False]
Value must be greater or equal to 0.0
Time to turn on the generator for a startup (s) [used only when GenTiStr=True]
Value must be greater or equal to 0.0
Time to turn off the generator (s) [used only when GenTiStp=True]
Value must be greater or equal to 0.0
Rated generator speed for simple variable-speed generator control (HSS side) (rpm) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator torque/constant generator torque in Region 3 for simple variable-speed generator control (HSS side) (N-m) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Generator torque constant in Region 2 for simple variable-speed generator control (HSS side) (N-m/rpm^2) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator slip percentage in Region 2 1/2 for simple variable-speed generator control (%) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator slip percentage (%) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Synchronous (zero-torque) generator speed (rpm) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Rated torque (N-m) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Pull-out ratio (Tpullout/Trated) (-) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Line frequency [50 or 60] (Hz) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Number of poles [even integer > 0] (-) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0
Stator resistance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Rotor resistance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Line-to-line RMS voltage (volts) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Stator leakage reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Rotor leakage reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Magnetizing reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
HSS brake model {0 = none, 1 = simple, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL (not in ROSCO, yet)}
Must be one of:
- 0
- 1
- 4
- 5
Time to initiate deployment of the HSS brake (s)
Value must be greater or equal to 0.0
Time for HSS-brake to reach full deployment once initiated (sec) [used only when HSSBrMode=1]
Value must be greater or equal to 0.0
Fully deployed HSS-brake torque (N-m)
Value must be greater or equal to 0.0
Yaw control mode {0 - none, 3 - user-defined from routine UserYawCont, 4 - user-defined from Simulink/Labview, 5 - user-defined from Bladed-style DLL} (switch)
Must be one of:
- 0
- 3
- 4
- 5
Time to enable active yaw control (s) [unused when YCMode=0]
Neutral yaw position--yaw spring force is zero at this yaw (degrees)
Nacelle-yaw spring constant (N-m/rad)
Nacelle-yaw damping constant (N-m/(rad/s))
Time to start override yaw maneuver and end standard yaw control (s)
Yaw maneuver rate (in absolute value) (deg/s). It cannot be zero
Value must be greater or equal to 1e-06
Final yaw angle for override yaw maneuvers (degrees)
Airfoil control mode {0- none, 1- cosine wave cycle, 4- user-defined from Simulink/Labview, 5- user-defined from Bladed-style DLL}
Must be one of:
- 0
- 1
- 4
- 5
Mean level for sinusoidal cycling or steady value (-) [used only with AfCmode==1]
Amplitude for for cosine cycling of flap signal (AfC = AfCAmp*cos(Azimuth+phase)+AfCmean) (-) [used only with AfCmode==1]
AfC_phase - Phase relative to the blade azimuth (0 is vertical) for for cosine cycling of flap signal (deg) [used only with AfCmode==1]
Cable control mode {0- none, 4- user-defined from Simulink/Labview, 5- user-defineAfC_phased from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Compute nacelle tuned mass damper {true/false}
Name of the file for nacelle tuned mass damper (quoted string) [unused when CompNTMD is false]
Compute tower tuned mass damper {true/false}
Name of the file for tower tuned mass damper (quoted string) [unused when CompTTMD is false]
Name of procedure in DLL to be called (-) [case sensitive; used only with DLL Interface]
Communication interval for dynamic library (s) (or 'default') [used only with Bladed Interface]
Whether a linear ramp should be used between DLL_DT time steps [introduces time shift when true] (flag) [used only with Bladed Interface]
Cuttoff frequency for low-pass filter on blade pitch from DLL (Hz) [used only with Bladed Interface]
Reference yaw angle of the nacelle when the upwind end points due North (deg) [used only with Bladed Interface]
Record 28 Use individual pitch control {0 - collective pitch; 1 - individual pitch control} (switch) [used only with Bladed Interface]
Must be one of:
- 0
- 1
Record 5 Below-rated pitch angle set-point (deg) [used only with Bladed Interface]
Record 6 - Minimum pitch angle (deg) [used only with Bladed Interface]
Record 7 Maximum pitch angle (deg) [used only with Bladed Interface]
Record 8 Minimum pitch rate (most negative value allowed) (deg/s) [used only with Bladed Interface]
Record 9 Maximum pitch rate (deg/s) [used only with Bladed Interface]
Record 16 Optimal mode gain (Nm/(rad/s)^2) [used only with Bladed Interface]
Record 17 Minimum generator speed (rpm) [used only with Bladed Interface]
Record 18 Optimal mode maximum speed (rpm) [used only with Bladed Interface]
Record 19 Demanded generator speed above rated (rpm) [used only with Bladed Interface]
Record 22 Demanded generator torque above rated (Nm) [used only with Bladed Interface]
Record 13 Demanded power (W) [used only with Bladed Interface]
Record 26 No. of points in torque-speed look-up table {0 = none and use the optimal mode parameters; nonzero = ignore the optimal mode PARAMETERs by setting Record 16 to 0.0} (-) [used only with Bladed Interface]
Print summary data to '<RootName>.sum' (flag)
Switch to determine where output will be placed 1 in module output file only; 2 in glue code output file only; 3 both (currently unused)
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Time to begin tabular output (s) (currently unused)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
ServoDyn modelling options in OpenFAST
Echo the input file data (flag)
Water density (kg/m^3)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Water depth (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Offset between still-water level and mean sea level (meters) [positive upward; unused when WaveMod = 6; must be zero if PotMod=1 or 2]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Half-width of the domain in the X direction (m) [>0, NOTE: X[nX] = nX*dX, where nX = {-NX+1,-NX+2,…,NX-1} and dX = X_HalfWidth/(NX-1)]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Half-width of the domain in the Y direction (m) [>0, NOTE: Y[nY] = nY*dY, where nY = {-NY+1,-NY+2,…,NY-1} and dY = Y_HalfWidth/(NY-1)]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Depth of the domain the Z direction (m) relative to SWL [0 < Z_Depth <= WtrDpth+MSL2SWL;
Number of nodes in half of the X-direction domain (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Number of nodes in half of the Y-direction domain (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Number of nodes in the Z direction (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Incident wave kinematics model {0- none/still water, 1- regular (periodic), 1P#- regular with user-specified phase, 2- JONSWAP/Pierson-Moskowitz spectrum (irregular), 3- White noise spectrum (irregular), 4- user-defined spectrum from routine UserWaveSpctrm (irregular), 5- Externally generated wave-elevation time series, 6- Externally generated full wave-kinematics time series [option 6 is invalid for PotMod/=0]} (switch)
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
Model for stretching incident wave kinematics to instantaneous free surface {0 = none=no stretching, 1 = vertical stretching, 2 = extrapolation stretching, 3 = Wheeler stretching} (switch) [unused when WaveMod=0 or when PotMod/=0]
Must be one of:
- 0
- 1
- 2
- 3
Analysis time for incident wave calculations (sec) [unused when WaveMod=0; determines WaveDOmega=2Pi/WaveTMax in the IFFT]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Time step for incident wave calculations (sec) [unused when WaveMod=0; 0.1<=WaveDT<=1.0 recommended; determines WaveOmegaMax=Pi/WaveDT in the IFFT]
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Significant wave height of incident waves (meters) [used only when WaveMod=1 or 2]. These inputs will be determined by the DLCDriver options (waveheight).
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Peak spectral period of incident waves (sec) [used only when WaveMod=1 or 2]. These inputs will be determined by the DLCDriver options (waveperiod).
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Peak-shape parameter of incident wave spectrum (-) or DEFAULT (string) [used only when WaveMod=2; use 1.0 for Pierson-Moskowitz]. These inputs will be determined by the DLCDriver options (wavegamma).
Value must be greater or equal to 1 and lesser or equal to 7
Low cut-off frequency or lower frequency limit of the wave spectrum beyond which the wave spectrum is zeroed (rad/s) [unused when WaveMod=0, 1, or 6]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
High cut-off frequency or upper frequency limit of the wave spectrum beyond which the wave spectrum is zeroed (rad/s) [unused when WaveMod=0, 1, or 6]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Incident wave propagation heading direction [unused when WaveMod=0 or 6]. These inputs will be determined by the DLCDriver options (wavedirection).
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
Directional spreading function {0 = none, 1 = COS2S} [only used when WaveMod=2,3, or 4]
Must be one of:
- 0
- 1
Wave direction spreading coefficient ( > 0 ) [only used when WaveMod=2,3, or 4 and WaveDirMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Number of wave directions [only used when WaveMod=2,3, or 4 and WaveDirMod=1; odd number only]
Must be one of:
- 1
- 3
- 5
- 7
- 9
- 11
- 13
- 15
- 17
- 19
- 21
- 23
- 25
- 27
- 29
- 31
- 33
- 35
- 37
- 39
- 41
- 43
- 45
- 47
- 49
Range of wave directions (full range = WaveDir +/- 1/2*WaveDirRange) (degrees) [only used when WaveMod=2,3,or 4 and WaveDirMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 360
First random seed of incident waves [-2147483648 to 2147483647] [unused when WaveMod=0, 5, or 6]. These inputs will be determined by the DLCDriver options (waveseed).
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Second random seed of incident waves [-2147483648 to 2147483647] [unused when WaveMod=0, 5, or 6]. Use RANLUX for internal FAST pseudo-random number generator
Flag for normally distributed amplitudes [only used when WaveMod=2, 3, or 4]
Root name of externally generated wave data file(s) (quoted string) [used only when WaveMod=5 or 6]
Full difference-frequency 2nd-order wave kinematics (flag)
Full summation-frequency 2nd-order wave kinematics (flag)
Low frequency cutoff used in the difference-frequencies (rad/s) [Only used with a difference-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
High frequency cutoff used in the difference-frequencies (rad/s) [Only used with a difference-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Low frequency cutoff used in the summation-frequencies (rad/s) [Only used with a summation-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
High frequency cutoff used in the summation-frequencies (rad/s) [Only used with a summation-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Constrained wave model: 0=none; 1=Constrained wave with specified crest elevation, alpha; 2=Constrained wave with guaranteed peak-to-trough crest height, HCrest (flag)
Must be one of:
- 0
- 1
- 2
Crest height (2*alpha for ConstWaveMod=1 or HCrest for ConstWaveMod=2), must be larger than WaveHs (m) [unused when ConstWaveMod=0]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Time at which the crest appears (s) [unused when ConstWaveMod=0]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
X-position of the crest (m) [unused when ConstWaveMod=0]
Y-position of the crest (m) [unused when ConstWaveMod=0]
Current profile model {0 = none=no current, 1 = standard, 2 = user-defined from routine UserCurrent} (switch)
Must be one of:
- 0
- 1
- 2
Sub-surface current velocity at still water level (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Sub-surface current heading direction (radians) or 0.0 for default [used only when CurrMod=1]
Value must be lesser or equal to 6.283185307179586
Near-surface current reference depth (meters) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Near-surface current velocity at still water level (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Near-surface current heading direction (degrees) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
Depth-independent current velocity (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Depth-independent current heading direction (radians) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
MacCamy-Fuchs member radius (ignored if radius <= 0) [must be 0 when WaveMod 0 or 6]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Output a summary file [flag]
Output requested channels to: [1=SeaState.out, 2=GlueCode.out, 3=both files]
Must be one of:
- 1
- 2
- 3
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings (quoted string) [not checked for validity!]
Number of points where the incident wave elevations can be computed (-) [maximum of 9 output locations]
Value must be greater or equal to 0 and lesser or equal to 9
List of xi-coordinates for points where the incident wave elevations can be output (meters) [NWaveElev points, separated by commas or white space; usused if NWaveElev = 0]
No Additional ItemsEach item of this array must be:
List of yi-coordinates for points where the incident wave elevations can be output (meters) [NWaveElev points, separated by commas or white space; usused if NWaveElev = 0]
No Additional ItemsEach item of this array must be:
Number of points where the wave kinematics can be output (-) [maximum of 9 output locations]
Value must be greater or equal to 0 and lesser or equal to 9
List of xi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
List of yi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
List of zi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
Add additional OpenFAST channels to the output files
Add items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether we derive OpenFAST model from an existing model and ignore WISDEM
Only used if from_openfast is set to True. Path to yaml file containing output data of the turbine tabulated against wind speed (rotor speed, blade pitch angle, aero thrust coefficient) needed to initialize the OpenFAST model through
Main (.fst) OpenFAST input file name. No directory.
OpenFAST input directory, containing .fst file. Absolute path or relative to modeling input
File path to xfoil executable (e.g. /home/user/Xfoil/bin/xfoil)
Whether or not to run xfoil in parallel (requires mpi setup)
Options for WEIS fidelity level 2 = linearized time domain (OpenFAST)
Whether or not to run WEIS fidelity level 2 = linearized OpenFAST
Whether or not to run a level 2 time domain simulation
Total run time (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Total run time (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Integration time step (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
List of wind speeds at which to linearize (m/s)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 200.0
Amount to increase rated wind speed from cc-blade to openfast with DOFs enabled. In general, the more DOFs, the greater this value.
Value must be greater or equal to 0.0 and lesser or equal to 10.0
List of degrees-of-freedom to linearize about
No Additional ItemsEach item of this array must be:
Must be one of:
- "FlapDOF1"
- "FlapDOF2"
- "EdgeDOF"
- "TeetDOF"
- "DrTrDOF"
- "GenDOF"
- "YawDOF"
- "TwFADOF1"
- "TwFADOF2"
- "TwSSDOF1"
- "TwSSDOF2"
- "PtfmSgDOF"
- "PtfmSwDOF"
- "PtfmHvDOF"
- "PtfmRDOF"
- "PtfmPDOF"
- "PtfmYDOF"
Tolerance for the rotational speed convergence [used only if CalcSteady=True] (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Proportional gain for the rotational speed error (>0) [used only if CalcSteady=True] (rad/(rad/s) for yaw or pitch; Nm/(rad/s) for torque)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Damping factor for the tower [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Damping factor for the blades [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Number of times to linearize (-) [>=1] [unused if Linearize=False]
Value must be greater or equal to 0 and lesser or equal to 120
List of times at which to linearize (s) [1 to NLinTimes] [used only when Linearize=True and CalcSteady=False]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Whether or not to run a DTQP optimization at level 2
Number of timesteps in DTQP timeseries optimization
Maximum number of DTQP optimization iterations
Tolerance of DTQP optimization
Solver used for DTQP optimization
Must be one of:
- "osqp"
- "ipopt"
Options for WEIS fidelity level 1 = frequency domain (RAFT)
Whether or not to run WEIS fidelity level 1 = frequency domain (RAFT)
Minimum frequency to evaluate (frequencies will be minfreq:minfreq:max_freq)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Maximum frequency to evaluate (frequencies will be minfreq:minfreq:max_freq)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Enable intersection mesh for potential BEM modeling. 0 = no intersection mesh, 1 = intersection mesh; turn on plot_design option for visualizing the mesh.
Must be one of:
- 0
- 1
Minimum characteristic length of the mesh for potential BEM modeling.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Maximum characteristic length of the mesh for potential BEM modeling. This is the dominant length scale for the mesh.
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Initial amplitude of each DOF for all frequencies
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of iterations to solve dynamics
Value must be greater or equal to 1 and lesser or equal to 100
Maximum node splitting section amount
Value must be greater or equal to 1 and lesser or equal to 100
lowest frequency and frequency interval to use in BEM analysis
Value must be greater or equal to 0.0 and lesser or equal to 2.0
Use RAFT to trim ballast so that average heave is near 0 (0 - no trim, 1 - adjust compartment fill values, 2 - adjust ballast density, recommended for now)
Heave tolerance for trim_ballast
Value must be greater or equal to 0
Save RAFT design iterations in <outputs>/raft_designs
Plot RAFT design iterations in <outputs>/raft_designs
Flag to run pyHAMS
Options for WEIS fidelity level 2 = linearized time domain (OpenFAST)
Whether or not to run WEIS fidelity level 2 = linearized OpenFAST
Whether or not to run a level 2 time domain simulation
Total run time (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Total run time (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Integration time step (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
List of wind speeds at which to linearize (m/s)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 200.0
Amount to increase rated wind speed from cc-blade to openfast with DOFs enabled. In general, the more DOFs, the greater this value.
Value must be greater or equal to 0.0 and lesser or equal to 10.0
List of degrees-of-freedom to linearize about
No Additional ItemsEach item of this array must be:
Must be one of:
- "FlapDOF1"
- "FlapDOF2"
- "EdgeDOF"
- "TeetDOF"
- "DrTrDOF"
- "GenDOF"
- "YawDOF"
- "TwFADOF1"
- "TwFADOF2"
- "TwSSDOF1"
- "TwSSDOF2"
- "PtfmSgDOF"
- "PtfmSwDOF"
- "PtfmHvDOF"
- "PtfmRDOF"
- "PtfmPDOF"
- "PtfmYDOF"
Tolerance for the rotational speed convergence [used only if CalcSteady=True] (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Proportional gain for the rotational speed error (>0) [used only if CalcSteady=True] (rad/(rad/s) for yaw or pitch; Nm/(rad/s) for torque)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Damping factor for the tower [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Damping factor for the blades [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Number of times to linearize (-) [>=1] [unused if Linearize=False]
Value must be greater or equal to 0 and lesser or equal to 120
List of times at which to linearize (s) [1 to NLinTimes] [used only when Linearize=True and CalcSteady=False]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Whether or not to run a DTQP optimization at level 2
Number of timesteps in DTQP timeseries optimization
Maximum number of DTQP optimization iterations
Tolerance of DTQP optimization
Solver used for DTQP optimization
Must be one of:
- "osqp"
- "ipopt"
Options for WEIS fidelity level 3 = nonlinear time domain
Whether or not to run WEIS fidelity level 3 = nonlinear time domain (Linearize OpenFAST)
Echo input data to '<RootName>.ech' (flag)
Error level when simulation should abort (string) {'WARNING', 'SEVERE', 'FATAL'}
Must be one of:
- "WARNING"
- "SEVERE"
- "FATAL"
Integration time step (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Interpolation order for input/output time history (-) {1=linear, 2=quadratic}
Must be one of:
- "1"
- "2"
- "linear"
- "Linear"
- "LINEAR"
- "quadratic"
- "Quadratic"
- "QUADRATIC"
Number of correction iterations (-) {0=explicit calculation, i.e., no corrections}
Value must be greater or equal to 0 and lesser or equal to 10
Time between calls to get Jacobians (s)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Scaling factor used in Jacobians (-)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Compute structural dynamics (switch) {1=ElastoDyn; 2=ElastoDyn + BeamDyn for blades}
Must be one of:
- 0
- 1
- 2
Compute inflow wind velocities (switch) {0=still air; 1=InflowWind; 2=external from OpenFOAM}
Must be one of:
- 0
- 1
- 2
Compute aerodynamic loads (switch) {0=None; 1=AeroDyn v14; 2=AeroDyn v15}
Must be one of:
- 0
- 1
- 2
Compute control and electrical-drive dynamics (switch) {0=None; 1=ServoDyn}
Must be one of:
- 0
- 1
Compute sea state information (switch) {0=None; 1=SeaState}
Must be one of:
- 0
- 1
Compute hydrodynamic loads (switch) {0=None; 1=HydroDyn}
Must be one of:
- 0
- 1
Compute sub-structural dynamics (switch) {0=None; 1=SubDyn; 2=External Platform MCKF}
Must be one of:
- 0
- 1
- 2
Compute mooring system (switch) {0=None; 1=MAP++; 2=FEAMooring; 3=MoorDyn; 4=OrcaFlex}
Must be one of:
- 0
- 1
- 2
- 3
- 4
Compute ice loads (switch) {0=None; 1=IceFloe; 2=IceDyn}
Must be one of:
- 0
- 1
- 2
MHK turbine type (switch) {0=Not an MHK turbine; 1=Fixed MHK turbine; 2=Floating MHK turbine}
Must be one of:
- 0
- 1
- 2
Gravitational acceleration (m/s^2)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Air density (kg/m^3)
Water density (kg/m^3)
Kinematic viscosity of working fluid (m^2/s)
Speed of sound in working fluid (m/s)
Atmospheric pressure (Pa) [used only for an MHK turbine cavitation check]
Vapour pressure of working fluid (Pa) [used only for an MHK turbine cavitation check]
Water depth (m)
Offset between still-water level and mean sea level (m) [positive upward]
Name of file containing ElastoDyn input parameters (quoted string)
Name of file containing BeamDyn input parameters for blade 1 (quoted string)
Name of file containing BeamDyn input parameters for blade 2 (quoted string)
Name of file containing BeamDyn input parameters for blade 3 (quoted string)
Name of file containing inflow wind input parameters (quoted string)
Name of file containing aerodynamic input parameters (quoted string)
Name of file containing control and electrical-drive input parameters (quoted string)
Name of file containing sea state input parameters (quoted string)
Name of file containing hydrodynamic input parameters (quoted string)
Name of file containing sub-structural input parameters (quoted string)
Name of file containing mooring system input parameters (quoted string)
Name of file containing ice input parameters (quoted string)
Print summary data to '<RootName>.sum' (flag)
Amount of time between screen status messages (s)
Value must be greater or equal to 0.01 and lesser or equal to 1000.0
Amount of time between creating checkpoint files for potential restart (s)
Value must be greater or equal to 0.01 and lesser or equal to 1000000.0
Time step for tabular output (s) (or 'default')
Format for tabular (time-marching) output file (switch) {1 text file [<RootName>.out], 2 binary file [<RootName>.outb], 3 both}
Must be one of:
- 0
- 1
- 2
- 3
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Linearization analysis (flag)
Calculate a steady-state periodic operating point before linearization [unused if Linearize=False] (flag)
Controller parameter to be trimmed {1:yaw; 2:torque; 3:pitch} [used only if CalcSteady=True] (-)
Must be one of:
- "1"
- "2"
- "3"
- "yaw"
- "Yaw"
- "YAW"
- "torque"
- "Torque"
- "TORQUE"
- "pitch"
- "Pitch"
- "PITCH"
Tolerance for the rotational speed convergence [used only if CalcSteady=True] (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Proportional gain for the rotational speed error (>0) [used only if CalcSteady=True] (rad/(rad/s) for yaw or pitch; Nm/(rad/s) for torque)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Damping factor for the tower [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Damping factor for the blades [used only if CalcSteady=True] (N/(m/s))
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Number of times to linearize (-) [>=1] [unused if Linearize=False]
Value must be greater or equal to 0 and lesser or equal to 10
List of times at which to linearize (s) [1 to NLinTimes] [used only when Linearize=True and CalcSteady=False]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Inputs included in linearization (switch) {0=none; 1=standard; 2=all module inputs (debug)} [unused if Linearize=False]
Must be one of:
- "0"
- "1"
- "2"
- "none"
- "None"
- "NONE"
- "standard"
- "Standard"
- "STANDARD"
- "all"
- "All"
- "ALL"
Outputs included in linearization (switch) {0=none; 1=from OutList(s); 2=all module outputs (debug)} [unused if Linearize=False]
Must be one of:
- "0"
- "1"
- "2"
- "none"
- "None"
- "NONE"
- "standard"
- "Standard"
- "STANDARD"
- "all"
- "All"
- "ALL"
Include full Jacobians in linearization output (for debug) (flag) [unused if Linearize=False; used only if LinInputs=LinOutputs=2]
Write module-level linearization output files in addition to output for full system (flag) [unused if Linearize=False]
VTK visualization data output (switch) {0=none; 1=initialization data only; 2=animation}
Must be one of:
- 0
- 1
- 2
Type of VTK visualization data (switch) {1=surfaces; 2=basic meshes (lines/points); 3=all meshes (debug)} [unused if WrVTK=0]
Must be one of:
- 1
- 2
- 3
Write mesh fields to VTK data files (flag) {true/false} [unused if WrVTK=0]
Frame rate for VTK output (frames per second){will use closest integer multiple of DT} [used only if WrVTK=2]
Value must be greater or equal to 0.0
Echo input data to '<RootName>.ech' (flag)
Switch for wind file type (1=steady; 2=uniform; 3=binary TurbSim FF; 4=binary Bladed-style FF; 5=HAWC format; 6=User defined; 7=native Bladed FF)
Must be one of:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Direction of wind propagation (meteoroligical rotation from aligned with X (positive rotates towards -Y) -- degrees)
Value must be greater or equal to 0.0 and lesser or equal to 360.0
Upflow angle (degrees) (not used for native Bladed format WindType=7)
Value must be greater or equal to -90.0 and lesser or equal to 90.0
Use cubic interpolation for velocity in time (false=linear, true=cubic) [Used with WindType=2,3,4,5,7]
Number of points to output the wind velocity (0 to 9)
Value must be greater or equal to 0 and lesser or equal to 9
Horizontal windspeed, for WindType = 1
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Power law exponent (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Filename of time series data for uniform wind field [used only for WindType = 2]
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference length for linear horizontal and vertical sheer (-) [used only for WindType = 2]
Value must be greater or equal to 1e-06 and lesser or equal to 1000.0
Name of the Full field wind file to use (.bts) [used only for WindType = 3]
Rootname of the full-field wind file to use (.wnd, .sum) [used only for WindType = 4]
Have tower file (.twr) (flag) [used only for WindType = 4]
Name of the file containing the u-component fluctuating wind (.bin) [Only used with WindType = 5]
Name of the file containing the v-component fluctuating wind (.bin) [Only used with WindType = 5]
Name of the file containing the w-component fluctuating wind (.bin) [Only used with WindType = 5]
Number of grids in the x direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Number of grids in the y direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Number of grids in the z direction (in the 3 files above) (-)
Value must be greater or equal to 2 and lesser or equal to 1000
Distance (in meters) between points in the x direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Distance (in meters) between points in the y direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Distance (in meters) between points in the z direction (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Reference height for horizontal wind speed (m)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling method [0 = none, 1 = direct scaling, 2 = calculate scaling factor based on a desired standard deviation]
Must be one of:
- 0
- 1
- 2
Turbulence scaling factor for the x direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling factor for the y direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence scaling factor for the z direction (-) [ScaleMethod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in x direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in y direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Turbulence standard deviation to calculate scaling from in z direction (m/s) [ScaleMethod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Mean u-component wind speed at the reference height (m/s) [HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Wind profile type (0=constant;1=logarithmic,2=power law)
Must be one of:
- 0
- 1
- 2
Power law exponent (-) (used for PL wind profile type only)[HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Surface roughness length (m) (used for LG wind profile type only)[HAWC-format files]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Initial offset in +x direction (shift of wind box)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Print summary data to '<RootName>.sum' (flag)
Switch for lidar configuration (0 = None, 1 = Single Point Beam(s), 2 = Continuous, 3 = Pulsed)
Must be one of:
- 0
- 1
- 2
- 3
Number of lidar measurement gates (used when SensorType = 3)
Distance between range gates (m) (used when SensorType = 3)
Number of lidar measurement beams (0-5)(used when SensorType = 1)
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
Focal distance coordinates of the lidar beam in the x direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsFocal distance coordinates of the lidar beam in the y direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsFocal distance coordinates of the lidar beam in the z direction (relative to hub height) (only first coordinate used for SensorType 2 and 3) (m)
No Additional ItemsOffset of the lidar from hub height (m)
No Additional ItemsEach item of this array must be:
Reference average wind speed for the lidar [m/s]
Value must be greater or equal to 0.0
Time between each measurement [s]
Value must be greater or equal to 0.0
TRUE => return radial component, FALSE => return 'x' direction estimate
Flag whether to consider the hub motion's impact on Lidar measurements
Whether or not to run AeroDyn
Echo input data to '<RootName>.ech' (flag)
Time interval for aerodynamic calculations. Set it to 0. for default (same as main fst)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Type of wake/induction model (switch) {0=none, 1=BEMT, 3=OLAF}
Must be one of:
- 0
- 1
- 2
- 3
- 11
- 12
- 13
Type of blade airfoil aerodynamics model (switch) {1=steady model, 2=Beddoes-Leishman unsteady model} [must be 1 when linearizing]
Must be one of:
- 0
- 1
- 2
Type tower influence on wind based on potential flow around the tower (switch) {0=none, 1=baseline potential flow, 2=potential flow with Bak correction}
Must be one of:
- 0
- 1
- 2
Calculate tower influence on wind based on downstream tower shadow (switch) {0=none, 1=Powles model, 2=Eames model}
Must be one of:
- 0
- 1
- 2
Calculate tower aerodynamic loads (flag)
Assume frozen wake during linearization (flag) [used only when Wake_Mod=1 and when linearizing]
Perform cavitation check (flag) TRUE will turn off unsteady aerodynamics
Include buoyancy effects (flag)
Include Nacelle Drag effects (flag)
Flag to compute AeroAcoustics calculation [only used when Wake_Mod=1 or 2]
Aeroacoustics input file
BEM model {1=legacy NoSweepPitchTwist, 2=polar} (switch) [used for all Wake_Mod to determine output coordinate system]
Must be one of:
- 1
- 2
Type of skewed-wake correction model (switch) {1=uncoupled, 2=Pitt/Peters, 3=coupled} [used only when Wake_Mod=1]
Must be one of:
- 1
- 2
- 3
Skew model {0=No skew model, -1=Remove non-normal component for linearization, 1=skew model active}
Must be one of:
- -1
- 0
- 1
Turn the skew momentum correction on or off [used only when Skew_Mod=1]
Type of skewed-wake correction model (switch) {0=no redistribution, 1=Glauert/Pitt/Peters} [used only when Skew_Mod=1]
Must be one of:
- 0
- 1
Constant used in Pitt/Peters skewed wake model {or 'default' is 15/32*pi} (-) [used only when SkewMod=1 and SkewRedistrMod=1]
Constant used in Pitt/Peters skewed wake model {or 'default' is 15/32*pi} (-) [used only when SkewMod=2; unused when Wake_Mod=0]
Use the Prandtl tip-loss model (flag) [used only when Wake_Mod=1]
Use the Prandtl hub-loss model (flag) [used only when Wake_Mod=1]
Include tangential induction in BEMT calculations (flag) [used only when Wake_Mod=1]
Include the drag term in the axial-induction calculation (flag) [used only when Wake_Mod=1]
Include the drag term in the tangential-induction calculation (flag) [used only when Wake_Mod=1 and TanInd=TRUE]
Convergence tolerance for BEMT nonlinear solve residual equation {or 0.0 for default} (-) [used only when Wake_Mod=1]
Maximum number of iteration steps (-) [used only when Wake_Mod=1]
Use sector averaging (flag)
Weighting function for sector average {1=Uniform, default=1} within a sector centered on the blade (switch) [used only when SectAvg=True]
Must be one of:
- 1
Number of points per sectors (-) {default=5} [used only when SectAvg=True]
Backward azimuth relative to blade where the sector starts (<=0) {default=-60} (deg) [used only when SectAvg=True]
Forward azimuth relative to blade where the sector ends (>=0) {default=60} (deg) [used only when SectAvg=True]
Type of dynamic BEMT (DBEMT) model {0=No Dynamic Wake, -1=Frozen Wake for linearization, 1:constant tau1, 2=time-dependent tau1, 3=constant tau1 with continuous formulation} (-)
Must be one of:
- -1
- 0
- 1
- 2
- 3
Time constant for DBEMT (s) [used only when WakeMod=2 and DBEMTMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Input file for OLAF [used only when Wake_Mod=3]
Integration method 1 RK4, 5 Forward Euler 1st order, default 5 switch
Time interval for wake propagation. {default dtaero} (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Time when wake is free. (-) value = always free. {default 0.0} (s)
Time at which full circulation is reached. {default 0.0} (s)
Circulation solving method {1 Cl-Based, 2 No-Flow Through, 3 Prescribed, default 1 }(switch)
Convergence criteria {default 0.001} [only if CircSolvMethod=1] (-)
Relaxation factor {default 0.1} [only if CircSolvMethod=1] (-)
Maximum number of iterations for circulation solving {default 30} (-)
File containing prescribed circulation [only if CircSolvMethod=3] (quoted string)
Number of near-wake panels [integer] (-)
Value must be greater or equal to 0
Number of free near-wake panels (-) {default nNWPanels}
Value must be greater or equal to 0
Number of far-wake panels (-) {default 0}
Value must be greater or equal to 0
Number of free far-wake panels (-) {default nFWPanels}
Value must be greater or equal to 0
Include shed vorticity in the far wake {default false}
Diffusion method to account for viscous effects {0 None, 1 Core Spreading, 'default' 0}
Method to determine the regularization parameters {0 Manual, 1 Optimized, 2 chord, 3 span default 0 }
Viscous diffusion function {0 None, 1 Rankine, 2 LambOseen, 3 Vatistas, 4 Denominator, 'default' 3} (switch)
Wake regularization method {1 Constant, 2 Stretching, 3 Age, default 1} (switch)
Wake regularization factor (m)
Wing regularization factor (m)
Eddy viscosity in core spreading methods, typical values 1-1000
Include tower flow disturbance effects on wake convection {default:false} [only if TwrPotent or TwrShadow]
Shear Model {0 No treatment, 1 Mirrored vorticity, default 0}
Method to determine the velocity {1Biot-Savart Segment, 2Particle tree, default 1}
Branch radius fraction above which a multipole calculation is used {default 2.0} [only if VelocityMethod=2]
Value must be greater or equal to 0.0
Number of particles per segment [only if VelocityMethod=2]
Value must be greater or equal to 0
Outputs Visualization Toolkit (VTK) (independent of .fst option) {0 NoVTK, 1 Write VTK at each time step} (flag)
Number of blades for which VTK files are exported {0 No VTK per blade, n VTK for blade 1 to n} (-)
Coordinate system used for VTK export. {1 Global, 2 Hub, 3 Both, 'default' 1}
Frame rate for VTK output (frames per second) {"all" for all glue code timesteps, "default" for all OLAF timesteps} [used only if WrVTK=1]
(GB DEBUG 7/8) Number of grid points for VTK output
Sample the angle of attack (AoA) at the 3/4 chord or the AC point {default=True} [always used]
Unsteady Aero Model Switch (switch) {1=Baseline model (Original), 2=Gonzalez's variant (changes in Cn,Cc,Cm), 3=Minemma/Pierce variant (changes in Cc and Cm)} [used only when AFAeroMod=2]
Must be one of:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Unsteady Aero Model Switch (switch) {0=Quasi-steady (no UA), 2=B-L Gonzalez, 3=B-L Minnema/Pierce, 4=B-L HGM 4-states, 5=B-L HGM+vortex 5 states, 6=Oye, 7=Boeing-Vertol}
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Flag to indicate whether a lookup for f' will be calculated (TRUE) or whether best-fit exponential equations will be used (FALSE); if FALSE S1-S4 must be provided in airfoil input files (flag) [used only when AFAeroMod=2]
Switch to indicate which integration method UA uses (1=RK4, 2=AB4, 3=ABM4, 4=BDF2)
Must be one of:
- 1
- 2
- 3
- 4
Starting radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Ending radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Interpolation method for multiple airfoil tables {1=1D interpolation on AoA (first table only); 2=2D interpolation on AoA and Re; 3=2D interpolation on AoA and UserProp} (-)
Must be one of:
- 1
- 2
- 3
The column in the airfoil tables that contains the angle of attack (-)
The column in the airfoil tables that contains the lift coefficient (-)
The column in the airfoil tables that contains the drag coefficient (-)
The column in the airfoil tables that contains the pitching-moment coefficient; use zero if there is no Cm column (-)
The column in the airfoil tables that contains the Cpmin coefficient; use zero if there is no Cpmin column (-)
Include aerodynamic pitching moment in calculations (flag)
Hub volume (m^3)
Value must be greater or equal to 0.0
Hub center of buoyancy x direction offset (m)
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Nacelle volume (m^3)
Value must be greater or equal to 0.0
Position of nacelle center of buoyancy from yaw bearing in nacelle coordinates (m)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Projected area of the nacelle in X, Y, Z in the nacelle coordinate system (m^2)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Drag coefficient for the nacelle areas defined above (-)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Position of aerodynamic center of nacelle drag in nacelle coordinates (m)
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -100.0 and lesser or equal to 100.0
Calculate tail fin aerodynamics model (flag)
Input file for tail fin aerodynamics [used only when TFinAero=True]
Atmospheric pressure (Pa) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Vapour pressure of fluid (Pa) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Water depth above mid-hub height (m) [used only when CavitCheck=True]
Value must be greater or equal to 0.0
Turbulence intensity used in the Eames tower shadow model. Values of TwrTI between 0.05 and 0.4 are recommended.
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Turbulence buoyancy coefficient
Print summary data to '<RootName>.sum' (flag)
Echo input data to '<RootName>.ech' (flag)
Must be one of:
- "1"
- "2"
- "3"
- "RK4"
- "AB4"
- "ABM4"
Integration time step, 0.0 for default (s)
Value must be greater or equal to 0.0 and lesser or equal to 10.0
First flapwise blade mode DOF (flag)
Second flapwise blade mode DOF (flag)
First edgewise blade mode DOF (flag)
Rotor-teeter DOF (flag) [unused for 3 blades]
Drivetrain rotational-flexibility DOF (flag)
Generator DOF (flag)
Yaw DOF (flag)
First fore-aft tower bending-mode DOF (flag)
Second fore-aft tower bending-mode DOF (flag)
First side-to-side tower bending-mode DOF (flag)
Second side-to-side tower bending-mode DOF (flag)
Platform horizontal surge translation DOF (flag)
Platform horizontal sway translation DOF (flag)
Platform vertical heave translation DOF (flag)
Platform roll tilt rotation DOF (flag)
Platform pitch tilt rotation DOF (flag)
Platform yaw rotation DOF (flag)
Initial out-of-plane blade-tip displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial in-plane blade-tip deflection (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade 1 initial pitch (radians)
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Blade 2 initial pitch (radians)
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Blade 3 initial pitch (radians) [unused for 2 blades]
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Initial or fixed teeter angle (radians) [unused for 3 blades]
Value must be greater or equal to -1.5707963267948966 and lesser or equal to 1.5707963267948966
Initial azimuth angle for blade 1 (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed rotor speed (rpm)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed nacelle-yaw angle (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial fore-aft tower-top displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 50.0
Initial side-to-side tower-top displacement (meters)
Value must be greater or equal to 0.0 and lesser or equal to 50.0
Initial or fixed horizontal surge translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed horizontal sway translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed vertical heave translational displacement of platform (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Initial or fixed roll tilt rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed pitch tilt rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Initial or fixed yaw rotational displacement of platform (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Undersling length [distance from teeter pin to the rotor apex] (meters) [unused for 3 blades]
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Delta-3 angle for teetering rotors (degrees) [unused for 3 blades]
Value must be greater or equal to -30.0 and lesser or equal to 30.0
Azimuth value to use for I/O when blade 1 points up (radians)
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Distance from rotor apex [3 blades] or teeter pin [2 blades] to shaft strain gages [positive for upwind rotors] (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Downwind distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Lateral distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Vertical distance from the tower-top to the nacelle IMU (meters)
Value must be greater or equal to -10.0 and lesser or equal to 10.0
Number of blade nodes (per blade) used for analysis (-)
Value must be greater or equal to 10 and lesser or equal to 200
Rotor-teeter spring/damper model {0: none, 1: standard, 2: user-defined from routine UserTeet} (switch) [unused for 3 blades]
Must be one of:
- 0
- 1
- 2
Rotor-teeter damper position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter damping constant (N-m/(rad/s)) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter rate-independent Coulomb-damping moment (N-m) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter soft-stop position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter hard-stop position (radians) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to -6.283185307179586 and lesser or equal to 6.283185307179586
Rotor-teeter soft-stop linear-spring constant (N-m/rad) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Rotor-teeter hard-stop linear-spring constant (N-m/rad) [used only for 2 blades and when TeetMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Yaw-friction model {0: none, 1: friction independent of yaw-bearing force and bending moment, 2: friction with Coulomb terms depending on yaw-bearing force and bending moment, 3: user defined model} (switch)
Must be one of:
- 0
- 1
- 2
Maximum static Coulomb friction torque (N-m) [MCSmax when YawFrctMod=1; |Fz|*MCSmax when YawFrctMod=2 and Fz<0]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Maximum static Coulomb friction torque proportional to yaw bearing shear force (N-m) [sqrt(Fx^2+Fy^2)*M_FCSmax; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Maximum static Coulomb friction torque proportional to yaw bearing bending moment (N-m) [sqrt(Mx^2+My^2)*M_MCSmax; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment (N-m) [MCD when YawFrctMod=1; |Fz|*MCD when YawFrctMod=2 and Fz<0]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment proportional to yaw bearing shear force (N-m) [sqrt(Fx^2+Fy^2)*M_FCD; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Dynamic Coulomb friction moment proportional to yaw bearing bending moment (N-m) [sqrt(Mx^2+My^2)*M_MCD; only used when YawFrctMod=2]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Linear viscous friction coefficient (N-m/(rad/s))
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Quadratic viscous friction coefficient (N-m/(rad/s)^2)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Yaw angular velocity cutoff below which viscous friction is linearized (rad/s)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Read in additional model properties for furling turbine (flag) [must currently be FALSE)
Name of file containing furling properties (quoted string) [unused when Furling=False]
Number of tower nodes used for analysis (-)
Value must be greater or equal to 10 and lesser or equal to 200
Print summary data to '<RootName>.sum' (flag)
Switch to determine where output will be placed 1 in module output file only; 2 in glue code output file only; 3 both (currently unused)
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Decimation factor for tabular output 1 output every time step} (-) (currently unused)
Time to begin tabular output (s) (currently unused)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Blade flap mode 1 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flap mode 2 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade edge mode 1 structural damping in percent of critical (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade mass density (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade flap stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust blade edge stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 1st fore-aft mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 2nd fore-aft mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 1st side-to-side mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower 2nd side-to-side mode structural damping ratio (%)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Blade flapwise modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower fore-aft modal stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower fore-aft modal stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower side-to-side stiffness tuner, 1st mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Tower side-to-side stiffness tuner, 2nd mode (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower mass density (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower fore-aft stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Factor to adjust tower side-to-side stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Echo input data to '<RootName>.ech' (flag)
Use quasistatic pre-conditioning with centripetal accelerations in initialization (flag) [dynamic solve only]
Numerical damping parameter for generalized-alpha integrator
Value must be greater or equal to 0.0 and lesser or equal to 10000000000.0
Quadrature method: 1=Gaussian; 2=Trapezoidal (switch)
Must be one of:
- 1
- 2
Refinement factor for trapezoidal quadrature (-). DEFAULT = 1 [used only when quadrature=2]
Value must be greater or equal to 1 and lesser or equal to 10
Factorization frequency (-). DEFAULT = 5
Value must be greater or equal to 1 and lesser or equal to 50
Time step size (s). Use 0.0 for Default
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Number of factored load retries before quitting the simulation. Use 0 for Default
Value must be greater or equal to 0 and lesser or equal to 50
Max number of iterations in Newton-Ralphson algorithm (-). DEFAULT = 10
Value must be greater or equal to 1 and lesser or equal to 100
Tolerance for stopping criterion (-) [DEFAULT = 1E-5]
Value must be greater or equal to 1e-16 and lesser or equal to 1e+16
Flag to use finite differenced tangent stiffness matrix (-)
Flag to compare analytical finite differenced tangent stiffness matrix (-)
perturbation size for finite differencing (-). Use 0.0 for DEFAULT
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Maximum allowable relative difference between analytical and fd tangent stiffness (-)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Orient states in the rotating frame during linearization (flag) [used only when linearizing]
Order of interpolation (basis) function (-)
Value must be greater or equal to 0 and lesser or equal to 50
Whether a pitch actuator should be used (flag)
Pitch actuator inertia (kg-m^2) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Pitch actuator stiffness (kg-m^2/s^2) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Pitch actuator damping (kg-m^2/s) [used only when UsePitchAct is true]
Value must be greater or equal to 0.0 and lesser or equal to 1000000000000.0
Print summary data to '<RootName>.sum' (flag)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Number of nodes to output to file [0 - 9] (-)
Value must be greater or equal to 0 and lesser or equal to 9
Nodes whose values will be output (-)
No Additional ItemsDamping type, 0 no damping; 1 damped
Must be one of:
- 0
- 1
Stiffness proportional damping coefficient in shear x direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in shear y direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in axial z direction.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in edgewise bending (around x). mu4 is often assumed equal to mu2.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in flapwise bending (around y). mu5 is often assumed equal to mu1.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Stiffness proportional damping coefficient in torsional direction (around z). mu6 is often assumed equal to mu3.
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Echo input data to '<RootName>.ech' (flag)
Potential-flow model {0 = none=no potential flow, 1 = frequency-to-time-domain transforms based on Capytaine/NEMOH/WAMIT output, 2 = fluid-impulse theory (FIT)} (switch)
Must be one of:
- 0
- 1
- 2
Wave Excitation model {0 = None, 1 = DFT, 2 = state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ssexctn INPUT FILE]
Must be one of:
- 0
- 1
- 2
Method of computing Wave Excitation {0: use undisplaced position, 1: use displaced position, 2: use low-pass filtered displaced position) [only used when PotMod=1 and ExctnMod>0 and SeaStates WaveMod>0]} (switch)
Must be one of:
- 0
- 1
- 2
Cutoff (corner) frequency of the low-pass time-filtered displaced position (Hz) [>0.0] [used only when PotMod=1, ExctnMod>0, and ExctnDisp=2]) [only used when PotMod=1 and ExctnMod>0 and SeaState's WaveMod>0]} (switch)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Model for large platform yaw offset {0: Static reference yaw offset based on PtfmRefY, 1: dynamic reference yaw offset based on low-pass filtering the PRP yaw motion with cutoff frequency PtfmYCutOff} (switch)
Must be one of:
- 0
- 1
Constant (if PtfmYMod=0) or initial (if PtfmYMod=1) platform reference yaw offset (deg)
Cutoff frequency for the low-pass filtering of PRP yaw motion when PtfmYMod=1 [unused when PtfmYMod=0] (Hz)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of evenly distributed platform yaw/heading angles over the range of [-180, 180) deg for which the wave excitation shall be computed [only used when PtfmYMod=1] (-)
Value must be greater or equal to 1 and lesser or equal to 360
Radiation memory-effect model {0 = no memory-effect calculation, 1 = convolution, 2 = state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ss INPUT FILE]
Must be one of:
- 0
- 1
- 2
Analysis time for wave radiation kernel calculations (sec) [only used when PotMod=1; determines RdtnDOmega=Pi/RdtnTMax in the cosine transform; MAKE SURE THIS IS LONG ENOUGH FOR THE RADIATION IMPULSE RESPONSE FUNCTIONS TO DECAY TO NEAR-ZERO FOR THE GIVEN PLATFORM!]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Time step for wave radiation kernel calculations, use 0.0 for default (sec) [only used when PotMod=1; DT<=RdtnDT<=0.1 recommended; determines RdtnOmegaMax=Pi/RdtnDT in the cosine transform]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Number of WAMIT bodies to be used (-) [>=1; only used when PotMod=1. If NBodyMod=1, the WAMIT data contains a vector of size 6NBody x 1 and matrices of size 6NBody x 6*NBody; if NBodyMod>1, there are NBody sets of WAMIT data each with a vector of size 6 x 1 and matrices of size 6 x 6]
Value must be greater or equal to 1 and lesser or equal to 100
Body coupling model {1: include coupling terms between each body and NBody in HydroDyn equals NBODY in WAMIT, 2: neglect coupling terms between each body and NBODY=1 with XBODY=0 in WAMIT, 3: Neglect coupling terms between each body and NBODY=1 with XBODY=/0 in WAMIT} (switch) [only used when PotMod=1]
Must be one of:
- 1
- 2
- 3
Will be automatically filled in with HAMS output unless a value here overrides it; WAMIT output files containing the linear, nondimensionalized, hydrostatic restoring matrix (.hst), frequency-dependent hydrodynamic added mass matrix and damping matrix (.1), and frequency- and direction-dependent wave excitation force vector per unit wave amplitude (.3) (quoted string) [MAKE SURE THE FREQUENCIES INHERENT IN THESE WAMIT FILES SPAN THE PHYSICALLY-SIGNIFICANT RANGE OF FREQUENCIES FOR THE GIVEN PLATFORM; THEY MUST CONTAIN THE ZERO- AND INFINITE-FREQUENCY LIMITS]
Characteristic body length scale used to redimensionalize WAMIT output (meters) [1 to NBody if NBodyMod>1] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The xt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The yt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The zt offset of the body reference point(s) from (0,0,0) (meters) [1 to NBody] [only used when PotMod=1. If NBodyMod=2,PtfmRefzt=0.0]
No Additional ItemsEach item of this array must be:
The rotation about zt of the body reference frame(s) from xt/yt (degrees) [1 to NBody] [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
Displaced volume of water when the body is in its undisplaced position (m^3) [1 to NBody] [only used when PotMod=1; USE THE SAME VALUE COMPUTED BY WAMIT AS OUTPUT IN THE .OUT FILE!]
No Additional ItemsEach item of this array must be:
The xt offset of the center of buoyancy (COB) from the platform reference point (meters) [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
The yt offset of the center of buoyancy (COB) from the platform reference point (meters) [only used when PotMod=1]
No Additional ItemsEach item of this array must be:
Mean-drift 2nd-order forces computed {0 = None; [7, 8, 9, 10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero]
Must be one of:
- 0
- 7
- 8
- 9
- 10
- 11
- 12
Mean- and slow-drift 2nd-order forces computed with Newman's approximation {0 = None; [7, 8, 9, 10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero. Used only when WaveDirMod=0]
Must be one of:
- 0
- 7
- 8
- 9
- 10
- 11
- 12
Full difference-frequency 2nd-order forces computed with full QTF {0 = None; [10, 11, or 12] = WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero]
Must be one of:
- 0
- 10
- 11
- 12
Full summation -frequency 2nd-order forces computed with full QTF {0 = None; [10, 11, or 12] = WAMIT file to use}
Must be one of:
- 0
- 10
- 11
- 12
Additional preload (N, N-m)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear stiffness by row (N/m, N/rad, N-m/m, N-m/rad)
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional linear damping by row (N/(m/s), N/(rad/s), N-m/(m/s), N-m/(rad/s))
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Additional quadratic drag by row (N/(m/s)^2, N/(rad/s)^2, N-m(m/s)^2, N-m/(rad/s)^2)
No Additional ItemsEach item of this array must be:
Method of computing Wave Kinematics {0: use undisplaced position, 1: use displaced position) } (switch)
Must be one of:
- 0
- 1
Method of computing distributed added-mass force. (0: Only and always on nodes below SWL at the undisplaced position. 2: Up to the instantaneous free surface) [overwrite to 0 when WaveMod = 0 or 6 or when WaveStMod = 0 in SeaState]
Must be one of:
- 0
- 2
Number of member outputs (-) [must be < 10]
Value must be greater or equal to 0 and lesser or equal to 9
Number of joint outputs [Must be < 10]
Value must be greater or equal to 0 and lesser or equal to 9
List of JointIDs which are to be output (-)[unused if NJOutputs=0]
No Additional ItemsEach item of this array must be:
Output a summary file [flag]
Output all user-specified member and joint loads (only at each member end, not interior locations) [flag]
Output requested channels to [1=Hydrodyn.out, 2=GlueCode.out, 3=both files]
Must be one of:
- 1
- 2
- 3
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings (quoted string) [not checked for validity]
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 0.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 0.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Simple strip theory model coefficient, default of 1.0
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Echo input data to '<RootName>.ech' (flag)
Local Integration Step. If 0.0, the glue-code integration step will be used.
Value must be lesser or equal to 100.0
Integration Method [1/2/3/4 = RK4/AB4/ABM4/AM2].
Must be one of:
- 1
- 2
- 3
- 4
Solve dynamics about static equilibrium point
Include extra moment from lever arm at interface and rotate FEM for floating.
FEM switch = element model in the FEM. [1= Euler-Bernoulli(E-B); 2=Tapered E-B (unavailable); 3= 2-node Timoshenko; 4= 2-node tapered Timoshenko (unavailable)]
Must be one of:
- 1
- 2
- 3
- 4
Number of sub-elements per member
Value must be greater or equal to 1 and lesser or equal to 100
If True perform C-B reduction, else full FEM dofs will be retained. If True, select Nmodes to retain in C-B reduced system.
Number of internal modes to retain (ignored if CBMod=False). If Nmodes=0 --> Guyan Reduction.
Value must be greater or equal to 0 and lesser or equal to 50
Damping Ratios for each retained mode (% of critical) If Nmodes>0, list Nmodes structural damping ratios for each retained mode (% of critical), or a single damping ratio to be applied to all retained modes. (last entered value will be used for all remaining modes).
No Additional ItemsEach item of this array must be:
Guyan damping {0=none, 1=Rayleigh Damping, 2=user specified 6x6 matrix}
Must be one of:
- 0
- 1
- 2
Mass and stiffness proportional damping coefficients (Rayleigh Damping) [only if GuyanDampMod=1]
No Additional ItemsEach item of this array must be:
Guyan damping matrix (6x6) [only if GuyanDampMod=2]
Value must be greater or equal to 0 and lesser or equal to 6
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Guyan damping matrix by row (6x6)
No Additional ItemsEach item of this array must be:
Print summary data to '<RootName>.sum' (flag)
Output Guyan and Craig-Bampton modes {0 No output, 1 JSON output}, (flag)
Must be one of:
- 0
- 1
Output first 30 FEM modes {0 No output, 1 JSON output} (flag)
Must be one of:
- 0
- 1
Output cosine matrices with the selected output member forces (flag)
Output all members' end forces (flag)
Output requested channels to 1=<rootname>.SD.out; 2=<rootname>.out (generated by FAST); 3=both files.
Must be one of:
- 1
- 2
- 3
Generate a tab-delimited output in the <rootname>.SD.out file
Decimation of output in the <rootname>.SD.out file
Value must be greater or equal to 0
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings in the <rootname>.SD.out file (quoted string) [not checked for validity]
Number of members whose forces/displacements/velocities/accelerations will be output (-) [Must be <= 9].
Value must be greater or equal to 0 and lesser or equal to 9
Echo input data to '<RootName>.ech' (flag)
Time step to use in mooring integration (s)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Bottom stiffness (Pa/m)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Bottom damping (Pa/m)
Value must be greater or equal to 0.0 and lesser or equal to 1000000000.0
Time interval for analyzing convergence during IC gen (s)
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Max time for ic gen (s)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Factor by which to scale drag coefficients during dynamic relaxation (-)
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Threshold for IC convergence (-)
Value must be greater or equal to 0.0 and lesser or equal to 1.0
NumSegs in MoorDyn input for modeling mooring lines. If array, should match number of lines.
ServoDyn modelling options in OpenFAST
Echo input data to '<RootName>.ech' (flag)
Communication interval for controllers (s) (or 'default')
Pitch control mode {0 = none, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Time to enable active pitch control (s) [unused when PCMode=0]
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 1 and end standard pitch control (s)
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 2 and end standard pitch control (s)
Value must be greater or equal to 0.0
Time to start override pitch maneuver for blade 3 and end standard pitch control (s)
Value must be greater or equal to 0.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 1 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 2 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Pitch rate at which override pitch maneuver heads toward final pitch angle for blade 3 (deg/s). It cannot be 0
Value must be greater or equal to 1e-06 and lesser or equal to 30.0
Blade 1 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Blade 2 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Blade 3 final pitch for pitch maneuvers (degrees)
Value must be greater or equal to -180 and lesser or equal to 180
Variable-speed control mode {0 = none, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Generator model {1 = simple, 2 = Thevenin, 3 = user-defined from routine UserGen}
Must be one of:
- 1
- 2
Method to start the generator {True - timed using TimGenOn, False - generator speed using SpdGenOn} (flag)
Method to stop the generator {True - timed using TimGenOf, False - when generator power = 0} (flag)
Generator speed to turn on the generator for a startup (HSS speed) (rpm) [used only when GenTiStr=False]
Value must be greater or equal to 0.0
Time to turn on the generator for a startup (s) [used only when GenTiStr=True]
Value must be greater or equal to 0.0
Time to turn off the generator (s) [used only when GenTiStp=True]
Value must be greater or equal to 0.0
Rated generator speed for simple variable-speed generator control (HSS side) (rpm) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator torque/constant generator torque in Region 3 for simple variable-speed generator control (HSS side) (N-m) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Generator torque constant in Region 2 for simple variable-speed generator control (HSS side) (N-m/rpm^2) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator slip percentage in Region 2 1/2 for simple variable-speed generator control (%) [used only when VSContrl=1]
Value must be greater or equal to 0.0
Rated generator slip percentage (%) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Synchronous (zero-torque) generator speed (rpm) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Rated torque (N-m) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Pull-out ratio (Tpullout/Trated) (-) [used only when VSContrl=0 and GenModel=1]
Value must be greater or equal to 0.0
Line frequency [50 or 60] (Hz) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Number of poles [even integer > 0] (-) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0
Stator resistance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Rotor resistance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Line-to-line RMS voltage (volts) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Stator leakage reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Rotor leakage reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
Magnetizing reactance (ohms) [used only when VSContrl=0 and GenModel=2]
Value must be greater or equal to 0.0
HSS brake model {0 = none, 1 = simple, 4 = user-defined from Simulink/Labview, 5 = user-defined from Bladed-style DLL (not in ROSCO, yet)}
Must be one of:
- 0
- 1
- 4
- 5
Time to initiate deployment of the HSS brake (s)
Value must be greater or equal to 0.0
Time for HSS-brake to reach full deployment once initiated (sec) [used only when HSSBrMode=1]
Value must be greater or equal to 0.0
Fully deployed HSS-brake torque (N-m)
Value must be greater or equal to 0.0
Yaw control mode {0 - none, 3 - user-defined from routine UserYawCont, 4 - user-defined from Simulink/Labview, 5 - user-defined from Bladed-style DLL} (switch)
Must be one of:
- 0
- 3
- 4
- 5
Time to enable active yaw control (s) [unused when YCMode=0]
Neutral yaw position--yaw spring force is zero at this yaw (degrees)
Nacelle-yaw spring constant (N-m/rad)
Nacelle-yaw damping constant (N-m/(rad/s))
Time to start override yaw maneuver and end standard yaw control (s)
Yaw maneuver rate (in absolute value) (deg/s). It cannot be zero
Value must be greater or equal to 1e-06
Final yaw angle for override yaw maneuvers (degrees)
Airfoil control mode {0- none, 1- cosine wave cycle, 4- user-defined from Simulink/Labview, 5- user-defined from Bladed-style DLL}
Must be one of:
- 0
- 1
- 4
- 5
Mean level for sinusoidal cycling or steady value (-) [used only with AfCmode==1]
Amplitude for for cosine cycling of flap signal (AfC = AfCAmp*cos(Azimuth+phase)+AfCmean) (-) [used only with AfCmode==1]
AfC_phase - Phase relative to the blade azimuth (0 is vertical) for for cosine cycling of flap signal (deg) [used only with AfCmode==1]
Cable control mode {0- none, 4- user-defined from Simulink/Labview, 5- user-defineAfC_phased from Bladed-style DLL}
Must be one of:
- 0
- 4
- 5
Compute nacelle tuned mass damper {true/false}
Name of the file for nacelle tuned mass damper (quoted string) [unused when CompNTMD is false]
Compute tower tuned mass damper {true/false}
Name of the file for tower tuned mass damper (quoted string) [unused when CompTTMD is false]
Name of procedure in DLL to be called (-) [case sensitive; used only with DLL Interface]
Communication interval for dynamic library (s) (or 'default') [used only with Bladed Interface]
Whether a linear ramp should be used between DLL_DT time steps [introduces time shift when true] (flag) [used only with Bladed Interface]
Cuttoff frequency for low-pass filter on blade pitch from DLL (Hz) [used only with Bladed Interface]
Reference yaw angle of the nacelle when the upwind end points due North (deg) [used only with Bladed Interface]
Record 28 Use individual pitch control {0 - collective pitch; 1 - individual pitch control} (switch) [used only with Bladed Interface]
Must be one of:
- 0
- 1
Record 5 Below-rated pitch angle set-point (deg) [used only with Bladed Interface]
Record 6 - Minimum pitch angle (deg) [used only with Bladed Interface]
Record 7 Maximum pitch angle (deg) [used only with Bladed Interface]
Record 8 Minimum pitch rate (most negative value allowed) (deg/s) [used only with Bladed Interface]
Record 9 Maximum pitch rate (deg/s) [used only with Bladed Interface]
Record 16 Optimal mode gain (Nm/(rad/s)^2) [used only with Bladed Interface]
Record 17 Minimum generator speed (rpm) [used only with Bladed Interface]
Record 18 Optimal mode maximum speed (rpm) [used only with Bladed Interface]
Record 19 Demanded generator speed above rated (rpm) [used only with Bladed Interface]
Record 22 Demanded generator torque above rated (Nm) [used only with Bladed Interface]
Record 13 Demanded power (W) [used only with Bladed Interface]
Record 26 No. of points in torque-speed look-up table {0 = none and use the optimal mode parameters; nonzero = ignore the optimal mode PARAMETERs by setting Record 16 to 0.0} (-) [used only with Bladed Interface]
Print summary data to '<RootName>.sum' (flag)
Switch to determine where output will be placed 1 in module output file only; 2 in glue code output file only; 3 both (currently unused)
Use tab delimiters in text tabular output file (flag) (currently unused)
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Time to begin tabular output (s) (currently unused)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
ServoDyn modelling options in OpenFAST
Echo the input file data (flag)
Water density (kg/m^3)
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Water depth (meters)
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Offset between still-water level and mean sea level (meters) [positive upward; unused when WaveMod = 6; must be zero if PotMod=1 or 2]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Half-width of the domain in the X direction (m) [>0, NOTE: X[nX] = nX*dX, where nX = {-NX+1,-NX+2,…,NX-1} and dX = X_HalfWidth/(NX-1)]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Half-width of the domain in the Y direction (m) [>0, NOTE: Y[nY] = nY*dY, where nY = {-NY+1,-NY+2,…,NY-1} and dY = Y_HalfWidth/(NY-1)]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Depth of the domain the Z direction (m) relative to SWL [0 < Z_Depth <= WtrDpth+MSL2SWL;
Number of nodes in half of the X-direction domain (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Number of nodes in half of the Y-direction domain (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Number of nodes in the Z direction (-) [>=2]
Value must be greater or equal to 2 and lesser or equal to 200
Incident wave kinematics model {0- none/still water, 1- regular (periodic), 1P#- regular with user-specified phase, 2- JONSWAP/Pierson-Moskowitz spectrum (irregular), 3- White noise spectrum (irregular), 4- user-defined spectrum from routine UserWaveSpctrm (irregular), 5- Externally generated wave-elevation time series, 6- Externally generated full wave-kinematics time series [option 6 is invalid for PotMod/=0]} (switch)
Must be one of:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
Model for stretching incident wave kinematics to instantaneous free surface {0 = none=no stretching, 1 = vertical stretching, 2 = extrapolation stretching, 3 = Wheeler stretching} (switch) [unused when WaveMod=0 or when PotMod/=0]
Must be one of:
- 0
- 1
- 2
- 3
Analysis time for incident wave calculations (sec) [unused when WaveMod=0; determines WaveDOmega=2Pi/WaveTMax in the IFFT]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Time step for incident wave calculations (sec) [unused when WaveMod=0; 0.1<=WaveDT<=1.0 recommended; determines WaveOmegaMax=Pi/WaveDT in the IFFT]
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Significant wave height of incident waves (meters) [used only when WaveMod=1 or 2]. These inputs will be determined by the DLCDriver options (waveheight).
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Peak spectral period of incident waves (sec) [used only when WaveMod=1 or 2]. These inputs will be determined by the DLCDriver options (waveperiod).
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Peak-shape parameter of incident wave spectrum (-) or DEFAULT (string) [used only when WaveMod=2; use 1.0 for Pierson-Moskowitz]. These inputs will be determined by the DLCDriver options (wavegamma).
Value must be greater or equal to 1 and lesser or equal to 7
Low cut-off frequency or lower frequency limit of the wave spectrum beyond which the wave spectrum is zeroed (rad/s) [unused when WaveMod=0, 1, or 6]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
High cut-off frequency or upper frequency limit of the wave spectrum beyond which the wave spectrum is zeroed (rad/s) [unused when WaveMod=0, 1, or 6]
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Incident wave propagation heading direction [unused when WaveMod=0 or 6]. These inputs will be determined by the DLCDriver options (wavedirection).
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
Directional spreading function {0 = none, 1 = COS2S} [only used when WaveMod=2,3, or 4]
Must be one of:
- 0
- 1
Wave direction spreading coefficient ( > 0 ) [only used when WaveMod=2,3, or 4 and WaveDirMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Number of wave directions [only used when WaveMod=2,3, or 4 and WaveDirMod=1; odd number only]
Must be one of:
- 1
- 3
- 5
- 7
- 9
- 11
- 13
- 15
- 17
- 19
- 21
- 23
- 25
- 27
- 29
- 31
- 33
- 35
- 37
- 39
- 41
- 43
- 45
- 47
- 49
Range of wave directions (full range = WaveDir +/- 1/2*WaveDirRange) (degrees) [only used when WaveMod=2,3,or 4 and WaveDirMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 360
First random seed of incident waves [-2147483648 to 2147483647] [unused when WaveMod=0, 5, or 6]. These inputs will be determined by the DLCDriver options (waveseed).
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Second random seed of incident waves [-2147483648 to 2147483647] [unused when WaveMod=0, 5, or 6]. Use RANLUX for internal FAST pseudo-random number generator
Flag for normally distributed amplitudes [only used when WaveMod=2, 3, or 4]
Root name of externally generated wave data file(s) (quoted string) [used only when WaveMod=5 or 6]
Full difference-frequency 2nd-order wave kinematics (flag)
Full summation-frequency 2nd-order wave kinematics (flag)
Low frequency cutoff used in the difference-frequencies (rad/s) [Only used with a difference-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
High frequency cutoff used in the difference-frequencies (rad/s) [Only used with a difference-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Low frequency cutoff used in the summation-frequencies (rad/s) [Only used with a summation-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
High frequency cutoff used in the summation-frequencies (rad/s) [Only used with a summation-frequency method]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Constrained wave model: 0=none; 1=Constrained wave with specified crest elevation, alpha; 2=Constrained wave with guaranteed peak-to-trough crest height, HCrest (flag)
Must be one of:
- 0
- 1
- 2
Crest height (2*alpha for ConstWaveMod=1 or HCrest for ConstWaveMod=2), must be larger than WaveHs (m) [unused when ConstWaveMod=0]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Time at which the crest appears (s) [unused when ConstWaveMod=0]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
X-position of the crest (m) [unused when ConstWaveMod=0]
Y-position of the crest (m) [unused when ConstWaveMod=0]
Current profile model {0 = none=no current, 1 = standard, 2 = user-defined from routine UserCurrent} (switch)
Must be one of:
- 0
- 1
- 2
Sub-surface current velocity at still water level (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Sub-surface current heading direction (radians) or 0.0 for default [used only when CurrMod=1]
Value must be lesser or equal to 6.283185307179586
Near-surface current reference depth (meters) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Near-surface current velocity at still water level (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Near-surface current heading direction (degrees) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
Depth-independent current velocity (m/s) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Depth-independent current heading direction (radians) [used only when CurrMod=1]
Value must be greater or equal to 0.0 and lesser or equal to 6.283185307179586
MacCamy-Fuchs member radius (ignored if radius <= 0) [must be 0 when WaveMod 0 or 6]
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
Output a summary file [flag]
Output requested channels to: [1=SeaState.out, 2=GlueCode.out, 3=both files]
Must be one of:
- 1
- 2
- 3
Format used for text tabular output (except time). Resulting field should be 10 characters. (quoted string (currently unused)
Output format for header strings (quoted string) [not checked for validity!]
Number of points where the incident wave elevations can be computed (-) [maximum of 9 output locations]
Value must be greater or equal to 0 and lesser or equal to 9
List of xi-coordinates for points where the incident wave elevations can be output (meters) [NWaveElev points, separated by commas or white space; usused if NWaveElev = 0]
No Additional ItemsEach item of this array must be:
List of yi-coordinates for points where the incident wave elevations can be output (meters) [NWaveElev points, separated by commas or white space; usused if NWaveElev = 0]
No Additional ItemsEach item of this array must be:
Number of points where the wave kinematics can be output (-) [maximum of 9 output locations]
Value must be greater or equal to 0 and lesser or equal to 9
List of xi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
List of yi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
List of zi-coordinates for points where the wave kinematics can be output (meters) [NWaveKin points, separated by commas or white space; usused if NWaveKin = 0]
No Additional ItemsEach item of this array must be:
Add additional OpenFAST channels to the output files
Add items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdd items here with the format of 'VariableName: True'
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether we derive OpenFAST model from an existing model and ignore WISDEM
Only used if from_openfast is set to True. Path to yaml file containing output data of the turbine tabulated against wind speed (rotor speed, blade pitch angle, aero thrust coefficient) needed to initialize the OpenFAST model through
Main (.fst) OpenFAST input file name. No directory.
OpenFAST input directory, containing .fst file. Absolute path or relative to modeling input
File path to xfoil executable (e.g. /home/user/Xfoil/bin/xfoil)
Whether or not to run xfoil in parallel (requires mpi setup)
No Additional Items
Each item of this array must be:
IEC design load case to run. The DLCs currently supported are 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 5.1, 6.1, 6.3, and 6.4
Must be one of:
- "1.1"
- "1.2"
- "1.3"
- "1.4"
- "1.5"
- "1.6"
- "2.1"
- "2.2"
- "2.3"
- "2.4"
- "3.1"
- "3.2"
- "3.3"
- "4.1"
- "4.2"
- "5.1"
- "6.1"
- "6.2"
- "6.3"
- "6.4"
- "6.5"
- "7.1"
- "7.2"
- "9.1"
- "9.2"
- "10.1"
- "10.2"
- "12.1"
- "steady"
- "step"
- "ramp"
- "AEP"
- "freedecay"
- "force_excursion"
- "userwind"
- "userwave"
Wind speeds for this DLC. If these are defined, wsbinsize is neglected.
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 200.0
Size of the wind speed bin between cut in and cout out wind speeds. It usually can be set to 2 m/s. This entry is neglected if the wind speeds are specified by the user.
Value must be greater or equal to 0.01 and lesser or equal to 20.0
Number of turbulent wind seeds drawn from the numpy random integer generator. This entry is neglected if the entry wind_seed is defined. If DLC 1.4, number of waves seeds.
Value must be greater or equal to 1 and lesser or equal to 100
Number of azimuth initial conditions to use (primarily during DLC 5.1)
Value must be greater or equal to 1 and lesser or equal to 100
Array of turbulent wind seeds for TurbSim. If these are defined, n_seeds is neglected.
No Additional ItemsEach item of this array must be:
Wind direction from north. This array must currently have either length=1, i.e. one constant value, or the same length of the array wind_speed.
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -180.0 and lesser or equal to 180.0
Alignment of the nacelle with respect to north. This array must currently have either length=1, i.e. one constant value, or the same length of the array windspeed. Default depends on DLC, specified in dlcgenerator.
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -180.0 and lesser or equal to 180.0
Status of the turbine, it can be either operating, parked-idling, or parked-still. Each DLC come with its default turbine status specified by the standards.
Must be one of:
- "operating"
- "parked-idling"
- "parked-still"
Wave random number generator seeds for HydroDyn
No Additional ItemsEach item of this array must be:
Period between waves. If this array is populated by the user, then the field metoceanconditions is neglected. If waveperiod is not defined, metocean_conditions will be used, either in the values provided by the user or with its default values (the first option is highly recommended).
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Height of the waves. If this array is populated by the user, then the field metoceanconditions is neglected. If waveheight is not defined, metocean_conditions will be used, either in the values provided by the user or with its default values (the first option is highly recommended).
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Heading of the waves with respect to north. This array must currently have either length=1, i.e. one constant value, or the same length of the array wind_speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to -180.0 and lesser or equal to 180.0
Peak-shape parameter of incident wave spectrum. If 0, the default from IEC61400-3 / HydroDyn is used. This array must currently have either length=1, i.e. one constant value, or the same length of the array wind_speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 10.0
Spectrum of the waves. This array must currently have either length=1, i.e. one constant spectrum, or the same length of the array wind_speed
No Additional ItemsEach item of this array must be:
Must be one of:
- "JONSWAP"
- "unit"
Probability of occurrance for each case. This entry is relevant only for DLC 1.2 and 6.4. This array must currently have either length=1, i.e. one constant value, or the same length of the array windspeedfatigue.
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1.0
IEC turbulence type ('NTM'=normal, 'xETM'=extreme turbulence, 'xEWM1'=extreme 1-year wind, 'xEWM50'=extreme 50-year wind, where x=wind turbine class 1, 2, or 3), 'ECD'=extreme coherent gust with direction change, 'EDC'=extreme direction change, 'EOG'=extreme operating gust. Normally the user does not need to define this entry, 'EWS'='extreme wind shear'
Must be one of:
- "NTM"
- "1ETM"
- "2ETM"
- "3ETM"
- "1EWM1"
- "2EWM1"
- "3EWM1"
- "1EWM50"
- "2EWM50"
- "3EWM50"
- "ECD"
- "EDC"
- "EOG"
- "EWS"
- "NWP"
- "Steady"
- "Ramp"
- "Step"
This is the length of the simulation where outputs will be recorded. Its default is 600 seconds (10 minutes) for most simulations, except for the coherent cases where a shorter time window of 200 s is used.
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
This is the length of the simulation where outputs will be discarded. Its default is 120 seconds (2 minutes) for all simulations. The total simulation time is the sum of analysistime and transienttime
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Time when shutdown occurs in DLC 5.1
Value must be greater or equal to 0.0 and lesser or equal to 100000.0
File path of custom wind file
The fraction of the TI, relative to the class defined in the geometry options or by turbulence_class
The class of turbulence, will overwrite class defined in geometry options. Only valid in the AEP DLC.
Must be one of:
- "A+"
- "A"
- "B"
- "C"
Define additional groups to alter DLCs or sweep additional parameters. Users can input single values to change all of the simulations in a DLC, multiple values to add an additional group to sweep over, or a list of new groups in the yaml format.
These are all inputs to TurbSim. These inputs usually do not need to be set unless you are trying to customize a DLC
Flag switching between steady wind and turbulent wind grid from TurbSim.
Echo input data to <RootName>.ech (flag)
First random seed (-2147483648 to 2147483647)
Second random seed (-2147483648 to 2147483647)
Output hub-height turbulence parameters in binary form (Generates RootName.bin)
Output hub-height turbulence parameters in formatted form (Generates RootName.dat)
Output hub-height time-series data in AeroDyn form (Generates RootName.hh)
Output full-field time-series data in TurbSim/AeroDyn form (Generates RootName.bts)
Output full-field time-series data in BLADED/AeroDyn form (Generates RootName.wnd)
Output tower time-series data (Generates RootName.twr)
Output full-field time-series data in formatted (readable) form (Generates RootName.u, RootName.v, RootName.w)
Output coherent turbulence time steps in AeroDyn form (Generates RootName.cts)
Clockwise rotation looking downwind (used only for full-field binary files - not necessary for AeroDyn)
Scale IEC turbulence models to exact target standard deviation [0=no additional scaling; 1=use hub scale uniformly; 2=use individual scales]
Must be one of:
- 0
- 1
- 2
Vertical grid-point matrix dimension
Value must be greater or equal to 5 and lesser or equal to 100
Horizontal grid-point matrix dimension
Value must be greater or equal to 5 and lesser or equal to 100
Time step [seconds]
Value must be greater or equal to 0.0001 and lesser or equal to 1.0
Usable length of output time series [seconds] (program will add GridWidth/MeanHHWS seconds unless UsableTime is 'ALL')
Hub height [m] (should be > 0.5*GridHeight)
Value must be greater or equal to 0 and lesser or equal to 500.0
Grid height [m]
Value must be greater or equal to 0 and lesser or equal to 500.0
Grid width [m] (should be >= 2*(RotorRadius+ShaftLength))
Value must be greater or equal to 0 and lesser or equal to 500.0
Vertical mean flow (uptilt) angle [degrees]
Value must be greater or equal to -90.0 and lesser or equal to 90.0
Horizontal mean flow (skew) angle [degrees]
Value must be greater or equal to -90.0 and lesser or equal to 90.0
Turbulence model
Must be one of:
- "IECKAI"
- "IECVKM"
- "GP_LLJ"
- "NWTCUP"
- "SMOOTH"
- "WF_UPW"
- "WF_07D"
- "WF_14D"
- "TIDAL"
- "API"
- "USRINP"
- "TIMESR"
- "NONE"
Name of the file that contains inputs for user-defined spectra or time series inputs (used only for "USRINP" and "TIMESR" models)
Number of IEC 61400-x standard (x=1,2, or 3 with optional 61400-1 edition number (i.e. "1-Ed2") )
Must be one of:
- "1-ED3"
- "1-ED2"
IEC Extreme Turbulence Model
Velocity profile type ('LOG';'PL'=power law;'JET';'H2L'=Log law for TIDAL model;'API';'USR';'TS';'IEC'=PL on rotor disk, LOG elsewhere; or 'default')
Must be one of:
- "LOG"
- "PL"
- "JET"
- "H2L"
- "API"
- "USR"
- "TS"
- "IEC"
- "LOG"
- "default"
Name of the file that contains input profiles for WindProfileType='USR' and/or TurbModel='USRVKM' [-]
Height of the reference velocity (URef) [m]
Value must be greater or equal to 0 and lesser or equal to 100000.0
URef is an input to TurbSim, but it's not honored in WEIS. Please use the wind_speed input to each DLC instead.
Turbulence intensity (fraction) for custom DLCs, if default (-1), the class letter will be used
Jet height [m] (used only for JET velocity profile, valid 70-490 m)
Power law exponent [-] (or 'default'), if default (-1), the environment option shear_exp will be used for all DLCs
Surface roughness length [m] (or 'default')
Site latitude [degrees] (or 'default')
Gradient Richardson number [-]
Friction or shear velocity [m/s] (or 'default')
Mixing layer depth [m] (or 'default')
Hub mean uw Reynolds stress [m^2/s^2] (or 'default' or 'none')
Hub mean uv Reynolds stress [m^2/s^2] (or 'default' or 'none')
Hub mean vw Reynolds stress [m^2/s^2] (or 'default' or 'none')
u-component coherence model ('GENERAL', 'IEC', 'API', 'NONE', or 'default')
v-component coherence model ('GENERAL', 'IEC', 'NONE', or 'default')
w-component coherence model ('GENERAL', 'IEC', 'NONE', or 'default')
u-component coherence parameters for general or IEC models [-, m^-1] (e.g. '10.0 0.3e-3' in quotes) (or 'default')
v-component coherence parameters for general or IEC models [-, m^-1] (e.g. '10.0 0.3e-3' in quotes) (or 'default')
w-component coherence parameters for general or IEC models [-, m^-1] (e.g. '10.0 0.3e-3' in quotes) (or 'default')
Coherence exponent for general model [-] (or 'default')
Name of the path where event data files are located
Type of event files
Must be one of:
- "LES"
- "DNS"
- "RANDOM"
Randomize the disturbance scale and locations (true/false)
Disturbance scale [-] (ratio of event dataset height to rotor disk). (Ignored when Randomize = true.)
Value must be greater or equal to 0 and lesser or equal to 1.0
Fractional location of tower centerline from right [-] (looking downwind) to left side of the dataset. (Ignored when Randomize = true.)
Value must be greater or equal to 0 and lesser or equal to 1.0
Fractional location of hub height from the bottom of the dataset. [-] (Ignored when Randomize = true.)
Value must be greater or equal to 0 and lesser or equal to 1.0
Minimum start time for coherent structures in RootName.cts
Value must be greater or equal to 0 and lesser or equal to 1000.0
Fix the seed of the random integer generator controlling the seed of TurbSim. When set to False, the seeds change everytime the DLC generator class is called. It is recommended to keep it to True when the optimization is on, or different wind seeds will be generated for every function call, complicating the smoothness of the solution space. Even when set to True, the wind seeds are different across wind speeds and DLCs.
Fix the seed of the random integer generator controlling the wave seed of HydroDyn. When set to False, the seeds change everytime the DLC generator class is called. It is recommended to keep it to True when the optimization is on, or different wave seeds will be generated for every function call, complicating the smoothness of the solution space. Even when set to True, the wave seeds are different across wind speeds and DLCs.
Here the metocean conditions can be specified in terms of wind speeds, significant wave height (Hs), and wave period (Tp) for normal sea state (NSS), fatigue calculations, and severe sea state (SSS). Currently WEIS neglects the joint probability density function crossing wind/wave directionality, wave peak shape parameter gamma
Array of wind speeds to tabulate Hs and Tp
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 50.0
Array of wind speeds to calculate fatigue
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0
Array of Hs for NSS conditional to wind speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Array of Tp for NSS conditional to wind speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Array of Hs for each fatigue bin
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Array of Tp for each fatigue bin
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Array of wave direction for each fatigue bin
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Array of wind direction for each fatigue bin
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Probability of occurrance for each fatigue bin in DLC 1.2
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1.0
Array of Hs for SSS conditional to wind speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Array of Tp for SSS conditional to wind speed
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Wave height with 50-year occurrence, used in DLC 6.1
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Wave period with 50-year occurrence, used in DLC 6.1
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Wave height with 1-year occurrence, used in DLC 6.3, 7.1, and 8.2
Value must be greater or equal to 0.0 and lesser or equal to 100.0
Wave period with 1-year occurrence, used in DLC 6.3, 7.1, and 8.2
Value must be greater or equal to 0.0 and lesser or equal to 1000.0
Users can add to the openfastinputmap of the DLC driver here, with key value pairs
Options for WEIS fidelity level 3 = nonlinear time domain. Inherited from ROSCO/rosco/toolbox/inputs/toolbox_shema.yaml
0- write no debug files, 1- write standard output .dbg-file, 2- write standard output .dbg-file and complete avrSWAP-array .dbg2-file
Value must be greater or equal to 0 and lesser or equal to 3
1- first-order low-pass filter, 2- second-order low-pass filter, [rad/s] (currently filters generator speed and pitch control signals)
Value must be greater or equal to 1 and lesser or equal to 2
Notch on the measured generator speed and/or tower fore-aft motion (for floating) {0- disable, 1- generator speed, 2- tower-top fore-aft motion, 3- generator speed and tower-top fore-aft motion}
Value must be greater or equal to 0 and lesser or equal to 3
Turn Individual Pitch Control (IPC) for fatigue load reductions (pitch contribution) (0- off, 1- 1P reductions, 2- 1P+2P reduction)
Value must be greater or equal to 0 and lesser or equal to 2
Generator torque control mode in above rated conditions (0- no torque control, 1- k*omega^2 with PI transitions, 2- WSE TSR Tracking, 3- Power-based TSR Tracking, 4- Torque-based TSR Tracking)
Value must be greater or equal to 0 and lesser or equal to 4
Do constant power torque control, where above rated torque varies, 0 for constant torque
Value must be greater or equal to 0 and lesser or equal to 1
Configuration for FBP mode (0- variable pitch (disabled), 1- constant power overspeed, 2- WSE-lookup reference tracking, 3- torque-lookup reference tracking)
Value must be greater or equal to 0 and lesser or equal to 3
Blade pitch control mode (0- No pitch, fix to fine pitch, 1- active PI blade pitch control)
Value must be greater or equal to 0 and lesser or equal to 1
Yaw control mode (0- no yaw control, 1- yaw rate control, 2- yaw-by-IPC)
Value must be greater or equal to 0 and lesser or equal to 2
Setpoint Smoother mode (0- no setpoint smoothing, 1- introduce setpoint smoothing)
Value must be greater or equal to 0 and lesser or equal to 2
Wind speed estimator mode (0- One-second low pass filtered hub height wind speed, 1- Immersion and Invariance Estimator (Ortega et al.)
Value must be greater or equal to 0 and lesser or equal to 2
Pitch saturation mode (0- no pitch saturation, 1- peak shaving, 2- Cp-maximizing pitch saturation, 3- peak shaving and Cp-maximizing pitch saturation)
Value must be greater or equal to 0 and lesser or equal to 3
Startup mode (0- no startup procedure, 1- startup enabled)
Value must be greater or equal to 0 and lesser or equal to 1
Shutdown mode (0- no shutdown procedure, 1- enable shutdown)
Value must be greater or equal to 0 and lesser or equal to 1
Tower damper mode (0- no tower damper, 1- feed back translational nacelle accelleration to pitch angle
Value must be greater or equal to 0 and lesser or equal to 1
Tower resonance avoidance mode (0- no tower resonsnace avoidance, 1- use torque control setpoints to avoid a specific frequency
Value must be greater or equal to 0 and lesser or equal to 1
Floating specific feedback mode (0- no nacelle velocity feedback, 1 - nacelle velocity feedback, 2 - nacelle pitching acceleration feedback)
Value must be greater or equal to 0 and lesser or equal to 2
Flap control mode (0- no flap control, 1- steady state flap angle, 2- Proportional flap control)
Value must be greater or equal to 0 and lesser or equal to 2
Active Power Control Mode (0- no active power control 1- constant active power control, 2- open loop power vs time, 3- open loop power vs. wind speed)
Value must be greater or equal to 0 and lesser or equal to 2
ZMQ Mode (0 - ZMQ Inteface, 1 - ZMQ for yaw control)
Value must be greater or equal to 0 and lesser or equal to 1
Call ZeroMQ every [x] seconds, [s]
Value must be greater or equal to 0
Pitch actuator mode {0 - not used, 1 - first order filter, 2 - second order filter}
Value must be greater or equal to 0 and lesser or equal to 2
Pitch fault mode {0 - not used, 1 - constant offset on one or more blades, 2- pitch stuck at last values}
Value must be greater or equal to 0 and lesser or equal to 1
Open loop control mode {0- no open loop control, 1- open loop control}
Value must be greater or equal to 0 and lesser or equal to 2
Active wake control mode {0 - not used, 1 - SNL method, 2 - NREL method}
Value must be greater or equal to 0 and lesser or equal to 2
External control mode [0 - not used, 1 - call external dynamic library]
Value must be greater or equal to 0 and lesser or equal to 1
Cable control mode [0- unused, 1- User defined, 2- Open loop control]
Value must be greater or equal to 0 and lesser or equal to 2
Structural control mode [0- unused, 1- User defined, 2- Open loop control]
Value must be greater or equal to 0 and lesser or equal to 2
List of wind speeds to schedule pitch control zeta and omega
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
List of pitch controller desired damping ratio at U_pc [-]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
List of pitch controller desired natural frequency at U_pc [rad/s]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
Type of interpolation between above rated tuning values (only used for multiple pitch controller tuning values)
Must be one of:
- "sigma"
- "linear"
- "quadratic"
- "cubic"
Torque controller desired damping ratio [-]
Value must be greater or equal to 0
Torque controller desired natural frequency [rad/s]
Value must be greater or equal to 0
Maximum pitch angle [rad], {default = 90 degrees}
Minimum pitch angle [rad]
Minimum rotor speed [rad/s], {default = 0 rad/s}
Torque controller setpoint smoother gain bias percentage [%, <= 1 ], {default = 100%}
Pitch controller setpoint smoother gain bias percentage [%, <= 1 ], {default = 0.1%}
Decrease torque control gain by this amount (fraction)
Percent peak shaving [%, <= 1 ], {default = 80%}
Value must be lesser or equal to 1
Maximum (and minimum) flap pitch angle [rad]
Tower natural frequency, for floating only
Value must be greater or equal to 0
Platform natural frequency, for floating only
Value must be greater or equal to 0
Number of wind speed breakpoints
Value must be greater or equal to 0
Number of pitch angle gain scheduling breakpoints
Value must be greater or equal to 0
Gain(s) of floating feedback control
Whether to automatically tune Kp_float
List of wind speeds for tuning floating feedback, or "all" for all above-rated wind speeds
No Additional ItemsEach item of this array must be:
Flap controller desired damping ratio [-]
Value must be greater or equal to 0
Flap controller desired natural frequency [rad/s]
Value must be greater or equal to 0
Flap controller normalization term for DC gain (kappa)
Value must be greater or equal to 0
Flap controller time constant for integral gain
Value must be greater or equal to 0
Maximum torque = rated torque * maxtorquefactor
Value must be greater or equal to 0
Proportional gain for IPC, 1P [s]
Value must be greater or equal to 0
Proportional gain for IPC, 2P [-]
Value must be greater or equal to 0
Integral gain for IPC, 1P [s]
Value must be greater or equal to 0
integral gain for IPC, 2P [-]
Value must be greater or equal to 0
wind speeds for IPC cut-in sigma function [m/s]
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0.0
Factor on VS_Rgn2K to increase/decrease optimal torque control gain, default is 1. Sometimes environmental conditions or differences in BEM solvers necessitate this change.
Value must be greater or equal to 0
Interpretation mode for VSFBPP (0- scale relative to rated power, 1- absolute power)
Value must be greater or equal to 0 and lesser or equal to 1
Overspeed or underspeed operating schedule (0- underspeed, 1- overspeed)
Value must be greater or equal to 0 and lesser or equal to 1
List of wind speeds to schedule user-defined power curve for fixed blade pitch (FBP) control in Region 3
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
List of points defining power curve for fixed blade pitch (FBP) control in Region 3, relative or absolute based on VSFBPpower_mode
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
Corner frequency (-3dB point) in the first order low pass filter of the generator speed [rad/s]
Value must be greater or equal to 0
Damping ratio in the first order low pass filter of the generator speed [-]
Value must be greater or equal to 0
Corner frequency (-3dB point) in the first order low pass filter for the wind speed estimate [rad/s]
Value must be greater or equal to 0
Natural frequency of first-order high-pass filter for nacelle fore-aft motion [rad/s]
Value must be greater or equal to 0
First order low-pass filter cornering frequency for setpoint smoother [rad/s]
Value must be greater or equal to 0
Low pass filter corner frequency for yaw controller [rad/
Value must be greater or equal to 0
Cutoff Frequency for first order low-pass filter for blade pitch angle for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}
Cutoff Frequency for first order low-pass filter for yaw error for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}
Cutoff Frequency for first order low-pass filter for generator speed for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}
Corner frequency (-3dB point) in the first order low pass filter for TSR tracking torque control [rad/s]
Value must be greater or equal to 0
Flag to use open loop control
Filename of open loop input that ROSCO reads
Breakpoint mode for open loop control, 0 - indexed by time (default), 1 - indexed by wind speed
Value must be greater or equal to 0 and lesser or equal to 1
Index (column, 1-indexed) of breakpoint (time) in open loop index
Value must be greater or equal to 0
Indices (columns, 1-indexed) of pitch (1,2,3) inputs in open loop input
No Additional ItemsEach item of this array must be:
Value must be greater or equal to 0
Index (column, 1-indexed) of generator torque in open loop input
Value must be greater or equal to 0
Index (column, 1-indexed) of nacelle yaw in open loop input
Value must be greater or equal to 0
The column in OLFilename that contains the desired azimuth position in rad (used if OLMode = 2)
Index (column, 1-indexed) of power rating via speed offset
Value must be greater or equal to 0
Index (column, 1-indexed) of power rating via torque offset
Value must be greater or equal to 0
Index (column, 1-indexed) of power rating via pitch offset
Value must be greater or equal to 0
The column in OL_Filename that contains the cable control inputs in m
No Additional ItemsEach item of this array must be:
The column in OL_Filename that contains the structural control inputs in various units
No Additional ItemsEach item of this array must be:
Pitch actuator natural frequency [rad/s]
Value must be greater or equal to 0
Pitch actuator damping ratio [-]
Value must be greater or equal to 0
These are pass-through parameters for the DISCON.IN file. Use with caution. Do not set defaults in schema.
(0- write no debug files, 1- write standard output .dbg-file, 2- write standard output .dbg-file and complete avrSWAP-array .dbg2-file)
0 - no Echo, 1 - Echo input data to <RootName>.echo
Time step to output .dbg* files, or 0 to match sampling period of OpenFAST
0 - use standard bladed interface, 1 - Use the extened DLL interface introduced in OpenFAST 3.5.0.
Value must be greater or equal to 0 and lesser or equal to 1
1- first-order low-pass filter, 2- second-order low-pass filter (currently filters generator speed and pitch control signals
Generator torque control mode in above rated conditions (0- no torque control, 1- k*omega^2 with PI transitions, 2- WSE TSR Tracking, 3- Power-based TSR Tracking, 4- Torque-based TSR Tracking)
Value must be greater or equal to 0 and lesser or equal to 4
Do constant power torque control, where above rated torque varies
Value must be greater or equal to 0 and lesser or equal to 1
Configuration for FBP mode (0- variable pitch (disabled), 1- constant power overspeed, 2- WSE-lookup reference tracking, 3- torque-lookup reference tracking)
Value must be greater or equal to 0 and lesser or equal to 3
Notch on the measured generator speed and/or tower fore-aft motion (for floating) (0- disable, 1- generator speed, 2- tower-top fore-aft motion, 3- generator speed and tower-top fore-aft motion)
Turn Individual Pitch Control (IPC) for fatigue load reductions (pitch contribution) (0- off, 1- 1P reductions, 2- 1P+2P reductions)
Blade pitch control mode (0- No pitch, fix to fine pitch, 1- active PI blade pitch control)
Yaw control mode (0- no yaw control, 1- yaw rate control, 2- yaw-by-IPC)
Setpoint Smoother mode (0- no setpoint smoothing, 1- introduce setpoint smoothing)
Wind speed estimator mode (0- One-second low pass filtered hub height wind speed, 1- Immersion and Invariance Estimator, 2- Extended Kalman Filter)
Pitch saturation mode (0- no pitch saturation, 1- implement pitch saturation)
Startup mode (0- no startup procedure, 1- startup enabled)
Shutdown mode (0- no shutdown procedure, 1- enable shutdown)
Floating specific feedback mode (0- no nacelle velocity feedback, 1- feed back translational velocity, 2- feed back rotational veloicty)
Flap control mode (0- no flap control, 1- steady state flap angle, 2- Proportional flap control)
Open loop control mode (0 - no open-loop control, 1 - direct open loop control, 2 - rotor position control)
Corner frequency (-3dB point) in the low-pass filters,
Damping coefficient (used only when F_FilterType = 2 [-]
Number of notch filters placed on sensors
Natural frequency of the notch filters. Array with length F_NumNotchFilts
No Additional ItemsEach item of this array must be:
Damping value of numerator (determines the width of notch). Array with length F_NumNotchFilts, [-]
No Additional ItemsEach item of this array must be:
Damping value of denominator (determines the depth of notch). Array with length F_NumNotchFilts, [-]
No Additional ItemsEach item of this array must be:
Number of notch filters on generator speed
Number of notch filters on tower top acceleration signal
Indices of notch filters on generator speed
No Additional ItemsEach item of this array must be:
Indices of notch filters on tower top acceleration signal
No Additional ItemsEach item of this array must be:
Corner frequency (-3dB point) in the first order low pass filter for the setpoint smoother,
Corner frequency (-3dB point) in the first order low pass filter for the wind speed estimate
Natural frequency and damping in the second order low pass filter of the tower-top fore-aft motion for floating feedback control
No Additional ItemsEach item of this array must be:
Natural frequency of first-order high-pass filter for nacelle fore-aft motion
Corner frequency and damping in the second order low pass filter of the blade root bending moment for flap control
No Additional ItemsEach item of this array must be:
Corner frequency (-3dB point) in the first order low pass filter of the generator speed reference used for TSR tracking torque control [rad/s].
Amount of gain-scheduling table entries
Gain-schedule table- pitch angles
No Additional ItemsEach item of this array must be:
Gain-schedule table- pitch controller kp gains
No Additional ItemsEach item of this array must be:
Gain-schedule table- pitch controller ki gains
No Additional ItemsEach item of this array must be:
Gain-schedule table- pitch controller kd gains
No Additional ItemsEach item of this array must be:
Gain-schedule table- pitch controller tf gains (derivative filter)
No Additional ItemsEach item of this array must be:
Maximum physical pitch limit,
Minimum physical pitch limit,
Maximum pitch rate (in absolute value) in pitch controller
Minimum pitch rate (in absolute value) in pitch controller
Desired (reference) HSS speed for pitch controller
Record 5- Below-rated pitch angle set-point
Angle above lowest minimum pitch angle for switch
Integrator saturation (maximum signal amplitude contribution to pitch from IPC)
IPC Saturation method (0 - no saturation, 1 - saturate by PCMinPit, 2 - saturate by PSBldPitchMin)
Proportional gain for the individual pitch controller- first parameter for 1P reductions, second for 2P reductions, [-]
No Additional ItemsEach item of this array must be:
Integral gain for the individual pitch controller- first parameter for 1P reductions, second for 2P reductions, [-]
No Additional ItemsEach item of this array must be:
Phase offset added to the azimuth angle for the individual pitch controller
No Additional ItemsEach item of this array must be:
Corner frequency of the first-order actuators model, to induce a phase lag in the IPC signal (0- Disable)
Generator efficiency mechanical power -> electrical power, should match the efficiency defined in the generator properties
Above rated generator torque PI control saturation
Maximum torque rate (in absolute value) in torque controller
Maximum generator torque in Region 3 (HSS side)
Minimum generator torque (HSS side)
Minimum generator speed
Generator torque constant in Region 2 (HSS side). Only used in VS_ControlMode = 1,3,4
Wind turbine rated power
Rated torque
Rated generator speed
Number of generator PI torque controller gains
Proportional gain for generator PI torque controller. (Only used in the transitional 2.5 region if VS_ControlMode =/ 2)
Integral gain for generator PI torque controller (Only used in the transitional 2.5 region if VS_ControlMode =/ 2)
Power-maximizing region 2 tip-speed-ratio. Only used in VS_ControlMode = 2.
Variable speed torque controller setpoint smoother gain
Collective pitch controller setpoint smoother gain
Power reference tracking mode, 0- use standard rotor speed set points, 1- use PRC rotor speed setpoints
Array of wind speeds used in rotor speed vs. wind speed lookup table [m/s]
No Additional ItemsEach item of this array must be:
Array of generator speeds corresponding to PRC_WindSpeeds [rad/s]
No Additional ItemsEach item of this array must be:
Frequency of the low pass filter on the wind speed estimate used to set PRC_GenSpeeds [rad/s]
Number of elements in PRCWindSpeeds and PRCGenSpeeds array
Power reference communication mode when PRC_Mode = 2, 0- use constant DISCON inputs, 1- use open loop inputs, 2- use ZMQ inputs
Constant power rating through changing the rated torque, used if PRCMode = 2, PRCComm = 0, default is 1, effective above rated [-]
Constant power rating through changing the rated generator speed, used if PRCMode = 2, PRCComm = 0, default is 1, effective above rated [-]
Constant power rating through changing the fine pitch angle, used if PRCMode = 2, PRCComm = 0, default is 1, effective below rated [-]
Number of elements in PRC_R to Pitch table. Used if PRCMode = 1.
Table of fine pitch versus PRCRTable, length should be PRCTablen [rad]. Used if PRC_Mode = 1.
No Additional ItemsEach item of this array must be:
Table of turbine rating versus fine pitch (PRCPitchTable), length should be PRCTablen, default is 1 [-]. Used if PRC_Mode = 1.
No Additional ItemsEach item of this array must be:
Rotor speed for exclusion [LSS, rad/s]
Value must be greater or equal to 0
Size of the rotor frequency exclusion band [LSS, rad/s]. Torque controller reference will be TRAExclSpeed +/- TRAExlBand/2
Value must be greater or equal to 0
Rate limit of change in rotor speed reference [LSS, rad/s]. Suggested to be VS_RefSpd/400.
Value must be greater or equal to 0
Blade length (distance from hub center to blade tip)
Amount of parameters in the Cp array
Parameters that define the parameterized CP(lambda) function
No Additional ItemsEach item of this array must be:
Adaption gain of the wind speed estimator algorithm
Gearbox ratio, >=1
Total drivetrain inertia, including blades, hub and casted generator inertia to LSS
Air density
File containing rotor performance tables (Cp,Ct,Cq) (absolute path or relative to this file)
Size of rotor performance tables, first number refers to number of blade pitch angles, second number referse to number of tip-speed ratios
Number of first-order system poles used in EKF
Wind speeds corresponding to first-order system poles
No Additional ItemsEach item of this array must be:
First order system poles
No Additional ItemsEach item of this array must be:
Yaw error threshold. Turbine begins to yaw when it passes this
Integrator saturation (maximum signal amplitude contribution to pitch from yaw-by-IPC)
Number of controller gains (yaw-by-IPC)
Yaw-by-IPC proportional controller gain Kp
Yaw-by-IPC integral controller gain Ki
Low-pass filter corner frequency for the Yaw-by-IPC controller to filtering the yaw alignment error
Low-pass filter damping factor for the Yaw-by-IPC controller to filtering the yaw alignment error.
Yaw alignment error, set point
Corner frequency fast low pass filter, 1.0
Corner frequency slow low pass filter, 1/60
Yaw rate
Integral gain for the fore-aft tower damper controller, -1 = off / >0 = on
Corner frequency (-3dB point) in the high-pass filter on the fore-aft acceleration signal
Integrator saturation (maximum signal amplitude contribution to pitch from FA damper)
Number of values in minimum blade pitch lookup table (should equal number of values in PSWindSpeeds and PSBldPitchMin)
Wind speeds corresponding to minimum blade pitch angles
No Additional ItemsEach item of this array must be:
Minimum blade pitch angles
No Additional ItemsEach item of this array must be:
Time to start startup routine [s]
Free-wheel minimum duration [s]
Rotor speed threshhold to switch from freewheel to loads [rad/s]
Cutoff Frequency for first order low-pass filter for rotor speed for startup [rad/s]
Number of load staged for startup (should equal number of values in SULoadStages, SULoadRampDuration and SU_LoadHoldDuration)
Array containing loads as a fraction of full generator torque during startup
No Additional ItemsEach item of this array must be:
Array containing ramp duration to reach the corresponding partial loads during startup [s]
No Additional ItemsEach item of this array must be:
Array containing duration to hold the partial loads during startup [s]
No Additional ItemsEach item of this array must be:
Time to acitvate shutdown modes [s]
Shutdown when collective blade pitch exceeds a threshold
Value must be greater or equal to 0 and lesser or equal to 1
Shutdown when yaw error exceeds a threshold
Value must be greater or equal to 0 and lesser or equal to 1
Shutdown when generator speed exceeds a threshold
Value must be greater or equal to 0 and lesser or equal to 1
Shutdown at a predefined time
Value must be greater or equal to 0 and lesser or equal to 1
Maximum blade pitch angle to initiate shutdown
Cutoff Frequency for first order low-pass filter for blade pitch angle for shutdown,
Maximum yaw error to initiate shutdown
Cutoff Frequency for first order low-pass filter for yaw error for shutdown
Maximum generator speed to initiate shutdown
Cutoff Frequency for first order low-pass filter for generator speed for shutdown
Shutdown time [s]
Shutdown method {1- Reduce generator torque and increase blade pitch in timed stages (SDStageTime), 2- stages depend on pitch angle (SDStagePitch)}
Value must be greater or equal to 1 and lesser or equal to 2
Maximum torque rate for shutdown [Nm/s]
No Additional ItemsEach item of this array must be:
Maximum pitch rate used for shutdown [rad/s]
No Additional ItemsEach item of this array must be:
Array containing the time to spend in each shutdown stage [s]
No Additional ItemsEach item of this array must be:
Array with pitch angles to reach in each shutdown stage [rad]. If the pitch < SDStagePitch[i], the SDStage = i. If pitch > SDStagePitch[SDStage_N], the maximum rates are used.
No Additional ItemsEach item of this array must be:
Number of shutdown stages (should equal number of values in SDMaxPitchRate and SDMaxTorqueRate) [-]
Number of Fl_Kp gains in gain scheduling, optional with default of 1
Nacelle velocity proportional feedback gain
No Additional ItemsEach item of this array must be:
Wind speeds for scheduling FlKp, optional if FlKp is single value [m/s]
No Additional ItemsEach item of this array must be:
Initial or steady state flap angle
Blade root bending moment proportional gain for flap control
Flap displacement integral gain for flap control
Maximum (and minimum) flap pitch angle
Input file with open loop timeseries (absolute path or relative to this file)
Breakpoint mode for open loop control, 0 - indexed by time (default), 1 - indexed by wind speed
Natural frequency of 1st order filter on breakpoint for open loop control. 0 will skip filter.
The column in OLFilename that contains the breakpoint (time if OLMode > 0)
The column in OL_Filename that contains the blade pitch input in rad
The column in OL_Filename that contains the generator torque in Nm
The column in OL_Filename that contains the generator torque in Nm
The column in OLFilename that contains the desired azimuth position in rad (used if OLMode = 2)
PID gains and Tf of derivative for rotor position control (used if OL_Mode = 2)
No Additional ItemsEach item of this array must be:
Index (column, 1-indexed) of power rating via speed offset
Value must be greater or equal to 0
Index (column, 1-indexed) of power rating via torque offset
Value must be greater or equal to 0
Index (column, 1-indexed) of power rating via pitch offset
Value must be greater or equal to 0
The column in OL_Filename that contains the cable control inputs in m
No Additional ItemsEach item of this array must be:
The column in OL_Filename that contains the structural control inputs in various units
No Additional ItemsEach item of this array must be:
Name/location of the dynamic library {.dll [Windows] or .so [Linux]} in the Bladed-DLL format
Name of input file sent to the DLL
Name of procedure in DLL to be called
Pitch angle offsets for each blade (array with length of 3), only used if PF_Mode = 1
No Additional ItemsEach item of this array must be:
Time pitch actuator becomes stuck at last value for each blade (array with length of 3), only used if PF_Mode = 2
No Additional ItemsEach item of this array must be:
Number of cable control groups
First index for cable control group, should correspond to deltaL
No Additional ItemsEach item of this array must be:
Time constant for line actuator [s]
Number of cable control groups
First index for structural control group, options specified in ServoDyn summary output
No Additional ItemsEach item of this array must be:
Active wake control mode {0 - not used, 1 - complex number method, 2 - Coleman transformation method, 3 to 5 - Closed-loop AWC}
Value must be greater or equal to 0 and lesser or equal to 5
Number of AWC modes
AWC azimuthal number (only used in complex number method)
No Additional ItemsEach item of this array must be:
AWC Coleman transform harmonic (only used in Coleman transform method)
No Additional ItemsEach item of this array must be:
AWC frequency [Hz]
No Additional ItemsEach item of this array must be:
AWC amplitude [deg]
No Additional ItemsEach item of this array must be:
AWC clock angle [deg]
No Additional ItemsEach item of this array must be:
Azimuth offset in the Coleman transformation [deg]
KP and KI/KR gain of the active wake controller [-]
No Additional ItemsEach item of this array must be:
Communication address for ZMQ server, (e.g. "tcp://localhost:5555")
Update period at zmq interface to send measurements and wait for setpoint [sec.]
Integer identifier of turbine
yaml file to tune the ROSCO controller, only used for control-only optimizations using an OpenFAST model. Absolute path or relative to modeling input.
Inputs used for tuning ROSCO using linear (level 2) models
Type of level 2 based tuning - robust gain scheduling (robust) or simulation based optimization (simulation)
Must be one of:
- "none"
- "robust"
- "simulation"
Path to OpenFAST linearization (.lin) files, if they exist
Path for outputs from linear model based tuning
Load linearization files in parallel (True/False)
Desired maximum stability margin
Pitch controller bandwidth constraints
Whether or not to run open loop to closed loop optimization
Directory where open loop control trajectories are located
Save error timeseries
Used to store file name of modeling options file
The field :code:environment includes the data characterizing air and water where the wind turbine operates.
Gravitational acceleration
Value must be greater or equal to 0 and lesser or equal to 100.0
Density of air.
Value must be greater or equal to 0 and lesser or equal to 1.5
Dynamic viscosity of air.
Value must be greater or equal to 0 and lesser or equal to 2e-05
Atmospheric pressure of air
Value must be greater or equal to 0 and lesser or equal to 1000000.0
Vapor pressure of fluid
Value must be greater or equal to 0 and lesser or equal to 1000000.0
Shape factor of the Weibull wind distribution.
Value must be greater or equal to 1 and lesser or equal to 3
Speed of sound in air.
Value must be greater or equal to 330.0 and lesser or equal to 350.0
Shear exponent of the atmospheric boundary layer.
Value must be greater or equal to 0 and lesser or equal to 1
Density of water.
Value must be greater or equal to 950 and lesser or equal to 1100
Dynamic viscosity of water.
Value must be greater or equal to 0.001 and lesser or equal to 0.002
Water depth for offshore environment.
Value must be greater or equal to 0.0 and lesser or equal to 10000.0
Shear modulus of the soil.
Value must be greater or equal to 10000000.0 and lesser or equal to 500000000.0
Poisson ratio of the soil.
Value must be greater or equal to 0 and lesser or equal to 0.6
Average inflow wind speed. If different than 0, this will overwrite the V mean of the IEC wind class
Value must be greater or equal to 0.0 and lesser or equal to 20.0
Average height of the highest one-third of waves in a wave record or time series (meters)
Value must be greater or equal to 0.01 and lesser or equal to 200
Average period of the highest one-third of waves in a wave record or time series (seconds)
Value must be greater or equal to 0.05 and lesser or equal to 1000.0