OpenFAST
Wind turbine multiphysics simulator
Public Attributes | List of all members
waves_types::waves_initinputtype Type Reference

Public Attributes

character(1024) inputfile
 Name of the input file [-].
 
character(1024) dirroot
 The name of the root file including the full path. More...
 
character(1024) wvkinfile
 The root name of user input wave kinematics files [-].
 
logical writewvkin
 Flag indicating whether we are going to write out kinematics files. More...
 
integer(intki) unsum
 The unit number for the HydroDyn summary file [-].
 
real(reki) gravity
 Gravitational acceleration [(m/s^2)].
 
real(reki) msl2swl
 Offset between still-water level and mean sea level [positive upward; must be zero if using WAMIT] [(meters)].
 
real(siki) wvlowcoff
 Low cut-off frequency or lower frequency limit of the wave spectrum beyond which the wave spectrum is zeroed. More...
 
real(siki) wvhicoff
 High cut-off frequency or upper frequency limit of the wave spectrum beyond which the wave spectrum is zeroed. More...
 
real(siki) wavedir
 Mean incident wave propagation heading direction [(degrees)].
 
integer(intki) wavendir
 Number of wave directions [only used if WaveDirMod = 1] [Must be an odd number – will be adjusted within the waves module] [(-)].
 
logical wavemultidir
 Indicates the waves are multidirectional – set by HydroDyn_Input [-].
 
integer(intki) wavedirmod
 Directional wave spreading function {0: none, 1: COS2S} [only used if WaveMod=6] [-].
 
real(siki) wavedirspread
 Spreading coefficient [WaveMod=2,3,4 and WaveDirMod=1] [-].
 
real(siki) wavedirrange
 Range of wave directions (full range: WaveDir +/- WaveDirRange/2) [only used if WaveMod=6] [(degrees)].
 
real(dbki) wavedt
 Time step for incident wave calculations [(sec)].
 
real(siki) wavehs
 Significant wave height of incident waves [(meters)].
 
integer(intki) wavemod
 Incident wave kinematics model {0: none=still water, 1: plane progressive (regular), 2: JONSWAP/Pierson-Moskowitz spectrum (irregular), 3: white-noise spectrum, 4: user-defind spectrum from routine UserWaveSpctrm (irregular), 5: GH BLADED } [-].
 
character(80) wavemodchr
 String to temporarially hold the value of the wave kinematics input line [-].
 
logical wavendamp
 Flag for normally-distributed amplitudes in incident waves spectrum [flag] [-].
 
real(siki) wavephase
 Specified phase for regular waves [(radians)].
 
real(siki) wavepkshp
 Peak shape parameter of incident wave spectrum [1.0 for Pierson-Moskowitz] [-].
 
character(80) wavepkshpchr
 String to temporarially hold value of peak shape parameter input line [-].
 
integer(intki), dimension(1:2) waveseed
 Random seeds of incident waves [-2147483648 to 2147483647] [-].
 
integer(intki) wavestmod
 Model for stretching incident wave kinematics to instantaneous free surface {0: none=no stretching, 1: vertical stretching, 2: extrapolation stretching, 3: Wheeler stretching} [-].
 
real(dbki) wavetmax
 Analysis time for incident wave calculations; the actual analysis time may be larger than this value in order for the maintain an effecient FFT [(sec)].
 
real(siki) wavetp
 Peak spectral period of incident waves [(sec)].
 
real(siki) wtrdens
 Water density [(kg/m^3)].
 
real(siki) wtrdpth
 Water depth [(meters)].
 
integer(intki) nwaveelev
 Number of points where the incident wave elevations can be output [-].
 
real(siki), dimension(:), allocatable waveelevxi
 xi-coordinates for points where the incident wave elevations can be output [(meters)]
 
real(siki), dimension(:), allocatable waveelevyi
 yi-coordinates for points where the incident wave elevations can be output [(meters)]
 
real(siki), dimension(:,:), allocatable waveelevxy
 Supplied by Driver: X-Y locations for WaveElevation output (for visualization). More...
 
integer(intki) nwavekin
 Number of points where the incident wave kinematics will be computed [-].
 
real(siki), dimension(:), allocatable wavekinxi
 xi-coordinates for points where the incident wave kinematics will be computed; these are relative to the mean sea level [(meters)]
 
real(siki), dimension(:), allocatable wavekinyi
 yi-coordinates for points where the incident wave kinematics will be computed; these are relative to the mean sea level [(meters)]
 
real(siki), dimension(:), allocatable wavekinzi
 zi-coordinates for points where the incident wave kinematics will be computed; these are relative to the mean sea level [(meters)]
 
real(siki), dimension(:), allocatable currvxi
 xi-component of the current velocity at elevation i [(m/s)]
 
real(siki), dimension(:), allocatable currvyi
 yi-component of the current velocity at elevation i [(m/s)]
 
real(siki) pcurrvxipz0
 xi-component of the partial derivative of the current velocity at elevation near mean sea level [(m/s)]
 
real(siki) pcurrvyipz0
 yi-component of the partial derivative of the current velocity at elevation near mean sea level [(m/s)]
 
type(nwtc_randomnumber_parametertype) rng
 Parameters for the pseudo random number generator [-].
 

Member Data Documentation

◆ dirroot

character(1024) waves_types::waves_initinputtype::dirroot

The name of the root file including the full path.

This may be useful if you want this routine to write a permanent record of what it does to be stored with the simulation results: the results should be stored in a file whose name (including path) is generated by appending any suitable extension to DirRoot. [-]

◆ waveelevxy

real(siki), dimension(:,:), allocatable waves_types::waves_initinputtype::waveelevxy

Supplied by Driver: X-Y locations for WaveElevation output (for visualization).

Index 1 corresponds to X or Y coordinate. Index 2 corresponds to point number. [-]

◆ writewvkin

logical waves_types::waves_initinputtype::writewvkin

Flag indicating whether we are going to write out kinematics files.

[Must be FALSE if WaveMod = 5 or 6, if TRUE then WvKinFile must have a string value and this is the rootname for all the output files] [-]

◆ wvhicoff

real(siki) waves_types::waves_initinputtype::wvhicoff

High cut-off frequency or upper frequency limit of the wave spectrum beyond which the wave spectrum is zeroed.

[used only when WaveMod=2,3,4] [(rad/s)]

◆ wvlowcoff

real(siki) waves_types::waves_initinputtype::wvlowcoff

Low cut-off frequency or lower frequency limit of the wave spectrum beyond which the wave spectrum is zeroed.

[used only when WaveMod=2,3,4] [(rad/s)]


The documentation for this type was generated from the following file: