Skip to content

Commit

Permalink
Merge pull request #2416 from andrew-platt/b/ROM_registry_comments
Browse files Browse the repository at this point in the history 
SED+ADsk: update registry comments slightly
  • Loading branch information
@deslaughter
deslaughter authored Sep 13, 2024
2 parents 32ad558 + c95b0d7 commit 359209a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 25 deletions.
2 changes: 1 addition & 1 deletion modules/aerodisk/src/AeroDisk_Registry.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ typedef ^ InputType ReKi BlPitch - -

# ..... Outputs ...................................................................................................................
# outputs on meshes:
typedef ^ OutputType MeshType AeroLoads - - - "Mesh containing the forces and moments from the aero loading" -
typedef ^ OutputType MeshType AeroLoads - - - "Mesh containing the forces and moments from the aero loading (at HubMotion mesh)" -
#TODO: any mesh for visualization of blades/rotor disk?
# outputs not on meshes:
typedef ^ OutputType ReKi YawErr - - - "Nacelle-yaw error, i.e., the angle about positive Z from the rotor centerline to the rotor-disk-averaged relative wind velocity (ambient + rotor motion), both projected onto the horizontal plane" rad
Expand Down
2 changes: 1 addition & 1 deletion modules/aerodisk/src/AeroDisk_Types.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ MODULE AeroDisk_Types
! =======================
! ========= ADsk_OutputType =======
TYPE, PUBLIC :: ADsk_OutputType
TYPE(MeshType) :: AeroLoads !< Mesh containing the forces and moments from the aero loading [-]
TYPE(MeshType) :: AeroLoads !< Mesh containing the forces and moments from the aero loading (at HubMotion mesh) [-]
REAL(ReKi) :: YawErr = 0.0_ReKi !< Nacelle-yaw error, i.e., the angle about positive Z from the rotor centerline to the rotor-disk-averaged relative wind velocity (ambient + rotor motion), both projected onto the horizontal plane [rad]
REAL(ReKi) :: PsiSkew = 0.0_ReKi !< Azimuth angle (from the nominally vertical axis in the disk plane, Z_disk ) to the vector about which the inflow skew angle is defined, i.e., the angle about positive X_disk from Z_disk to the vector about which the positive inflow skew angle is defined [rad]
REAL(ReKi) :: ChiSkew = 0.0_ReKi !< Inflow skew angle [rad]
Expand Down
24 changes: 11 additions & 13 deletions modules/simple-elastodyn/src/SED_Registry.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ typedef ^ InitOutputType CHARACTER(ChanLen) WriteOutputUnt {:} -
typedef ^ InitOutputType ProgDesc Ver - - - "This module's name, version, and date" -
typedef ^ InitOutputType IntKi NumBl - - - "Number of blades on the turbine" -
typedef ^ InitOutputType ReKi BlPitch {:} - - "Initial blade pitch angles" radians
typedef ^ InitOutputType ReKi BladeLength - - - "Blade length (for AeroDyn)" meters
typedef ^ InitOutputType ReKi BladeLength - - - "Blade length (for AeroDsk)" meters
typedef ^ InitOutputType ReKi TowerHt - - - "Tower Height" meters
typedef ^ InitOutputType ReKi HubHt - - - "Height of the hub" meters
typedef ^ InitOutputType ReKi PlatformPos {6} - - "Initial platform position (6 DOFs)"
Expand All @@ -68,7 +68,7 @@ typedef ^ InitOutputType LOGICAL GenDOF - -

# ..... Inputs ....................................................................................................................
# inputs on meshes:
typedef ^ InputType MeshType HubPtLoad - - - "AeroDisk maps load to hub" -
typedef ^ InputType MeshType HubPtLoad - - - "AeroDyn/AeroDisk maps load to hub" -
# inputs not on meshes:
typedef ^ InputType ReKi HSSBrTrqC - - - "Commanded HSS brake torque" N-m
typedef ^ InputType ReKi GenTrq - - - "Electrical generator torque" N-m
Expand All @@ -79,11 +79,11 @@ typedef ^ InputType ReKi YawRateCom - -

