Class: wsim.simSettings¶
wsim.simSettings handles simulation parameters and settings for a WEC
simulation.
wsim.simSettings Methods:
simSettings - wsim.simSettings constructor
checkInputs - Validate user input for simulation
listInfo - Prints simulation info to the command line
rhoDensitySetup - Assigns density and gravity values
setupSim - Sets simulation properties based on values specified in input file
Parent Class Properties and Methods¶
handle¶
Inheirited Properties¶
None
Inheirited Methods¶
- addlistener : ADDLISTENER Add listener for event.
- addlistener : ADDLISTENER Add listener for event.
- addlistener : ADDLISTENER Add listener for event.
- addlistener : ADDLISTENER Add listener for event.
- addlistener : ADDLISTENER Add listener for event.
- delete : DELETE Delete a handle object.
- eq : == (EQ) Test handle equality.
- findobj : FINDOBJ Find objects matching specified conditions.
- findprop : FINDPROP Find property of MATLAB handle object.
- ge : >= (GE) Greater than or equal relation for handles.
- gt : > (GT) Greater than relation for handles.
- isvalid : ISVALID Test handle validity.
- le : <= (LE) Less than or equal relation for handles.
- listener : LISTENER Add listener for event without binding the listener to the source object.
- listener : LISTENER Add listener for event without binding the listener to the source object.
- listener : LISTENER Add listener for event without binding the listener to the source object.
- listener : LISTENER Add listener for event without binding the listener to the source object.
- listener : LISTENER Add listener for event without binding the listener to the source object.
- lt : < (LT) Less than relation for handles.
- ne : ~= (NE) Not equal relation for handles.
- notify : NOTIFY Notify listeners of event.
- notify : NOTIFY Notify listeners of event.
Properties¶
- CITime
- CIkt
- CTTime
- addedMassMethod
- adjMassWeightFun
- b2b
- caseDir
- disableAddedMassForce
- disableRadiationForce
- domainSize
- dt
- dtCITime
- dtFeNonlin
- endTime
- g
- linearDamping
- maxIt
- mcrCaseFile
- morrisonElement
- nlHydro
- numWecBodies
- paraview
- rampT
- rho
- simulationDate
- ssCalc
- startTime
- time
- verbose
- version
- viscousDamping
CITime¶
Convolution integral time span (default = 60 s)
CIkt¶
Number of timesteps in the convolution integral length
CTTime¶
Convolution integral time series (default = dependent)
addedMassMethod¶
- option controlling how added mass forces are calculated
Must contain one of ‘extrap’ or ‘iterate’.
- ‘extrap’ : If ‘extrap’ is used, the added mass forces are
- calculated using accelerations determined by extrapolation from the previous time steps.
- ‘iterate’ : If ‘iterate’ is used, the added mass forces are
- calculated by iterating the solution until the forces and motions converge.
The default is ‘extrap’ and generally this performs well, however, if this results in unusual results such as rapid oscillations in the added mass force, try the ‘iterate’ method. The ‘iterate’ method will be considerably slower than the ‘extrap’ method.
adjMassWeightFun¶
Weighting function for adjusting added mass term in the translational direction (default = 2)
b2b¶
Option for body2body interactions: off->false, on->true, (default = false)
caseDir¶
Simulation case directory
disableAddedMassForce¶
- true/false flag for disabling the added
- mass force calculation. This option is primarily intended for debugging purposes. If true, the added mass forces will be set to zero, and the adjustments to the mass and inertia will also not take place.
disableRadiationForce¶
- true/false flag for disabling the
- radiation damping force calculation. This option is primarily intended for debugging purposes. If true, the radiation forces will be set to zero.
domainSize¶
Size of free surface and seabed. This variable is only used for visualization (default = 200 m)
dt¶
Simulation time step (default = 0.1 s)
dtCITime¶
Sample time to calculate Convolution Integral (default = dt)
dtFeNonlin¶
Sample time to calculate nonlinear forces (default = dt)
endTime¶
Simulation end time (default = 500 s)
g¶
Acceleration due to gravity (default = 9.81 m/s)
linearDamping¶
Option for Linear Damping calculation: Off->’0’, On->’1’, (default = 1)
maxIt¶
Total number of simulation time steps (default = dependent)
mcrCaseFile¶
mat file that contain a list of the multiple conditions runs with given conditions
morrisonElement¶
Option for Morrison Element calculation: Off->’0’, On->’1’, (default = 0)
nlHydro¶
Option for nonlinear hydrohanamics calculation: linear->’0’, nonlinear->’1’, (default = 0)
numWecBodies¶
Number of hydrodynamic bodies that comprise the WEC device (default = [])
paraview¶
Option for writing vtp files for paraview visualization.
rampT¶
Ramp time for wave forcing (default = 100 s)
rho¶
Density of water (default = 1000 kg/m^3)
simulationDate¶
Simulation date and time
ssCalc¶
Option for convolution integral or state-space calculation: convolution integral->0, state-space->1, (default = 0)
startTime¶
Simulation start time (default = 0 s)
time¶
Simulation time [s] (default = 0 s)
verbose¶
flag determining whether to print information (about the wsim.simSettings object) to the command line
version¶
WEC-Sim version
viscousDamping¶
Option for Viscous Damping calculation: Off->’0’, On->’1’, (default = 1)
Methods¶
- simSettings
- checkInputs
- listInfo
- rhoDensitySetup
- setupSim
simSettings¶
Summary¶
wsim.simSettings constructor
Syntax¶
ssobj = wsim.simSettings (casedir)
ssobj = wsim.simSettings (..., 'Parameter', Value)
Description¶
wsim.simSettings creates a new wsim.simSettings object.
Inputs¶
casedir¶
root directory containing the simulation data
files. This directory is expected to have two
subdirectories 'hydroData', where hydrodynamic data fiels
will be searched for, and 'geometry', where geometry files
(e.g. stl files will be searched for.
Additional arguments may be supplied as parameter-value pairs:
Verbose¶
true/false flag indicating whether to print
information (about the simSettings) to the command line.
Does not effect the level of output from any other parts
of the simulation system. Default is false.
Outputs¶
ssobj¶
wsim.simSettings object
See Also¶