New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactoring classes and properties - part 3 #828
Conversation
Review from @nathanmtom refer to #822 (comment) for full (unedited) review Working review comments: Body Class
Wave Class
Simulation Class
Cable Class
Other Comments
|
@H0R5E do you know why the tests stopped running on this PR? |
@kmruehl, no, I don't know why. V strange. |
indeed... |
Actions are degraded. You'll need to wait for a fix. |
A few more comments on our refactoring: Wave Class
Simulation Class Class setAccess and getAccess:
Help / documentation:
|
@akeeste and @nathanmtom This branch is currently stable and passing all tests so I'm going to merge this PR and open a new one to address the remaining comments. |
* body and cable dispVol to volume * initDisp to initial * initLinDisp to displacement initAngularDispAngle to angle initAngularDispAxis to axis * save library to 2020b * cable rotLoc1 and rotLoc2 to baseLocation and followerLocation * cable cg1 cb1 to baseCg baseCg, cg2 cb2 to followerCg and followerCb * cable bodyMass and bodyInertia to mass and momOfInertia * class formatting * waves.T to waves.period and waves.H to waves.height * resolve waveClass runfromSimulink bug * body.cg to body.centerGravity * library to 2020b * body.cb to body.centerBuoyancy * library to 2020b * bodyClass and cableClass momOfInertia to intertia * convert cableClass to base and follower structures
All outstanding comments from this PR have mean migrated to #832 for resolution |
This PR is a continuation of #803 and #822
Objectives:
pto.loc
versusmooring.ref
struct(body.morison)
simu.yaw
tobody.yaw
Wave Class
waves.etaImport
towaves.waveImport
towaves.elevationImport
waves.spectrumDataFile
towaves.waveSpectrumFile
towaves.spectrumFile
waves.etaDataFile
towaves.waveElevationFile
towaves.elevationFile
waves.plotEta
towaves.plotElevation
waves.waveDir
towaves.waveDirection
towaves.direction
waves.waveSpread
towaves.spread
beta
totheta
to match online documentationwaves.deepWaterWave
towaves.deepWater
waves.current
properties to structure, similar to morison element,waves.currentOption
towaves.current.option
waves.currentDepth
towaves.current.depth
waves.currentDirection
towaves.current.direction
waves.currentSpeed
towaves.current.speed
waves.bem
structurewaves.numFreq
towaves.freqNum
towaves.bem.count
waves.freqDisc
towaves.bem.option
waves.freqRange
towave.bem.range
waves.marker
properties to structurewaves.markerLoc
towaves.marker.loc
towaves.marker.location
waves.markerSize
towaves.marker.size
waves.markerStyle
towaves.marker.style
waves.marker
properties to structure in Frames Librarywaves.T
towaves.period
waves.H
towaves.height
Simulation Class
simu.writetxt
tosimu.writeText
tosimu.saveText
waves.waveStatisticsDataLoad
tosimu.mcrExcelFile
(formerly Wave Class)simu.mcrCaseFile
tosimu.mcrMatFile
simu.dtME
tosimu.morisonDt
simu.CTTime
tosimu.cicTime
simu.dtCI
tosimu.cicDt
simu.CITime
tosimu.cicEndTime
simu.CIkt
tosimu.cicLength
simu.ssCalc
tosimu.stateSpace
simu.setupSimu
tosimu.simuSetup
tosimu.setup
simu.paraview
properties to structure, similar to morison element, note: test that sub-properties are testedsimu.dtParaview
tosimu.paraviewDt
tosimu.paraview.dt
simu.StartTimeParaview
tosimu.paraviewStartTime
tosimu.paraview.startTime
simu.EndTimeParaview
tosimu.paraviewEndTime
tosimu.paraview.endTime
simu.pathParaviewVideo
tosimu.paraviewDirectory
tosimu.paraview.path
simu.numWecBodies
tosimu.body.numHydroBodies
simu.pressureDis
tosimu.pressure
simu.simulationDate
tosimu.date
simu.adjMassWeightFun
tosimu.adjMassFactor
simu.autoRateTranBlk
tosimu.rateTransition
simu.zeroCrossCont
tosimu.zeroCross
simu.numIntMidTimeSteps
removedparallelComputing_dir
topctDir
NOTE this is not in the simulationClass, but maybe it should beBody Class
body.dof_start
tobody.dofStart
body.dof_end
tobody.dofEnd
body.dof_gbm
tobody.dofGBM
tobody.gbmDOF
body.nlHydro
tobody.nonlinearHydro
body.lenJ
tobody.dofCoupled
body.meanDriftForce
tobody.meanDrift
body.bodyparaview
tobody.paraviewBody
tobody.paraview
body.flexHydroBody
tobody.flexBody
tobody.flex
body.nhBody
tobody.nonHydroBody
tobody.nonHydro
body.hydroDataBodyNum
tobody.hydroBodyTotal
tobody.hydroTotal
NOTE Do we even use this?body.viscDrag
tobody.viscousDrag
tobody.quadDrag
body.userDefinedExcIRF
tobody.excitationIRF
simu.yaw
andsimu.yawThresh
to bodyClasssimu.yaw
tobody.yaw.option
simu.yawThres
tobody.yaw.threshold
body.bodyNumber
tobody.number
body.bodyTotal
tobody.total
body.bodyGeometry
tobody.geometry
from @nathanmtom
quadDrag.Drag
toquadDrag.drag
morisonElement.characteristicArea
tomorisonElement.area
quadDrag.characteristicArea
toquadDrag.area
dispVol
todisplacedVolume
tovolume
body.initDisp.initLinDisp
tobody.initDisp.initLinearDisp
tobody.initial.displacement
body.initDisp.initAngularDispAngle
tobody.initial.angle
body.initDisp.initAngularDispAxis
tobody.initial.axis
cg
tocenterGravity
cb
tocenterBuoyancy
momOfInertia
tointertia
Cable Class
cable.c
tocable.damping
cable.k
tocable.stiffness
cable.viscDrag
tocable.viscousDrag
tocable.quadDrag
cable.cableNum
tocable.number
cable.loc
tocable.location
from @nathanmtom
cable.dispVol
tocable.displacedVolume
tocable.volume
cable.quadDrag.characteristicArea
toquadDrag.area
cable.quadDrag.Drag
toquadDrag.drag
cable.initDisp.initLinDisp
tocable.initDisp.initLinearDisp
tocable.initial.displacement
cable.initDisp.initAngularDispAngle
tocable.initial.angle
cable.initDisp.initAngularDispAxis
tocable.initial.axis
cable.L0
tocable.unstretchedLength
tpcable.length
cable.bodyMass
tocable.mass
cable.bodyInertia
tocable.momOfInertia
tocable.intertia
cable.base
andcable.follower
structurecable.cb1
tocable.centerBuoyancyBase
tocable.baseCb
tocable.base.centerBuoyancy
cable.cg1
tocable.centerGravityBase
tocable.baseCg
tocable.base.centerGravity
cable.rotloc1
tocable.rotationLocation1
tocable.baseLocation
to tocable.base.location
cable.baseConnectionName
tocable.base.name
cable.cb2
tocable.centerBuoyancyFollower
tocable.followerCb
tocable.follower.centerBuoyancy
cable.cg2
tocable.centerGravityFollower
tocable.followerCg
tocable.follower.centerGravity
cable.rotloc2
tocable.rotationLocation2
tocable.followerLocation
tocable.follower.location
cable.followerConnectionName
tocable.follower.name
Constraint Class
constraint.loc
toconstraint.location
constraint.constraintNum
toconstraint.number
from @nathanmtom
constraint.initDisp.initLinDisp
toconstraint.initDisp.initLinearDisp
toconstraint..initial.displacement
PTO Class
pto.loc
topto.location
pto.c
topto.damping
pto.k
topto.stiffness
pto.ptoNum
topto.number
from @nathanmtom
pto.initDisp.initLinDisp
topto.initDisp.initLinearDisp
topto.initial.displacement
Mooring Class
mooring.ref
tomooring.loc
tomooring.location
mooring.loc
tomooring.orientation
(internal)mooring.mooringNum
tomooring.number
from @nathanmtom
mooring.initDisp.initLinDisp
tomooring.initDisp.initLinearDisp
tomooring.initial.displacement
mooring.initDisp.initAngularDispAngle
tomooring.initial.angle
mooring.initDisp.initAngularDispAxis
tomooring.initial.axis
Doc
Notes
waves.bems
is specified in the input file, but not forwaves.bem.options
. This can be addressed by adding some additional checks to thecheckinputs
method of each class with a structure.TestPassiveYawRegression
test failurewecSimPCT
issuepctDir
to simulationClass?