# ..... Outputs ...................................................................................................................
# outputs on meshes:
typedef ^ OutputType MeshType BladeRootMotion {:} - - "For AeroDyn/BeamDyn: motions at the blade roots" -
typedef ^ OutputType MeshType HubPtMotion - - - "For AeroDyn and Lidar(InflowWind): motions of the hub" -
typedef ^ OutputType MeshType NacelleMotion - - - "For AeroDyn14 & ServoDyn/TMD: motions of the nacelle." -
typedef ^ OutputType MeshType TowerLn2Mesh - - - "Tower line2 mesh with positions/orientations/velocities/accelerations" -
typedef ^ OutputType MeshType PlatformPtMesh - - - "Platform reference point positions/orientations/velocities/accelerations" -
typedef ^ OutputType MeshType BladeRootMotion {:} - - "For AeroDyn: motions at the blade roots" -
typedef ^ OutputType MeshType HubPtMotion - - - "For AeroDyn/AeroDisk: motions of the hub" -
typedef ^ OutputType MeshType NacelleMotion - - - "For AeroDyn: for aero effects in AD (aero nacelle loads ignored)" -
typedef ^ OutputType MeshType TowerLn2Mesh - - - "Tower line2 mesh for visualization / Aero tower effects" -
typedef ^ OutputType MeshType PlatformPtMesh - - - "Platform reference point for visualization" -
#TODO: any mesh for visualization of blades/rotor disk?
# outputs not on meshes:
typedef ^ OutputType ReKi LSSTipPxa - - 2pi "Rotor azimuth angle (position)" radians
Expand All @@ -104,7 +104,7 @@ typedef ^ ContinuousStateType R8Ki QT {:} -
typedef ^ ContinuousStateType ^ QDT {:} - - "Current estimate of QD (velocity matrix) for each degree of freedom"

# Define discrete (nondifferentiable) states here:
typedef ^ DiscreteStateType ReKi DummyDiscreteState - - - "" -
typedef ^ DiscreteStateType ReKi DummyDiscreteState - - - "" -

# Define constraint states here:
typedef ^ ConstraintStateType ReKi DummyConstrState - - - "" -
Expand All @@ -116,7 +116,7 @@ typedef ^ OtherStateType IntKi IC {SED_NMX} -
typedef ^ OtherStateType ReKi HSSBrTrq - - - "HSSBrTrq from update states; a hack to get this working with a single integrator" -
typedef ^ OtherStateType ReKi HSSBrTrqC - - - "Commanded HSS brake torque (adjusted for sign)" N-m
typedef ^ OtherStateType IntKi SgnPrvLSTQ - - - "The sign of the low-speed shaft torque from the previous call to RtHS(). NOTE: The low-speed shaft torque is assumed to be positive at the beginning of the run!" -
typedef ^ OtherStateType IntKi SgnLSTQ {SED_NMX} - - "history of sign of LSTQ"
typedef ^ OtherStateType IntKi SgnLSTQ {SED_NMX} - - "history of sign of LSTQ (for HSS brake)"



Expand Down Expand Up @@ -150,10 +150,8 @@ typedef ^ ParameterType OutParmType OutParam {:} -

# ..... Misc/Optimization variables.................................................................................................
typedef ^ MiscVarType ReKi AllOuts {:} - - "Array of all outputs" -
#typedef ^ MiscVarType MeshMapType mapPtf2Twr - - - "Mesh mapping from Ptfm to Tower line" -
#typedef ^ MiscVarType MeshMapType mapTwr2Nac - - - "Mesh mapping from Tower to Nacelle" -
typedef ^ MiscVarType MeshMapType mapNac2Hub - - - "Mesh mapping from Nacelle to Hub" -
typedef ^ MiscVarType MeshMapType mapHub2Root {:} - - "Mesh mapping from Hub to BladeRootMotion" -
typedef ^ MiscVarType MeshMapType mapNac2Hub - - - "Mesh mapping from Nacelle to Hub (hub rotation overwritten in calc)" -
typedef ^ MiscVarType MeshMapType mapHub2Root {:} - - "Mesh mapping from Hub to BladeRootMotion (blade pitch overwritten in calc)" -
typedef ^ MiscVarType R8Ki QD2T {:} - - "Current estimate of first derivative of QD (acceleration matrix) for each degree of freedom"
typedef ^ MiscVarType ReKi HubPt_X {3} - - "X orientation of hub calculated in CalcOutput -- saving so we don't recalculate a bunch of things to get it in UpdateStates"

