Skip to content

Commit

Permalink
Fixing documentation inconsistency for PTO-Sim blocks (WEC-Sim#1330)
Browse files Browse the repository at this point in the history 
* Fixing documentation inconsistency for PTO-Sim blocks

* Adding comments to nondimensional values for clarification
  • Loading branch information
@jleonqu
jleonqu authored Oct 5, 2024
1 parent f5a7603 commit 685d4cc
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions source/objects/ptoSimClass.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
'k2', 'NOT DEFINED',... % [m^2/N] Valve coefficient
'Amin', 'NOT DEFINED',... % [m^2] Minimum valve area
'Amax', 'NOT DEFINED',... % [m^2] Maximum valve area
'Cd', 'NOT DEFINED') % [1] Discharge coefficient
'Cd', 'NOT DEFINED') % [1] - % nondimensional % - Discharge coefficient
directLinearGenerator (1,1) struct = struct(... % Linear crank block properties
'tau_p', 'NOT DEFINED',... % Magnet pole pitch
'theta_d_0', 'NOT DEFINED',... % Initial theta value
Expand All @@ -55,25 +55,25 @@
'lambda_sq_0', 'NOT DEFINED',... % Stator q-axis flow linkage
'Rload', 'NOT DEFINED') % External load
electricGeneratorEC (1,1) struct = struct(... % Electric Machine - Equivalent Circuit
'Ra', 0.1,... % [ohm] Initial displacement of the piston measured from port A
'La', 0.1,... % [H] Piston Area, side A
'Ra', 0.1,... % [ohm] Armature resistance
'La', 0.1,... % [H] Armature inductance
'Ke', 0.1,... % [V/(rad/s)] Back emf constant
'Jem', 0.1,... % [kg*m^2] Bulk modulus of the hydraulic fluid
'bShaft', 0.1,... % [N*m*s] Bulk modulus of the hydraulic fluid
'Jem', 0.1,... % [kg*m^2] Motor inertia
'bShaft', 0.1,... % [N*m*s] Shaft damping coefficient
'currentIni', 0.0,... % [A] Electric motor current initial value
'wShaftIni', 0.0) % [rpm] Shaft speed initial value
gasHydAccumulator (1,1) struct = struct(... % hydraulic Block properties
gasHydAccumulator (1,1) struct = struct(... % Hydraulic Accumulator Block properties
'vI0', 0.1,... % [m^3] Initial gas volume
'pIprecharge', 0.1) % [pa] Accumulator Precharge
hydPistonCompressible (1,1) struct = struct(... % hydraulic Block properties
hydPistonCompressible (1,1) struct = struct(... % Hydraulic Piston Block properties
'xi_piston', 'NOT DEFINED',... % [m] Initial displacement of the piston measured from port A
'Ap_A', 'NOT DEFINED',... % [m^2] Piston Area, side A
'Ap_B', 'NOT DEFINED',... % [m^2] Piston Area, side B
'bulkModulus', 'NOT DEFINED',... % [Pa] Bulk modulus of the hydraulic fluid
'pistonStroke', 'NOT DEFINED',... % [m] Piston Stroke
'pAi', 'NOT DEFINED',... % [pa] Side A initial pressure
'pBi', 'NOT DEFINED') % [pa] Side B initial pressure
hydraulicMotor (1,1) struct = struct(... % hydraulic Block properties
hydraulicMotor (1,1) struct = struct(... % Hydraulic Motor Block properties
'displacement', 'NOT DEFINED',... % [cc/rev] Volumetric displacement
'effModel', 'NOT DEFINED',... % 1 for Analytical or 2 for tabulated
'effTableShaftSpeed', 'NOT DEFINED',... % Vector with shaft speed data for efficiency
Expand All @@ -84,7 +84,7 @@
'deltaPNominal', 'NOT DEFINED',... % [Pa] Matrix with vol. efficiency data
'visNominal', 'NOT DEFINED',... % [m^2/s] Nominal kinematic viscosity at which the nominal efficiency is measured
'densityNominal', 'NOT DEFINED',... % [kg/m^3] Nominal fluid density at which the nominal efficiency is measured
'effVolNom', 'NOT DEFINED',... % [1] Volumetric efficiency at nominal conditions
'effVolNom', 'NOT DEFINED',... % [1] - % nondimensional % - Volumetric efficiency at nominal conditions
'torqueNoLoad', 'NOT DEFINED',... % [Nm] No load torque
'torqueVsPressure', 'NOT DEFINED',... % [Nm/Pa] Friction torque vs pressure drop coefficient
'rho', 'NOT DEFINED',... % [kg/m^3] Actual fluid density. It could be different than the nominal fluid density
Expand All @@ -94,18 +94,18 @@
'offset', 'NOT DEFINED',... % [m] Offset length
'rodLength', 'NOT DEFINED') % [m] Rod length
%name (1,:) {mustBeText} = 'NOT DEFINED' % Electric Block Name
rectifyingCheckValve (1,1) struct = struct(... % hydraulic Block properties
'Cd', 'NOT DEFINED',... % Discharge accumulator
'Amax', 'NOT DEFINED',... % Maximum opening area of the valve
'Amin', 'NOT DEFINED',... % Minimum opening area of the valve
'pMax', 'NOT DEFINED',... % Pressure at maximum opening
'pMin', 'NOT DEFINED',... % Cracking pressure
'rho', 'NOT DEFINED',... % Fluid density
'k1', 'NOT DEFINED',... % Valve coefficiente
'k2', 'NOT DEFINED') % Valve coefficient, it's a function of the other valve variables
simpleDirectDrivePTO (1,1) struct = struct(... % simple direct drive linear PTO Block properties
rectifyingCheckValve (1,1) struct = struct(... % Rectifying Check Valve Block properties
'Cd', 'NOT DEFINED',... % [1] - % nondimensional % - Discharge coefficient
'Amax', 'NOT DEFINED',... % [m^2] Maximum opening area of the valve
'Amin', 'NOT DEFINED',... % [m^2] Minimum opening area of the valve
'pMax', 'NOT DEFINED',... % [Pa] Pressure at maximum opening
'pMin', 'NOT DEFINED',... % [Pa] Cracking pressure
'rho', 'NOT DEFINED',... % [kg/m^3] Fluid density
'k1', 'NOT DEFINED',... % [1] - % nondimensional % - Valve coefficiente
'k2', 'NOT DEFINED') % [1] - % nondimensional % - Valve coefficient --- it's a function of the other valve variables
simpleDirectDrivePTO (1,1) struct = struct(... % Simple direct drive linear PTO Block properties
'torqueConstant', 'NOT DEFINED',... % [Nm/A] Generator Torque constant
'gearRatio', 'NOT DEFINED',... % [] Gear ratio
'gearRatio', 'NOT DEFINED',... % [1] - % nondimensional % - Gear ratio
'drivetrainInertia', 'NOT DEFINED',... % [kgm^2] Drivetrain inertia
'drivetrainFriction', 'NOT DEFINED',... % [Nms/rad] Drivetrain friction coefficient
'windingResistance', 'NOT DEFINED',... % [ohm] Winding resistance
Expand Down

0 comments on commit 685d4cc

Please sign in to comment.