20 changes: 10 additions & 10 deletions modules/simple-elastodyn/src/SED_Types.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ MODULE SED_Types
TYPE(ProgDesc) :: Ver !< This module's name, version, and date [-]
INTEGER(IntKi) :: NumBl = 0_IntKi !< Number of blades on the turbine [-]
REAL(ReKi) , DIMENSION(:), ALLOCATABLE :: BlPitch !< Initial blade pitch angles [radians]
REAL(ReKi) :: BladeLength = 0.0_ReKi !< Blade length (for AeroDyn) [meters]
REAL(ReKi) :: BladeLength = 0.0_ReKi !< Blade length (for AeroDsk) [meters]
REAL(ReKi) :: TowerHt = 0.0_ReKi !< Tower Height [meters]
REAL(ReKi) :: HubHt = 0.0_ReKi !< Height of the hub [meters]
REAL(ReKi) , DIMENSION(1:6) :: PlatformPos = 0.0_ReKi !< Initial platform position (6 DOFs) [-]
Expand All @@ -89,7 +89,7 @@ MODULE SED_Types
! =======================
! ========= SED_InputType =======
TYPE, PUBLIC :: SED_InputType
TYPE(MeshType) :: HubPtLoad !< AeroDisk maps load to hub [-]
TYPE(MeshType) :: HubPtLoad !< AeroDyn/AeroDisk maps load to hub [-]
REAL(ReKi) :: HSSBrTrqC = 0.0_ReKi !< Commanded HSS brake torque [N-m]
REAL(ReKi) :: GenTrq = 0.0_ReKi !< Electrical generator torque [N-m]
REAL(ReKi) , DIMENSION(:), ALLOCATABLE :: BlPitchCom !< Commanded blade pitch angles [radians]
Expand All @@ -99,11 +99,11 @@ MODULE SED_Types
! =======================
! ========= SED_OutputType =======
TYPE, PUBLIC :: SED_OutputType
TYPE(MeshType) , DIMENSION(:), ALLOCATABLE :: BladeRootMotion !< For AeroDyn/BeamDyn: motions at the blade roots [-]
TYPE(MeshType) :: HubPtMotion !< For AeroDyn and Lidar(InflowWind): motions of the hub [-]
TYPE(MeshType) :: NacelleMotion !< For AeroDyn14 & ServoDyn/TMD: motions of the nacelle. [-]
TYPE(MeshType) :: TowerLn2Mesh !< Tower line2 mesh with positions/orientations/velocities/accelerations [-]
TYPE(MeshType) :: PlatformPtMesh !< Platform reference point positions/orientations/velocities/accelerations [-]
TYPE(MeshType) , DIMENSION(:), ALLOCATABLE :: BladeRootMotion !< For AeroDyn: motions at the blade roots [-]
TYPE(MeshType) :: HubPtMotion !< For AeroDyn/AeroDisk: motions of the hub [-]
TYPE(MeshType) :: NacelleMotion !< For AeroDyn: for aero effects in AD (aero nacelle loads ignored) [-]
TYPE(MeshType) :: TowerLn2Mesh !< Tower line2 mesh for visualization / Aero tower effects [-]
TYPE(MeshType) :: PlatformPtMesh !< Platform reference point for visualization [-]
REAL(ReKi) :: LSSTipPxa = 0.0_ReKi !< Rotor azimuth angle (position) [radians]
REAL(ReKi) :: RotSpeed = 0.0_ReKi !< Rotor azimuth angular speed [rad/s]
REAL(ReKi) :: RotPwr = 0.0_ReKi !< Rotor power [W]
Expand Down Expand Up @@ -139,7 +139,7 @@ MODULE SED_Types
REAL(ReKi) :: HSSBrTrq = 0.0_ReKi !< HSSBrTrq from update states; a hack to get this working with a single integrator [-]
REAL(ReKi) :: HSSBrTrqC = 0.0_ReKi !< Commanded HSS brake torque (adjusted for sign) [N-m]
INTEGER(IntKi) :: SgnPrvLSTQ = 0_IntKi !< The sign of the low-speed shaft torque from the previous call to RtHS(). NOTE: The low-speed shaft torque is assumed to be positive at the beginning of the run! [-]
INTEGER(IntKi) , DIMENSION(1:SED_NMX) :: SgnLSTQ = 0_IntKi !< history of sign of LSTQ [-]
INTEGER(IntKi) , DIMENSION(1:SED_NMX) :: SgnLSTQ = 0_IntKi !< history of sign of LSTQ (for HSS brake) [-]
END TYPE SED_OtherStateType
! =======================
! ========= SED_ParameterType =======
Expand Down Expand Up @@ -174,8 +174,8 @@ MODULE SED_Types
! ========= SED_MiscVarType =======
TYPE, PUBLIC :: SED_MiscVarType
REAL(ReKi) , DIMENSION(:), ALLOCATABLE :: AllOuts !< Array of all outputs [-]
TYPE(MeshMapType) :: mapNac2Hub !< Mesh mapping from Nacelle to Hub [-]
TYPE(MeshMapType) , DIMENSION(:), ALLOCATABLE :: mapHub2Root !< Mesh mapping from Hub to BladeRootMotion [-]
TYPE(MeshMapType) :: mapNac2Hub !< Mesh mapping from Nacelle to Hub (hub rotation overwritten in calc) [-]
TYPE(MeshMapType) , DIMENSION(:), ALLOCATABLE :: mapHub2Root !< Mesh mapping from Hub to BladeRootMotion (blade pitch overwritten in calc) [-]
REAL(R8Ki) , DIMENSION(:), ALLOCATABLE :: QD2T !< Current estimate of first derivative of QD (acceleration matrix) for each degree of freedom [-]
REAL(ReKi) , DIMENSION(1:3) :: HubPt_X = 0.0_ReKi !< X orientation of hub calculated in CalcOutput -- saving so we don't recalculate a bunch of things to get it in UpdateStates [-]
END TYPE SED_MiscVarType
Expand Down

0 comments on commit 359209a

Please sign in to comment.