Download HarborSym Application User`s Manual

HarborSymApplication
User’sManual
HarborSymVersion1.5.5.2
HarborSymKernelVersion1.0.26.3
ContainerLoadingToolVersion0.6.14.0
BulkLoadingToolVersion1.0.88.0
CombinerVersion1.0.4.0
U.S.ArmyCorpsofEngineers
InstituteforWaterResources
October22,2013
Views,opinions,and/orfindingscontainedinthisreportarethoseoftheauthor(s)andshouldnotbe
construedasanofficialDepartmentoftheArmyposition,policyordecisionunlesssodesignatedby
otherofficialdocumentation.
Table of Contents ListofFigures..........................................................................................................................................................xi
ListofTables..........................................................................................................................................................xii
Section1 Introduction......................................................................................................................................1 Section2 Installation........................................................................................................................................3 2.1 2.2 2.3 2.4 SystemRequirements.............................................................................................................................................................3 InstallationProcedures..........................................................................................................................................................3 LocationofInstalledFiles.....................................................................................................................................................4 Uninstall ....................................................................................................................................................................................4 Section3 HarborSymOverview.....................................................................................................................5 3.1 HarborSymDatabaseArchitecture...................................................................................................................................5 3.2 BasicConcepts............................................................................................................................................................................6 3.2.1 Port....................................................................................................................................................................................7 3.2.2 Harbor,Nodes,Reaches...........................................................................................................................................7 3.2.3 ReachConfiguration..................................................................................................................................................8 3.2.4 NodeConfiguration....................................................................................................................................................8 3.2.5 VesselsandVesselCalls...........................................................................................................................................9 3.2.6 CommodityCategoriesandCriticalCommodities.....................................................................................12 3.2.7 DockVisitsandCommodityTransfers............................................................................................................12 3.2.8 VesselRouteGroups................................................................................................................................................12 3.2.9 VesselMovementBehavior..................................................................................................................................13 3.2.10 ElementsofVariability...........................................................................................................................................15 3.2.11 VesselTransitRules.................................................................................................................................................16 3.2.12 SafetyZones................................................................................................................................................................17 3.2.13 RuleViolations/Triggers.....................................................................................................................................18 3.2.14 TideandCurrentModeling...................................................................................................................................19 3.2.15 Scenario.........................................................................................................................................................................19 3.3 ModelBehavior........................................................................................................................................................................21 3.3.1 HarborSymDeepeningCostAllocationCalculations................................................................................21 3.3.2 DraftAdjustments....................................................................................................................................................23 3.4 HarborSymUserInterface..................................................................................................................................................23 3.4.1 GraphicsPane.............................................................................................................................................................25 3.4.2 NavigationPane.........................................................................................................................................................26 3.4.3 DataEntryPane.........................................................................................................................................................26 3.5 ModelOutputs..........................................................................................................................................................................26 Section4 LoadingModulesOverview........................................................................................................29 4.1 BulkLoadingTool...................................................................................................................................................................29 4.1.1 Architecture.................................................................................................................................................................30 4.1.2 InputRequirements.................................................................................................................................................31 4.1.3 ModelBehavior..........................................................................................................................................................32 4.1.4 BLTUserInterface....................................................................................................................................................36 4.2 ContainerLoadingTool........................................................................................................................................................37 4.2.1 Architecture.................................................................................................................................................................37 4.2.2 InputRequirements.................................................................................................................................................38 iii Table of Contents 4.2.3 ModelBehavior.........................................................................................................................................................42 4.2.4 CLTUserInterface...................................................................................................................................................44 4.3 CombinerTool.........................................................................................................................................................................46 4.3.1 SelectFiles...................................................................................................................................................................46 4.3.2 DataCheck...................................................................................................................................................................47 Section5 BasicHarborSymCommandsandFunctions........................................................................49 5.1 File
..................................................................................................................................................................................49 5.1.1 StudyManager...........................................................................................................................................................49 5.1.2 ConfigurationSettings............................................................................................................................................50 5.1.3 Print................................................................................................................................................................................51 5.1.4 AdditionalStudies....................................................................................................................................................51 5.2 View
..................................................................................................................................................................................51 5.2.1 StudyExplorer...........................................................................................................................................................51 5.2.2 DisplayOptions.........................................................................................................................................................52 5.3 Import ..................................................................................................................................................................................52 5.3.1 CommodityTransferRate....................................................................................................................................53 5.3.2 VesselDockingTime...............................................................................................................................................53 5.3.3 VesselTurningTime...............................................................................................................................................53 5.3.4 VesselSpeedinReach............................................................................................................................................53 5.3.5 PortTraffic..................................................................................................................................................................53 5.4 Output ..................................................................................................................................................................................54 5.4.1 Graphs............................................................................................................................................................................54 5.4.2 Reports..........................................................................................................................................................................54 5.4.3 Export............................................................................................................................................................................54 5.5 Tools
..................................................................................................................................................................................55 5.6 Help
..................................................................................................................................................................................55 5.7 ProjectSpecificMenuOptions..........................................................................................................................................56 5.7.1 CreateLookupSpreadsheet.................................................................................................................................56 5.7.2 ImportPortTraffic...................................................................................................................................................56 5.7.3 OutputHSAMInformation....................................................................................................................................56 5.7.4 PopulateTideStations...........................................................................................................................................56 5.7.5 Validate.........................................................................................................................................................................56 5.7.6 AssignRouteGroupstoVesselCalls................................................................................................................57 Section6 DevelopingaHarborSymStudy................................................................................................59 6.1 StudiesandProjects..............................................................................................................................................................59 6.1.1 Studies...........................................................................................................................................................................59 6.1.2 Projects.........................................................................................................................................................................59 6.1.3 StudyManagerandStudyExplorer..................................................................................................................59 6.2 TheNodeNetwork.................................................................................................................................................................61 6.2.1 PortStructures..........................................................................................................................................................61 6.2.2 MappingNodesandReaches...............................................................................................................................61 6.2.3 AddingBackgroundImage...................................................................................................................................62 6.2.4 DefiningNodes..........................................................................................................................................................62 6.2.5 EnteringTurningBasin,Dock,andAnchorageData.................................................................................63 6.2.6 DefiningReaches......................................................................................................................................................66 6.3 Vessels ..................................................................................................................................................................................68 6.3.1 VesselTypes...............................................................................................................................................................68 6.3.2 VesselClassifications..............................................................................................................................................69 iv Table of Contents 6.4 RouteGroups............................................................................................................................................................................73 6.5 Commodities.............................................................................................................................................................................74 6.5.1 Commodities...............................................................................................................................................................74 6.5.2 CriticalCommoditiesandSafetyZones...........................................................................................................75 6.6 PortTraffic.................................................................................................................................................................................75 6.6.1 CreateLookupSpreadsheet.................................................................................................................................76 6.6.2 PopulateLookupSpreadsheet............................................................................................................................77 6.6.3 ImportCompletedVesselCallSpreadsheet..................................................................................................78 6.6.4 ImportErrorLog.......................................................................................................................................................80 6.6.5 PortTrafficDataEntryGrids...............................................................................................................................80 6.7 Dock/TurningBasinMatrix................................................................................................................................................81 6.8 TideandCurrent.....................................................................................................................................................................82 6.8.1 TidalStations..............................................................................................................................................................82 6.8.2 CurrentStations.........................................................................................................................................................83 6.9 VesselSpeedsandTimes.....................................................................................................................................................84 6.10 SafetyZones...............................................................................................................................................................................84 6.10.1 ActivateSafetyZones..............................................................................................................................................84 6.10.2 DesignateSafetyZoneCommodities................................................................................................................84 6.10.3 ActivateSafetyZoneRulesforReaches..........................................................................................................85 6.11 DataValidator...........................................................................................................................................................................86 6.12 Simulations................................................................................................................................................................................89 6.12.1 Scenarios......................................................................................................................................................................89 6.12.2 LaunchaSimulation................................................................................................................................................90 6.12.3 CancelaSimulation..................................................................................................................................................90 6.13 Cloning ..................................................................................................................................................................................91 Section7 GeneratingaSyntheticCallListUsingLoadingModules..................................................93 7.1 CreateSyntheticBulkCallListUsingBulkLoadingTool......................................................................................93 7.1.1 SetWorkingFiles......................................................................................................................................................94 7.1.2 PopulateForecast.....................................................................................................................................................95 7.1.3 UpdateTablesinDatabase...................................................................................................................................97 7.1.4 GenerateSyntheticBulkVesselCallList.....................................................................................................100 7.1.5 ViewResults.............................................................................................................................................................101 7.2 CreateSyntheticContainershipVesselCallListUsingContainerLoadingTool......................................102 7.2.1 SetTemplateandSaveDirectories................................................................................................................103 7.2.2 SetWorkingFiles...................................................................................................................................................103 7.2.3 ReviewIDBandGeographyDatabases........................................................................................................104 7.2.4 PopulateCFCDBwithData................................................................................................................................104 7.2.5 SpecifyandSetScenario.....................................................................................................................................113 7.2.6 DataCheck.................................................................................................................................................................113 7.2.7 GenerateVCDB........................................................................................................................................................113 7.2.8 ViewResults.............................................................................................................................................................114 7.3 CombineVCDBs....................................................................................................................................................................114 Section8 SimulationSettings,RunParameters,andScenarios.....................................................117 8.1 SimulationSetting................................................................................................................................................................117 8.2 CreatingSimulationScenarios.......................................................................................................................................119 8.2.1 CreatingSimulationScenarios.........................................................................................................................119 8.2.2 OutputControlOptionsintheScenarioEditorForm............................................................................121 8.2.3 CommandButtonsintheScenarioEditor...................................................................................................121 v Table of Contents 8.2.4 ChooseProjects......................................................................................................................................................121 8.3 ViewingSimulations...........................................................................................................................................................122 8.4 ViewingSimulationOutputResults.............................................................................................................................125 8.4.1 ProjectComparisonReport...............................................................................................................................125 8.4.2 SingleScenarioReport........................................................................................................................................126 8.4.3 ReachRuleViolationsReport..........................................................................................................................127 8.4.4 VesselClassCharacteristicsReport...............................................................................................................128 8.4.5 CommodityInfoReport......................................................................................................................................129 8.4.6 OutputGraphs.........................................................................................................................................................129 8.4.7 OutputFiles..............................................................................................................................................................130 Section9 9.1 9.2 9.3 9.4 9.5 UnderstandingHarborSymOutput......................................................................................131 VesselTimeinSystemandTotalVesselCost..........................................................................................................131 ReachRuleViolations........................................................................................................................................................131 VesselsExiting,VesselsRemaining,andDeletedVessels..................................................................................131 VesselTimeWaiting...........................................................................................................................................................132 VesselCost..............................................................................................................................................................................132 Section10 HarborSymAnimationModule(HSAM)..............................................................................133 10.1 VesselObjects........................................................................................................................................................................134 10.2 NavigationNodeandNavigationReachObjects....................................................................................................134 10.3 DownloadandInstallHSAM...........................................................................................................................................135 10.3.1 InternetDownloadInstallation.......................................................................................................................135 10.3.2 Uninstall.....................................................................................................................................................................136 10.4 HarborSymOutputforHSAMAnimation..................................................................................................................136 10.5 HSAMOptionsWindow....................................................................................................................................................137 10.6 HSAMOperatingControls................................................................................................................................................138 AppendixA ImportingDataintoHarborSym...........................................................................................139 A.1 A.2 A.3 A.4 A.5 A.6 A.7 ImportingtheVesselCallList........................................................................................................................................139 ImportingVesselSpeedinReach.................................................................................................................................141 VesselDockingTime..........................................................................................................................................................141 VesselTurningTime...........................................................................................................................................................141 CommodityTransferRates.............................................................................................................................................141 SampleImportErrorLog.................................................................................................................................................142 SampleDataValidationReport.....................................................................................................................................142 AppendixB HarborSymVesselTrafficRules..........................................................................................145 B.1 Introduction...........................................................................................................................................................................145 AppendixC HarborSymOutputFiles..........................................................................................................153 C.1 SettingOutputControls....................................................................................................................................................153 C.2 ASCIIOutputFiles................................................................................................................................................................156 C.2.1 SummaryFile.prn.................................................................................................................................................156 C.2.2 VesselOutputFile.ves.........................................................................................................................................156 C.2.3 EventOutputFile.evn.........................................................................................................................................156 C.2.4 ReachOutputFile.rea.........................................................................................................................................156 C.2.5 DebugOutputFile.dbg........................................................................................................................................156 C.2.6 RuleViolation.rul..................................................................................................................................................156 C.2.7 EchoofInput.ech..................................................................................................................................................156 C.2.8 VesselMovement.vmf.........................................................................................................................................157 vi Table of Contents C.2.9 ErrorFile.err............................................................................................................................................................157 C.3 .csvFilesinExcel®andAccess®Format.....................................................................................................................157 C.3.1 Iteration.csv.............................................................................................................................................................157 C.3.2 RuleViolation.csv....................................................................................................................................................158 C.3.3 DraftAdjustment.csv............................................................................................................................................160 C.3.4 DeletedVesselCall.csv...........................................................................................................................................161 C.3.5 Commodity.csv........................................................................................................................................................162 C.3.6 VesselClassStatistics.csv.....................................................................................................................................162 C.3.7 VesselCall.csv...........................................................................................................................................................163 C.3.8 NodeConstraint.csv...............................................................................................................................................166 C.3.9 NodeScheduling.csv..............................................................................................................................................167 C.3.10 TimeStep.csv............................................................................................................................................................168 C.3.11 Usage.csv....................................................................................................................................................................169 C.3.12 VesselCallProblem.csv.........................................................................................................................................169 C.3.13 VesselsRemainingInSystem.csv.......................................................................................................................171 C.3.14 WaitCause.csv..........................................................................................................................................................172 C.3.15 WaitCause2.csv.......................................................................................................................................................172 C.3.16 UnitOfMeasure.csv................................................................................................................................................173 C.3.17 DraftAdjustment2.csv..........................................................................................................................................174 C.3.18 RouteGroupStatistics.csv....................................................................................................................................176 C.4 .SODADatabase.....................................................................................................................................................................176 C.4.1 qryFacilityNodeUsageByPath...........................................................................................................................177 C.4.2 qryRuleViolationsWithPath..............................................................................................................................178 C.4.3 qryWaitCause2WithoutDeletedVessels.......................................................................................................179 C.4.4 qryWaitCause2WithoutDeletedOrRetained..............................................................................................180 C.4.5 qryWaitCauseWithoutDeletedVessels..........................................................................................................180 C.4.6 qryWaitCauseWithoutDeletedOrRetained.................................................................................................182 C.4.7 qsumFacilityNodeUsageByPathIteration....................................................................................................182 C.4.8 qsumRuleVioloationsWithPath.......................................................................................................................182 C.4.9 qsumWaitBySituationClassNoDeletedOrRetained.................................................................................183 C.4.10 qsumWaitBySituationNoDeletedOrRetained............................................................................................183 C.4.11 qsumWaitCauseTotalTimeByCombinedCode...........................................................................................184 C.4.12 qsumWaitCauseTotalTimeByCombinedCodeSituationLocation......................................................184 C.4.13 qsumWaitIncrementBySituationandCode..................................................................................................185 C.4.14 qsumWaitTimeByPathIteration......................................................................................................................185 C.4.15 qsumWaitTimeByPathIterationClass............................................................................................................186 C.4.16 qsumWaitTimeByPathIterationProtocol....................................................................................................186 C.4.17 qsumWaitTimeByPathIterationProtocolClass..........................................................................................186 AppendixD SamplePRN.................................................................................................................................188 AppendixE LoadingToolsOutputFiles.....................................................................................................192 E.1ContainerLoadingToolOutputFiles.............................................................................................................................192 E.1.1CommodityTransfer‐CLT.csv...............................................................................................................................192 E.1.2Fleet‐CLT.csv...............................................................................................................................................................192 E.1.3FleetUsageStatistics‐CLTL.csv.............................................................................................................................193 E.1.4Forecast‐CLT.csv.......................................................................................................................................................193 E.1.5SatisfactionStatistics‐CLT.csv..............................................................................................................................194 E.1.6Vessels‐CLT.csv..........................................................................................................................................................194 E.1.7LoadingAnalysis‐CLT.csv.......................................................................................................................................195 E.1.8ArrivalDraftDebug.csv............................................................................................................................................198 vii Table of Contents E.2BulkLoadingToolOutputFiles........................................................................................................................................199 E.2.1Allocation.csv.............................................................................................................................................................199 E.2.2ClassUsage.csv...........................................................................................................................................................200 E.2.3Loading.csv..................................................................................................................................................................200 E.2.4Vessel.csv.....................................................................................................................................................................202 Glossary
..........................................................................................................................................................204 Index
..........................................................................................................................................................208 viii Table of Contents List of Figures Figure1:ReachNodeNetwork............................................................................................................................................................8 Figure2:SafetyZones...........................................................................................................................................................................18 Figure3:HarborSymStudyExplorer.............................................................................................................................................24 Figure4:ThreePaneLinkage............................................................................................................................................................25 Figure5:HarborSymGraphicsPane...............................................................................................................................................25 Figure6:NavigationPane....................................................................................................................................................................26 Figure7:NavigationPaneExpanded..............................................................................................................................................26 Figure8:DataGrid..................................................................................................................................................................................26 Figure9:BulkLoadingToolArchitecture....................................................................................................................................31 Figure10:AllowanceforOperationsbyVesselDWT..............................................................................................................35 Figure11:BulkLoadingToolUserInterface..............................................................................................................................36 Figure12:CLTArchitecture...............................................................................................................................................................38 Figure13:CLTUserInterfaceOverview.......................................................................................................................................45 Figure14:HarborSymFileMenu.....................................................................................................................................................49 Figure15:ConfigurationSettings‐Validation...........................................................................................................................50 Figure16:ConfigurationSettings‐Simulation..........................................................................................................................51 Figure17:ViewMenu............................................................................................................................................................................51 Figure18:GraphicsPaneOptions....................................................................................................................................................52 Figure19:ImportMenu........................................................................................................................................................................52 Figure20:ImportSub‐Menu..............................................................................................................................................................53 Figure21:OutputMenu........................................................................................................................................................................54 Figure22:GraphBuilder......................................................................................................................................................................54 Figure23:ReportSub‐Menu...............................................................................................................................................................54 Figure24:PortTrafficSub‐Menu.....................................................................................................................................................55 Figure25:ToolsMenu...........................................................................................................................................................................55 Figure26:HelpMenu............................................................................................................................................................................55 Figure27:ProjectSpecificMenuOptions.....................................................................................................................................56 Figure28:StudyManager....................................................................................................................................................................60 Figure29:NodeDescriptions.............................................................................................................................................................62 Figure30:VesselDockingTimeTab...............................................................................................................................................64 Figure31:CommodityTransferRateTab....................................................................................................................................64 Figure32:TurningBasinDataEntryGrid....................................................................................................................................65 Figure33:VesselTurningBasinTimeTab..................................................................................................................................65 Figure34:ReachInformation............................................................................................................................................................67 Figure35:SpeedinReach....................................................................................................................................................................67 Figure36:RuleDescriptionWindow.............................................................................................................................................68 Figure37:PortTransitRules.............................................................................................................................................................68 Figure38:VesselTypeInformation................................................................................................................................................69 Figure39:UserSelectionofVesselTypeClassification.........................................................................................................70 Figure40:VesselClassDefinitionTab...........................................................................................................................................71 Figure41:VesselClassCommoditiesTab....................................................................................................................................71 Figure42:VesselClassAttributesTab...........................................................................................................................................72 Figure43:VesselClassRouteGroupTab.....................................................................................................................................72 ix Table of Contents Figure44:RouteGroups......................................................................................................................................................................73 Figure45:RouteGroupTab...............................................................................................................................................................73 Figure46:AssignmentofRouteGroups.......................................................................................................................................74 Figure47:CommodityInformation................................................................................................................................................74 Figure48:CommodityCategoryTab..............................................................................................................................................75 Figure49:CreateLookupSpreadsheet.........................................................................................................................................76 Figure50:CreateLookupSpreadsheetDialogPrompt..........................................................................................................77 Figure51:ImportPortTraffic...........................................................................................................................................................78 Figure52:SelectionofDefaultVesselClass................................................................................................................................79 Figure53:Dock/TurningBasinMatrix.........................................................................................................................................81 Figure54:PopulateTideStations....................................................................................................................................................82 Figure55:PopulateTideStationsWindow.................................................................................................................................83 Figure56:CommodityInformation................................................................................................................................................84 Figure57:SelectingSafetyZoneCommodity.............................................................................................................................85 Figure58:PortTransitRulesSelection.........................................................................................................................................85 Figure59:SelectingPortTransitRuleConditions...................................................................................................................85 Figure60:ActivatingReachSafetyZones....................................................................................................................................86 Figure61:ReachTransitRuleSelection.......................................................................................................................................86 Figure62:DataValidationTool........................................................................................................................................................87 Figure63:DataValidationinConfigurationSettings.............................................................................................................87 Figure64:Scenarios...............................................................................................................................................................................89 Figure65:ScenarioParamtersDataEntryGrid.......................................................................................................................89 Figure66:ScenarioEditor..................................................................................................................................................................90 Figure67:CloneProjectinStudyManager................................................................................................................................91 Figure68:LaunchBulkLoadingTool............................................................................................................................................94 Figure69:AttachAppropriateDatabasestoBLT.....................................................................................................................94 Figure70:BLT‐‐SaveDatabaseConfiguration...........................................................................................................................95 Figure71:BLTPopulateForecastOptions..................................................................................................................................96 Figure72:BLTUpdateDatabase......................................................................................................................................................97 Figure73:BLT‐‐ReviewIDBDataUsingQueryForm.............................................................................................................98 Figure74:DeleteReferencestoContainer‐relatedDatainBLT........................................................................................98 Figure75:BLT‐‐CreateNewVCDBfromTemplate..............................................................................................................100 Figure76:BLT—SetupScenario...................................................................................................................................................101 Figure77:LaunchContainerLoadingTool..............................................................................................................................102 Figure78:SetCLTTemplateDirectory......................................................................................................................................102 Figure79:AttachCLTDatabases..................................................................................................................................................103 Figure81:EditCFCDBTablesthroughCLTMenu.................................................................................................................104 Figure80:ReviewIDBTablesThroughCLTMenu...............................................................................................................104 Figure82:CLTCFCDBSeasonsTable.........................................................................................................................................105 Figure83:CLTCFCDBDock‐VesselClass..................................................................................................................................106 Figure84:CLTCFCDBService........................................................................................................................................................107 Figure85:CLTCFCDBRegion‐Service.......................................................................................................................................107 Figure86:CLTCFCDBRouteGroup‐Service.........................................................................................................................108 Figure87:CLTCFCDBArrivalDraftFunctionWhenUtilizingCDFFunctionsforVessels.................................108 Figure88:CLTCFCDBArrivalDraftFunctionWhenUtilizingMin/MaxArrivalDraftforVessels.................109 Figure89:CLTCFCDBArrivalDraftFunctionDetailWhenUtilizingCDFFunctionsforVessels....................109 Figure90:CLTCFCDBService–VesselClass..........................................................................................................................110 Figure91:CLTContainerFleetSpecification..........................................................................................................................112 Figure92:CLTCommodityForecastsbyDockandRegion..............................................................................................112 Figure93:CLTScenarioForm........................................................................................................................................................113 x Table of Contents Figure94:CombineVCDBS..............................................................................................................................................................114 Figure95:ScenarioEditorWindowintheDataEntryPane.............................................................................................119 Figure96:ChooseProjects...............................................................................................................................................................122 Figure97:DialogBoxOverlayingStepModeScreen............................................................................................................122 Figure98:StepModeScreenShowingSimulation................................................................................................................123 Figure99:VesselQuery.....................................................................................................................................................................124 Figure100:ExampleScenarioComparisonReport..............................................................................................................126 Figure101:SingleScenarioReport..............................................................................................................................................127 Figure102:TransitRulesReport..................................................................................................................................................128 Figure103:VesselClassMovementThresholdReport.......................................................................................................129 Figure104:GraphicalOutputs.......................................................................................................................................................129 Figure105:VesselTimeGraph......................................................................................................................................................130 Figure106:HSAMVisualization....................................................................................................................................................133 Figure107:SampleHSAMVesselAvatars.................................................................................................................................134 Figure108:HarborSymWebsiteDownload.............................................................................................................................135 Figure109:LaunchFileSettingsConfiguration.....................................................................................................................136 Figure110:FileSettingsConfiguration......................................................................................................................................137 Figure111:OutputHSAMInformation......................................................................................................................................137 Figure112:HSAMOperations........................................................................................................................................................138 Figure113:OutputControlSettings............................................................................................................................................153 xi Table of Contents List of Tables Table1:DatabasesUsedInAnalysis.................................................................................................................................................6 Table2:HarborSymTrafficRuleWaitCauseCategories......................................................................................................17 Table3:NodeandReachMappingTools.....................................................................................................................................62 Table4:ValidationSettings................................................................................................................................................................88 Table5:CLTCFCDBService‐VesselClassTableFieldDescriptions............................................................................110 Table6:CLTVesselSubclassFieldDefinitions.......................................................................................................................111 Table7:SimulationSettingsFields..............................................................................................................................................118 Table8:HSAMOperationalKeyStrokes....................................................................................................................................138 Table9:ImportSpreadsheetFieldDefinitions.......................................................................................................................140 Table10:VesselTrafficRules–NumberandTitle...............................................................................................................146 Table11:VesselTrafficRules–NumberandParameterUsage.....................................................................................148 Table12:TrafficRules–NumberandMovingVesselCharacteristics.........................................................................150 Table13:OutputControl/Settings...............................................................................................................................................154 xii Section 1 Introduction Thisdocumentprovidesabasicuser’smanualfortheHarborSystemsimulation(HarborSym)
software.HarborSymisaneconomicanalysismodel,developedbytheU.S.ArmyCorpsofEngineers
(Corps)InstituteforWaterResources(IWR),foruseinexaminationofdeep‐draftchannel
improvements.HarborSymisadiscreteeventMonteCarlosimulationmodelandisdesignedtobea
general‐purposetoolforusebyCorpsplanners.HarborSymispartofasuiteofsimilarIWR‐developed
models,allwithasimilararchitectureandapproachof“data‐driven”modeling,inwhichthefactors
thattailorageneral‐purposemodeltoaspecificsituationandstudyarestoredinadatabaseand
populatedbytheuser.Themodelmeasurestheeconomiceffectsofmodificationstodeepdraft
harborsasoverallreductionsintransittimesandassociatedchangesintotalvesseloperatingcosts.
Themodelisorientedprimarilytowardsimprovementsthatreducecongestioninthewaterwayor
increasevesseloperatingefficiencies,asopposedtolandsidematerialshandlingimprovements,
althoughchangestoloading/unloadingtimescanberepresented.Thesimulationresultscanbeused
inacomparativeanalysisofalternativeharborimprovementsandtosupportageneralbenefit‐cost
analysisofproposednavigationimprovements.
ThenodenetworkrepresentationoftheharborisbuiltbytheHarborSymuser.Thenthevessel
classifications,commoditycategories,andbasicvesselcallinformationaredefinedbytheuser.The
HarborSymmodelusestheseinputstosimulatevesseltrafficinuser‐definedscenarios.Theuseris
providedmanyinputoptionsthatallowflexibilityinsimulatingvesseltraffic.
HarborSymwasinitiallydevelopedasatoolforanalyzingchannelwideningprojects,whichwere
orientedtowarddeterminingtimesavingsorvesselstransitingaharborbutdidnot,ingeneral,
involveassessingchangesinvesselloadingorshippingpatterns.ThelatestHarborSymrelease,
towardwhichthismanualisgeared,isdesignedtoassistanalystsinevaluatingchanneldeepening
projectsinadditiontotheoriginalmodelcapabilities.Theadditionaldeepeningfeaturescaptures
fleetandloadingchanges,incorporatescalculationsforbothwithinharborcostsandcostsassociated
withoceanvoyagecosts,andincludesthreetoolsdesignedtoaidplannersinanalyzingand
developingfuturevesselcallslistsforgeneralbulkandcontainerizedvessels.
TheBulkLoadingTool(BLT),ContainerLoadingTool(CLT),andCombinerhavebeenincorporated
intoHarborSym.TheBLTandCLTareintegratedmoduleswithinHarborSymdesignedtogenerate
syntheticvesselcalllistsbaseduponuserprovidedcallingstatistics.TheCombinercanbeusedto
mergetheBLTandCLTproducedvesselcalldatabasesintoasingledatabasethatcanbeusedbythe
HarborSymsimulator.Whileusersarenotrequiredtogeneratefuturecallliststhroughthemodules,
thisfeaturegreatlyenhancestheHarborSymcapabilitiesbysimplifyingtheprocessofpopulating
futureconditions.
HarborSymisacomplicatedmodelrequiringdetaileduser‐provideddataandassumptions.Attending
atrainingclasswillprovideusersamorethoroughunderstandingoftheworkflow,modelcapabilities,
anddatarequirements.Intheabsenceofaninstructor‐ledsession,trainingmaterialsareavailablefor
downloadfromtheHarborSymwebsite.Thetrainingmaterialsarecomposedofaseriesofsoftware
exercisesthatwalktheuserthroughtherequiredstepstocreateastudynetwork,populatedata,runa
simulation,andanalyzeoutputs.
1 Section 1  Introduction Thismanualisdesignedasareferenceguideandwillassistusersinunderstandingspecificfunctions
oftheHarborSymmodel.Section2ofthemanualdiscussessoftwareinstallationproceduresand
systemrequirements.Section3providesanoverviewofthefundamentalmodelconceptsand
standardfeaturesusedintheHarborSymapplicationwhileSection4providesthesamedetailsforthe
LoadingModules.Section5detailsthebasicmenucommandsandfunctionswithinHarborSym,
addressingeachmenuitem.Section6describeshowtodevelopanewHarborSymprojectandSection
7discussesgenerationofasyntheticvesselcalllist.Section8describessimulationsettingsandsetting
upscenariosandSection9howtouseHarborSymoutputtocompareprojects.Section10introduces
theHarborSymAnimationModule(HSAM),apost‐processanimationtool.Thefiveappendices
provideadditionaldetailsonimportingdataintoHarborSym,trafficrules,andoutputfilesofboth
HarborSymandtheLoadingModules.AGlossaryofTermsandIndexareprovidedattheendofthis
document.
2 Section 2 Installation TheHarborSymsoftwareisprimarilydistributedbyInternetdownload,althoughitcanalsobe
distributedbyCD‐ROM,uponrequest.
2.1 System Requirements BeforeinstallingHarborSym,makesurethecomputersystemmeetsthefollowinghardwareand
softwarerequirements:

Minimum1GHzprocessor

MicrosoftWindowsXPorWindows7

1GBRAM

200MBavailableharddiskspace

CD‐ROMorInternetconnection

Administratorpermissionsonthecomputerforinstallationpurposes
IfyouencounteranyissuesinstallingonWindows7,pleasecontacttheHarborSymDesignTeamat
harborsym@usace.army.mil.IfanearlierversionofHarborSymwasinstalledonthesystem,pleasebe
suretouninstallthatversionfollowingthedirectionsprovidedinSection2.4.
2.2 Installation Procedures CD‐ROMInstallation:
1. InserttheHarborSymCD‐ROMintoyourCD‐ROMdrive.
2. Waitforthesetupprogramtostart.
3. Followtheinstructionstocompletesetup;itisrecommendedforuserstoacceptall
defaultsettings.
InternetDownloadInstallation:
1. Downloadtheinstallationfiletoatemporarydirectory(Example,C:\Temp).
2. ClickthestartbuttonontheTaskbar.
3. ClickRun.
4. Typethepathtothedownloadedfile(Example,C:\Temp\Setup.exe).
5. Clickthe“OK”button.
3 Section 2  Installation 6. Followinstructionstocompletesetup;itisrecommendedforuserstoacceptalldefault
settings.
2.3 Location of Installed Files Thesampledata,trainingdata,andmostotherdatabasesandtemplates(exceptionsnotedbelow)are
storedinthe‘Public’documentsfolder.ThislocationvariesaccordingtotheOperatingSystem:

WindowsXPorolder:"C:\DocumentsandSettings\AllUsers\Documents\HarborSym"

WindowsVistaorWindows7:"C:\Users\Public\Documents\HarborSym"
FortheCLT,thenewdefaultfolderfortemplatesandsampledatawillalsovaryaccordingtothe
OperatingSystem:

Windows7Templatesfolder:"C:\Users\Public\Documents\HarborSym\Templates"

Windows7CSVsavefolder:"C:\Users\Public\Documents\HarborSym\SampleData"

WindowsXP(orolder)Templatesfolder:"C:\DocumentsandSettings\All
Users\Documents\HarborSym\Templates"

WindowsXP(orolder)CSVsavefolder:"C:\DocumentsandSettings\All
Users\Documents\HarborSym\SampleData"
2.4 Uninstall 1. ClicktheStartbuttonontheTaskbar.
2. ClickSettings.
3. ClickControlPanel.
4. Double‐clickAdd/RemovePrograms.
5. Select“HarborSym”.
6. ClicktheAdd/Removebutton.
7. Followpromptstouninstall.
8. GotothedirectorywhereHarborSymwasinstalled(typicallyC:\Program
Files\HarborSym)andensurethattheentiredirectorywasremoved.Ifitwasnot,
deletethe“HarborSym”directoryandallofitscontents.Navigatetothe
template/databaseinstalllocationsnotedinSection2.3andensurethatallfoldersand
fileswereremoved,deletinganyfilesthatwerenot.
4 Section 3 HarborSym Overview HarborSymisbasedonthecreationofdiscreteeventMonteCarlosimulationsthatmimicmovements
ofvesselsthroughaharbor.ThesystemscreatedinHarborSymhaverandomizedbehaviorintermsof
generationoftrips,loadingandunloadingtimeatdocks,anddockingandundockingtime.Theuser
inputsstatisticalparameterswithminimum,maximum,andmostlikelyvalues.Theapplicationis
designedtoestimatetheeconomiceffectofchannelmodificationsontransittimesandvessel
operatingcosts.HarborSymhasbeendesignedwithmanygeneralfeaturestoenhanceitsportability
andcanbeusedtoevaluateeconomiceffectsofimprovementsonmanyharbors.Thestudyareais
specifiedbydevelopingamodeloftheharbornetworkthatphysicallyandstatisticallyrepresentsthe
navigationconditionsofthedesiredstudyarea.
Themodelconsistsofthefollowingintegratedcomponents:

AMicrosoftAccess2000database,storingtheharborrepresentation,statisticsonvesseltransit
times,routesthroughthesystemandmodeloutput(usersdonotneedtohaveMicrosoftAccess
installedontheircomputer);

AC++“simulationkernel”thatperformsthedetailedsimulationcalculations,readingdatafrom
thedatabaseandstoringtheoutputresultsbackinthedatabaseandinseparatedetailedoutput
datafiles;

Auserinterface,writteninVisualBasic.NET,allowsfordatainputandediting,graphicaldisplay
ofthesystem,runningofthekernelandoutputreporting.
Thethreecomponentsworktogethertosatisfythegoalofprovidinganintegratedsystemfortheuser.
Themodelincludescapabilitiestosimulatevesseltrafficandtransitrulesintheharbor.
3.1 HarborSym Database Architecture UnderstandingoftheHarborSymdatabasearchitectureishelpfulingraspingmanyaspectsofthe
model’sunderlyingmethodologiesandhowthevariouscomponentsofthemodelworktogether.This
sectionprovidesanoverviewoftheHarborSymdatabasesforreferenceandtosupporta
comprehensiveunderstandingofthemodeloperationsandfunctionality.Asalltheinformation
storedinthesedatabasesisavailablethroughtheHarborSymUserInterface,usersarenotexpectedto
enter,view,ormodifydatadirectlythroughthesupportingdatabases.
HarborSymisadata‐drivenmodel,withinformationstoredinmultipledatabases.Atpresent,five
databasesarerequiredforaHarborSymsimulation:3forinput,2foroutput.TheBulkLoadingTool
module(BLT)requiresanadditionaldatabaseinordertogenerateasyntheticshipmentlist.The
ContainerLoadingTool(CLT)requiresthreeadditionaldatabases.AllthedatabasesareMicrosoft
Access™databases.Eachdatabasecontainstables(wherethedataareactuallystored),queries
(particularviewsofthedata),formsandreports.OneofthefeaturesofAccessistheabilitytolink
informationthatisactuallystoredinseparatedatabases,sothat,totheuser,alloftheinformation
appearstobeinasingledatabase,butthetablesareactuallyspreadovermultipledatabases.
HarborSymusesthisarchitecturetoseparateandorganizetherequiredinformation.Eachdatabase
5 Section 3  HarborSym Overview typeisidentifiedbyitsfileextension.Theindividualdatabasesarenotcompletelyindependent,for
examplevesselcallinformation(intheVCDB)referencesinformationaboutindividualdocks(stored
intheIDB),asshowninTable1.
Table 1: Databases Used In Analysis Database File Extension Contents / Usage
Master Database MDB Links together all relevant information needed for HarborSym simulations. Linked databases are the IDB, VCDB and ODB. This database in and of itself does not contain any study‐specific content. The study‐specific content is contained in the linked IDB and VCDB. Input Database IDB Description of the port, channels, docks and transit rules, as well as vessel types, vessel classes, commodity categories, and route groups. Vessel Call Database VCDB Description of vessels, vessel calls and commodity transfers. Must be associated with an IDB.
Output Database ODB Stores output results from multiple runs of HarborSym.
Scenario Output Database SODA Stores detailed output associated with a single HarborSym simulation. Bulk Forecast Database FCDB Required by BLT. Stores information about commodity forecasts at docks, constraints on vessel class capability to carry commodities and serve individual docks and statistical information (cumulative density functions and regression equations) needed for synthetic vessel generation. Requires an association with an IDB. Container Forecast Database CFCDB Required by CLT. Stores information about commodity forecasts at docks, services, fleet specifications, forecast seasons, and other vessel class statistics needed for synthetic vessel generation. Requires an association with an IDB. Geography MDB Required by CLT. Stores information about ports and regions. This database in and of itself does not contain any study‐specific content. CLT Generator Master MDB Required by CLT. Links together all relevant information needed for CLT generations.
3.2 Basic Concepts ThebasicstructureofamodeldevelopedinHarborSymreliesondatatodescribethephysicallayout,
vesseltraffic,commoditytransfers,andtrafficrulesforvesselmovement.Anavigationimprovement
toaharborchangestransittimesofvesselsintheharbor.Alldataforeachalternativeproject
simulated,alongwithinformationonspecificdataelementsusedinthesimulationandthesimulation
parameters,isstoredintableswithinaMicrosoftAccessdatabase.Thescenarioprovidesthe
combinationofdatausedbytheMonteCarloprocessthatestimatestotaltransportationtimeandcost
ofvesselstransitingtheharbor.
Thekeyfeaturesofthemodelare:

Userdefinednetworkdescribingtheport;

Historicalvesselcalls,withmultiplecommoditiesanddocks;

Userdefinitionofvesselclassescommoditytypes,androutegroups;

Tidalinfluenceandinternalcalculationoftideheightandcurrentbyreach;
6 Section 3  HarborSym Overview 
Transitanalysisbasedonuser‐parameterizedrules;

Intra‐harborvesselmovements;

Useofturningareasandanchorages;

Within‐Simulationandpost‐processingvisualizationandanimation;

Syntheticvesselcalllistgenerationforgeneralbulkcarriersandcontainerships.
ThesubsectionsbelowintroducekeyHarborSymconcepts.Additionaldetailonwhereandhowto
enterthisinformationintotheHarborSymuserinterfacecanbefoundinSection6andinthetraining
materials.
NotethatHarborSymdatarequirementsshouldbeexpressedinEnglishunits.Reachlengths,vessel
characteristics,etcmustbeexpressedinfeet.
3.2.1 Port Theportissynonymouswiththestudyharbor.Thelongitudeandlatitudeoftheportisenteredto
allowHarborSymtodeterminedaylighthoursattheport,sincesometransitruleswithintheportcan
bespecifiedasdaytimeornighttimerules.Usersshouldalsoprovideinformationondaylightsavings
timeapplicabilitytobetterrepresentvesselmovementsduringthesimulation.
3.2.2 Harbor, Nodes, Reaches Theportorstudyharborisrepresentedasasystemofreachesbetweennodes.AHarborSymreach‐
nodenetworkmustbe“tree‐structured”,withonlyasinglepathbetweenanytwonodepairs.Loops,
inwhichmultiplepathwaysbetweenapairofnodesarepossible,arenotpermittedwithina
HarborSymnetwork.Reachescannotcrosseachother.Nodesrepresentdocks,turningareas,
anchorages,entry/exitpointsorothertopologicpointsintheharborwherechannelconditions
change.Atleastonenodeonthenetworkmustbedefinedasanentry/exitpoint.Nodesareconnected
toeachotherbyreaches.Areachrepresentsachannelsegment(ofuniformcharacteristics)between
twonodes.Vesselmovementstatisticsarecalculatedbasedonvesselmovementinreaches.
7 Section 3  HarborSym Overview Figure 1: Reach Node Network
Figure1depictsareach‐nodeschematicforatheoreticalHarborSymsystem.Thissetupallowsmajor
harborfeaturestoberepresentedsymbolicallytofacilitateplanning‐levelanalyses.Itisimportantto
recognizethattheHarborSymnetworkisanabstractionofrealityforplanningandmodelingpurposes
–multipledocksmaybeaggregatedintosingledocksandchannelsmaybesimplified.
3.2.3 Reach Configuration Thereachconfigurationdataspecifiesthecharacteristicsofeachreach.Reachesareuserdefined
channelsegmentswithuniformcharacteristics,includingwidth,depth,transitrules,andoperating
speeds.Areachnecessarilyconnectstwonodeswithinthesystem.User‐specifiedinformationfora
reachincludesadescription(name),andthelength,widthanddepthofthechannel.Thevessel
transitspeedsthrougheachreachunderlightandloadedconditionsarespecifiedbytheuserforeach
vesselclassification.Thesespeedsarefixednumbers,notdefinedbyadistribution.Theoptimal
reachconfigurationwilldependuponspecificoperatingpracticeswithinthestudyport.Usersshould
consultchannelmaps,pilots,portauthorityrepresentatives,andothersourcesofdirectinformation
whendefiningtheirnetwork.
3.2.4 Node Configuration Theusersmustdefineallfunctionalnodestoberepresentedwithinthesimulationsystem,including
systementrancepoints,docks,turningbasins,anchorages.Thesystementryandexitpointsmustbe
identified.
Thedockconfigurationdataincludesthedescription(name),length,depth,capacity,corresponding
turningbasin,vesseldockingtimes,andcommoditytransferrates.
8 Section 3  HarborSym Overview Turningbasinsmustbedefinedbyvesselcapacityanddepth,aswellasanindicationofwhetherthe
channelisblockedduringvesselturningmaneuvers.Ifthe“BlocksChannel”optionisselectedfora
turningbasin,whilevesselscompletetheirturningmaneuversnoothertrafficmaytraversethe
adjacentchannel.Ifthisoptionisnotselected,trafficthroughthechannelisnotimpactedbyvessel
turningmaneuvers.InHarborSym,vesselscannotwaitwithinaturningbasin.Atriangular
distributionofminimum,maximum,andmostlikelytimerequiredtoutilizetheturningbasinis
requiredforeachvesseltype.Thedeterminationofwhichturningbasintouseforeachdockis
definedbyuserinputatthevesselclasslevel,asisthesequenceofturning(i.e.,beforeorafter
docking,orwhenthevesselisdraftingdeeperorlighter).Beforeavesselisdirectedtoaturning
basin,HarborSymwillconfirmthatthevessel’ssailingdraft,inclusiveofunderkeelclearance
requirements(ifapplicable),doesnotexceedtheturningbasindepth.Ifapplicable,tidalinfluenceis
includedinthesecalculations.
Anchorages,alsotermed“FacilityNodes”inHarborSym,aredefinedbythephysicalcharacteristicsof
capacityanddepth.Userscanalsodesignatethatanchoragesblockthechannel,thusprohibiting
through‐sailingifashipisstoppedintheanchorage.Anchoragescanbeusedasintermediatewaiting
pointsifavesselistemporarilyprohibitedfromreachingitsdestination(e.g.,adock)dueto
congestionorconstraints.Undertheseconditions,HarborSymwilldirectvesselstowaitinan
availableanchorageifthevesselcanreachthelocationoftheanchoragewithoutencounteringa
constraint,thereisspaceavailableattheanchorage,andthevesseldraft,isequaltoorlessthanthe
anchoragedepth.Anadditional10’ofavailabledepthisassumedifthevesselislight.Asvesselsmay
bedelayedforanextendedperiodcoveringmultipletidecycles,HarborSymdoesnotincludetidal
influenceinthedeterminationofwaterdepthavailability.
3.2.5 Vessels and Vessel Calls ThedrivingparameterfortheMonteCarlosimulationisavesselcallattheport.Afleetofdistinct
vesselsservicesaport,withanyonevesselinthefleetcallingoneormoretimesduringthesimulation
period.Eachsuchvesselcalltakesplaceataknownorgenerateddateandtime,isidentifiedwitha
specificrealorsyntheticallygeneratedvesselandincludesoneormoredockvisits(intra‐harbor
movementsarerepresentedbymultipledockvisitswithinavesselcall).Eachdockvisitconsistsof
oneormorecommoditytransfers.Acommoditytransferisanimportand/orexportofaknown
quantityofagivencommodity.Vesselcallsareobtainedeitherfromhistoricaldataavailableatthe
portthatisstoredinthedatabaseoraregeneratedsynthetically,externaltothemodelorusingthe
BLT,CLT,and/orCombiner.VesselcallsarestoredintheAccessdatabaseasasetofrelatedtables.
Thecalculationoftransportationcostsiscontingentuponthecompositionandquantityofvesselcalls.
Thus,itiscriticalthattheuser‐providedvesselcallsareareasonablereflectionofthetrafficcalling
thestudyportoranticipatedtocallinfutureconditions.
3.2.5.1 Vessel Types and Vessel Classes Vesseltypesaregeneralcategoriesofvesselssuchastankers,generalcargovessels,orcontainer
vessels,asdefinedbytheuser.Avesseltypecontainsoneormore.Avesselclassbelongstoonlyone
vesseltype.Vesselclassesaresubsetsofvesseltypesdefinedbytheuserbaseduponphysical
parameters(length,beam,draft,capacity,TPI),commoditiescarried,sailingspeeds,sailingdrafts,
operatingcosts,andoceansailingroutes.Vesselclassesarealsodefinedbytheuser.Examplesof
vesselclassescouldbetankersmall,tankerlarge,Panamax,Sub‐Panamax,etc.Vesselcharacteristics
suchasLOA,beam,anddraftmustbeexpressedinfeet.Sailingspeedsmustbeexpressedinnautical
milesperhour,orknots.
9 Section 3  HarborSym Overview 3.2.5.2 Vessel Operating Costs Hourlyvesseloperatingcostsaredefinedforeachvesselclassbasedonthevesselstatusof“atsea”or
“inport”andforeignordomesticflag.Foreachcategory,theoperatingcostsaredescribedwitha
triangulardistribution.CorpsfieldusersmayobtainvesseloperatingcostsfromIWR.Vesseloperating
costsaredevelopedbasedonvesselspeed,thusthetwoaredirectlyassociated.Notethatvesselspeed
mustbeexpressedinknotsperhour.Theusershouldtakecaretoassurevesseloperatingcostsand
vesselsailingspeedsarebaseduponconsistentdataandassumptions.Theapplicationofatseaorin
portoperatingcostsisdeterminedbyasetofalgorithmsdefinedinthemodelcode,asfollows:

Duringreachtransitsandturningmaneuvers,atseacostsareapplied.

Inportcostsareappliedduringdockvisits,includingtimespentdockingandundocking.

Costsincurredduringvesseldelaysatthedockarecalculatedbasedonauser‐enteredthreshold
time.Ifthedelayisgreaterthanthethresholdtime,atseacostsareusedforthethresholdtime,
withportcostsfortheremainingtime.Ifthedelayislessthanthethresholdtime,atseacostsare
usedfortheentiredelaytime.(SeeSection5.1.2fordetailsonsettingthethresholdsinthe
ConfigurationSettingswindow.)

Asimilaruser‐enteredthresholdvalueisusedforfacilitynodes/turningareas.Ifthetimespent
atthefacilitynodeislessthanthethreshold,thenatseacostsareapplied,otherwiseinportcosts
areappliedtothetimewaiting.

Delaytimeattheentrancepoint(baronly)arecalculatedbaseduponthedelayduration;for
delayslessthantwohoursatseacostsareapplied,inportcostsareappliedfordelaysoftwo
hoursorgreater.

Inportcostsareappliedtoalldelaysincurredatentrypoints.
Foreignanddomesticoperatingcostscanbeassignedforeachvesselclass.HarborSymdetermines
theappropriatecoststoapplyforeachuniquevesselmovementbaseduponthevesselflag.Domestic
costsareappliedto“AMER”flaggedvessels.Foreigncostsareappliedtoallotherflaggedvessels,
includingthegeneric“Z_For”designation.Ifnoflagisdesignatedforauniquevessel,HarborSym
appliesforeignoperatingcoststomovementsmadebythatship.
3.2.5.3 Vessel Size Units, Sailing Drafts, and Underkeel Clearance Additionalattributeswhichmustbeassignedatthevesselclasslevelincludevesselsizeunits(VSU),
sailingdrafts,andunderkeelclearancerequirements.TheVSUisanabstractconceptthatallowsthe
usertoprovideamulti‐dimensionalaccountingforvesseldimensions.TheVSUisassignedatthe
vesselclasslevelandisappliedasarestrictionatturningbasinsanddocks.WhenassigningaVSUtoa
particularvesselclass,usersshouldconsideroperatingpracticesthatmightlimitthenumberorsize
ofvesselsthatcansimultaneouslyoccupydocks,turningbasins,andanchorages.Asanexample,a
dockmayhavetwocranesforloadingandunloadingvessels,thushavingauser‐definedVSUcapacity
of2.Ifavesselclass,hypotheticallycalledClassA,representslargervesselsthatutilizebothcranes
duringtheirdockvisits,theVSUassignedshouldbe2.Asmallervesselclass,ClassB,mayhaveauser‐
definedVSUof1ifonlyonecraneisoccupiedduringadockvisit.Underthisscenario,onlyoneship
fromClassAcanvisitthedockatatime,whileuptotwoshipsfromClassBcanutilizethedock
simultaneously.
10 Section 3  HarborSym Overview Minimumandmaximumsailingdraftsareassignedtoeachvesselclass.HarborSymusesthesevalues
whendeterminingvesselsailingdraftsaftercommoditytransfers.Consideringtheamountofcargo
dischargedorloadedatthedockandtheuniquevesseltonsperinchimmersion(TPI)factor,
HarborSymcalculatesthevessel’soutboundsailingdraft.However,operatingpracticesintheport
mayresultinactualsailingdraftsthatdonotmatchthestraightnumericalcalculation(suchasballast
adjustmentsorincreasingbunkerage).HarborSymcalculatesthevesselsailingdraftandappliesthe
calculatedvalueunlessthisvalueisbelowtheclass‐basedminimumorabovetheclass‐based
maximum.AdditionalinformationontheseproceduresisavailableinSection3.3.2,Draft
Adjustments.
Underkeelclearancevalues,infeet,arerequiredforeachvesselclass.Inreacheswithassigned
underkeelclearancedraftrules,HarborSymaddsthemandatoryclass‐basedclearancevaluetothe
uniquesailingdrafttodeterminetheminimumwaterdepthnecessaryforthevesseltotransit.For
outboundmovements,HarborSymconsiderstheunderkeelclearancerequirementwhensettingthe
outboundsailingdraftaftercommodityexchangesatadock.
3.2.5.4 Priority Vessels Vesselclassescanbedesignatedas“priorityvessels”.Thisfunctionisintendedtosimulatethe
behaviorofvesselsthatreceivepreferentialtreatmentinharborssuchthattheyareinfrequently
subjectedtoqueuingdelays.Typicalvesseltypesfallingintothiscategoryincludecruiseshipsand
LNGtankers.HarborSymgivesavesselprioritybyinsertingitintothesystemwellinadvanceofits
actualarrival,suchthatsubsequentvessels,whendeterminingtheirpossiblepassagethroughaleg,
willtakeaccountofthepriorityvessel.Intheory,apriorityvesselcanproceedthroughthesystem
unimpededandbecauseHarborSyminternallykeepstrackoffuturevesselarrival/departuretimesin
eachreachofaleg,itispossibleto“pre‐schedule”thepriorityvesselthroughallofitslegs,ineffect,
requiringothervesselstotakeintoaccountthepresenceofthepriorityvessel.Toreachthisoutcome,
HarborSymsimulatestheperiodofanalysistwiceforeachsimulationusingpriorityvessels.Thefirst
runprocessesonlythepriorityvessels,inessence,givingtheseshipsfreeaccesstothechannelsand
docksastheyonlyfacecongestioneffectswithotherpriorityvessels.Thesecondrunprocessesthe
priorityvesselsandallothervessels.Inthissecondrun,thenon‐priorityvesselshaveadvance
knowledgeofwhenpriorityvesselswillrequireuseofchannelsanddocks,andfacedelays
accordingly.
Duetothe“pre‐scheduling”approachappliedinHarborSym,priorityvesselsmaynotprocessinthe
secondruniftheyaredeletedfromthesimulation(seeSection9.3foradditionalinformationon
deletedvessels).Vesselsthatdonotcompletetheircallbecausetheyremaininthesystematthe
conclusionofthesimulationperiodaretermed“retainedvessels”inHarborSymvernacular.To
ensureallretainedpriorityvesselsarecapturedinthesimulationofthefullvesselcalllist,theuser
candirectHarborSymtoextendthesimulationperiodforthepriorityvesselsonly.Allpriorityvessels
thatexitthesystemwithinthenormalsimulationperiodplustheextendedsimulationtimeare
includedinthesecondrun.Statisticsreportedinthesummaryoutputreportswillbeaccumulated
onlyforvesselsthatcompletetheircallsbythescenariospecifiedduration.Forexample,ifthe
extendedtimeperiodissettoallow10extradaysonan800hoursimulation,thepriorityvesselsrun
willprocessfor1040hours,andallvesselsthatcompletetheircallswithinthe1040hourswillbe
availabletothenon‐protocolrun,butstatisticsonthevesselsthatcompleteafter800hourswillnot
becaptured.Thesecondrun,simulatingthefullvesselcalllist,willprocessforthedesignated800
hoursimulationperiod.
11 Section 3  HarborSym Overview 3.2.6 Commodity Categories and Critical Commodities Commoditiesarethecargothatisloadedandunloadedbythevesselattheharbordocks.
Commoditiesarecategorizedbytheuserbasedupontheavailablemanifestdata.Theuserdefinesthe
unitsofmeasureforeachcommoditycategory(i.e.,TEUs,tons,cars,passengers,etc.)andthetonsper
unitofmeasure.Theusermustalsodefinetheloadingandunloadingtimeatdocksforeach
commoditycategory.Commoditieswithspecialhandlingprotocolscanbedesignatedas“critical
commodities”,whichallowstheusertodefinerulebasedoperatingpracticesthatmustbeobserved
forvesselscarryingthespecifiedcommodities.Aftercommoditiesaredefined,theuserestablishes
whichvesselclassesareabletocarrywhichcommoditycategories.
Commoditiescanbeclassifiedas“critical”fortheapplicationofacommodity‐specifictransit
restriction.Userscanrestrictmeeting(passingorovertaking)oftwovesselswithinareachifeither
vesseliscarryingacommoditydesignatedasa“CriticalCommodity”.Forthisrestrictiontoapply,at
leastonecommoditycarriedoneithervesselmustbedesignatedacriticalcommodityandthe
applicablerulemustbeestablishedwithinthereach.Section3.2.11andAppendixBprovide
additionaldetailsonvesseltransitrules.
3.2.7 Dock Visits and Commodity Transfers Vesselcalls,dockvisits,andcommoditytransfersareeachuniqueactivitieswithinHarborSym.A
dockvisitisonevisitbyavesseltoadock.Forvesselcallswithmultipledockvisits(intra‐harbor
movements),theusermustspecifytheorderinwhicheachdockisvisited.Acommoditytransferis
theloadingorunloadingofonecommodityfromonevesselduringadockvisit.Transfersofmultiple
commoditiestypesatasingledockarenotnumberedorordered.
Thevesseltimeatadockiscalculatedasthesumofthevesseldockingtime,thetotalcommodity
transfertime,andthevesselundockingtime.Theuserprovidesminimumandmaximumdockingand
undockingtimes,bycombinationofvesselclassandindividualdock,fromwhicharandomnumber
representingeachofthedockingandundockingtimesisgenerated.Thecommoditytransferis
calculatedbasedonuserdefinedtriangulardistributions(minimum,mostlikely,andmaximum
values)forthecombinationofvesseltype,dock,andcommodity.Notethattotalcommoditytransfer
timeisadditiveforeachcommoditythatistransferred–HarborSymdoesnotprovidefor
simultaneousprocessingoftwoormorecommoditytransfers.HarborSymalsocapturesandrecords
timevesselsspendatthedockina“wait”statusduetosystemconflicts.
3.2.8 Vessel Route Groups Economicanalysisofchanneldeepeningalternativesrequiresadditionalinformationforeachvessel
call,specifyingtheoceansailingdistancetobeassignedtothecall.HarborSymusestheconceptof
“routegroups”asanalternativetodirectlyspecifyingthisdistanceforeachvesselcall.Aroutegroup
isanameditineraryorportionthereofthatavesselmaytravelbeforeandaftervisitingtheportunder
study.Itinerariescanbedefinedgenerallybylargergeographicareasormorespecificallywhen
individualportsareknown.Ifexactport‐to‐portitinerariesareknown,thenthedistancecanbefixed,
otherwise,atriangulardistributionofdistancescanbespecified.Anappropriateusageof
distributionswouldbe,forexample,iftheexactportinWesternEuropeisnotknownormayvary.
EachvesselcallmustbeassociatedwithaRouteGroup.WhentheexactRouteGroupforavesselcall
isknown,thisinformationshouldbespecifiedinthePortTrafficTemplate,seeSection6.6for
additionaldetails.HarborSymallowstheusertodefineadefaultRouteGroupforeachvesselclassand
designatethepercentageofvesselswithinthevesselclasstraversingagivenRouteGroup.Duringthe
12 Section 3  HarborSym Overview PortTrafficimport,callswithunknownRouteGroupsareassignedtoaRouteGroupgiventhese
percentages.Thus,theexactassignmentofseadistancetoindividualcallsisnotstrictlynecessary
becausecosts(inportandatsea)areassociatedwithavesselclassandseadistanceisassociatedwith
aRouteGroup.Thisallowanceisapplicableaslongastheoverallassignmentstotheclassare
reflectiveofthedistributionofdistancestraveledbyvesselsofthatclass.ForeachRouteGroupthe
usermustassignminimum,mostlikely,andmaximumdistancesbetweenthestudyportandtheprior
andnextportsofcall.Inaddition,theseparametersmustbespecifiedforanadditionalseadistanceto
coveradditionaloceansailingdistancesnotcoveredbythepriorandnextportsofcall.AllRoute
Groupdistancesmustbeenteredinnauticalmiles.
HarborSymusesthesedistributionstoseparatelygeneratethethreedistances(priorport,nextport,
andadditional)foreachvesselcalland,consequently,atotalcostatsea.Thetotalhoursatseaare
establishedbydeterminingthetotalseadistance(priorportdistance+nextportdistance+additional
seadistance)dividedbythevesselspeed.Vesselspeediscalculatedbasedonauserdefined
distributionofknots,ornauticalmilesperhour.Thevesselcostatsea,whichisenteredascostper
hour,ismultipliedbytotalatseahourstogeneratethetotalatseacost.
ThelimitingdepthforthepriorandnextportofcallmustbespecifiedforeachRouteGroup.Limiting
depthforthepriorandnextportisnotuseddirectlybyHarborSym.Rather,priorandnextport
limitingdepthisutilizedintheCLT,amoduledevelopedtoassisttheuseringeneratingafuturecall
listforcontainershipsthatislinkedtotheHarborSymIDB.NextportisusedbytheCLTtodetermine
theamountofcargothatcanbeloadedonacontainershiptraversingagivenroute.Priorportlimiting
depthisusedinbytheCLTtodeterminehowfullyladenavesseltraversingagivenrouteentersthe
portofstudy.Thisfeaturepreventscreationofavesselcalllistwithvesselsloadingorunloading
cargoatthestudyportthatisinexcessofthephysicalconstraintsatotherportsintheroute.User’s
shouldfollowCorpsguidanceontheassumeddepthforpriorandnextportswithinaRouteGroupfor
thewith‐projectcondition,consideringthefutureexpansionofthePanamaCanal.
Knowledgeofavessels’oceanjourneyisnotnecessarytocompleteachannelwideningstudy.Iftheat
seamileagewillnotimpactthestudyresults,theseparameterscanbesetto1.IfusingHarborSymto
simulateawideningstudynotimpactedbyvesselroutes,thepriorandnextportlimitingdepths
shouldbesettoavaluehigherthanthestudyportlimitingdepth.
ToaidplannersincollectingandanalyzingthedatanecessarytopopulateRouteGroupsforagiven
studyarea,IWRdevelopedtheAutomaticIdentificationSystemDataAnalysisandPre‐Processor(A‐
DAPP).TheA‐DAPPprovidesthecapabilitytovisualize,analyze,andsynthesizehistoricalAutomatic
IdentificationSystem(AIS)dataforuseincontainerportchannelimprovementstudiesandassociated
simulationmodeling.Duringthemodelprocessing,theA‐DAPPanalyzesavessel’spingaswellasthe
vesselcharacteristicsandportinformationtoidentifytheRouteGroups,Services,andArrivalDraft
detailsforavesselcall,amongothercapabilities.WithintheA‐DAPPcontext,aRouteGroupnameis
providedthatindicatesthepriorport,nextport,andadditionalregionsvisited.Formoreinformation
ontheA‐DAPP,pleaserefertotheA‐DAPPUser’sGuide.
3.2.9 Vessel Movement Behavior VesseltripsinHarborSymbeginwhenavessel“arrives”atauser‐definedsystementrypoint
accordingtothearrivaltimeinthevesselcalllist.HarborSymcalculatesthevessel’sjourneywithin
theportbaseduponthedestinationdocks,transitspeeds,andsystemconflicts.
13 Section 3  HarborSym Overview 3.2.9.1 Legs HarborSymsimulatesthemovementofvesselsthroughthesystembaseduponspecificuserdefined
information.Vesselcallsaredefinedbythevesselphysicalcharacteristics,thetimethevesselarrives
inthesystem,thedestinationdockordocks,andthecommoditiestransferredateachlocation.
Relevantphysicalcharacteristicsoftheharbor,includingelementssuchasvesselspeedsinreaches,
commoditytransferrates,andturningbasinusage,arealsoprovidedbytheuser.
Eachcompletevesselcall(voyagefromentrytodestinationdock(s)throughtoexitandoceanvoyage)
isconsideredtobecomposedofasetof“legs.”Alegisacontiguoussetofreachesbetweenstopping
points.HarborSymassumesthatadeep‐draftvesselcannotstopexceptatdocksoranchorages.The
legsofthevesselcallarethusthesetsofreachesfromtheentrancetothefirstdock(Leg1),fromthe
firstdocktotheseconddock(Leg2),etc.andfromthefinaldocktotheexit(Legn).Transitrulesare
checkedasavesselpreparestoenteraleg(e.g.,uponarrivalattheentranceordeparturefroma
dock),basedonthescheduledmovementsofallothervesselsthathavealreadyentered(or,inthe
caseofpriorityvessels,willenter)thesystem.Avesselcanonlystartmovingwithinalegwhenno
transitrulerestrictionsareactivatedforanyofthereachesintheleg.Akeyassumptionofthe
simulationisthatonceavesselismovingwithinaleg,ithaspriorityoverallothervesselsthat
subsequentlyentertheleg.Ifrulerestrictionsareactivated,thevesselmustwaitattheentry,dock,or
anchorage,untiltherulerestrictionsituationnolongerexists,atwhichtimethevesselcanenterthe
leg.
Onceavesselreachesastoppingpointinthesystem,HarborSymcalculatestheamountoftimespent
atthelocationbasedupontheactivitiestobecompleted(i.e.,dockingandundocking,andcommodity
transfers)anddelaysduetosystemconflictsrestrictingdeparture.Whenthenextlegofthevessel’s
tripisfreeofconflicts,thevesselproceeds.Undercertainconditions,vesselscanproceedpartway
throughalegtoreachananchorage,wheretheycanwaituntiltheycancompletetheleg,checkingthe
transitrulesfortheremainderofthelegatuser‐definedintervalstoseeiftheycanproceed.
HarborSymwillautomaticallydirectvesselstoanavailableanchoragewithinthevesselsdesiredroute
ifthecapabilityisactivatedforthesimulation.Notethataturningareaisnotconsideredan
intermediatestoppingpoint–thetimespentinaturningareaisaccountedforintheinitialtestingof
potentialconflictswithintheleg,andavesselleavesaturningareaatitsscheduledtimewithout
additionaltestingoftransitrulesfortheremainderoftheleg.
Theoceansailingvoyagelegofavesselcallisnotsubjectedtoruletesting.Foreachroutegroupthe
userprovidesstatisticsonthedistancebetweenthestudyportandprior/nextportsofcallinthe
vessel’svoyage,aswellasanyadditionalseadistancetraveledonthevoyage.Fromthese
distributionsspecificdistancesareassignedtoeachvesselcall,whichareaddedtothein‐portportion
ofthevesselvoyage.
3.2.9.2 Vessel Path SeveraloftheHarborSymoutputs,asdescribedinAppendixC,reporta“path”foreachindividual
vesselcall.Thisdescribestheseriesoflegsavesseltravelsduringacalltotheport,including
intermediatenodes.Suchavesselpathmightreporttheentrancenode,theturningbasinused,the
docksvisited,andtheexitnode.Anchoragesarenotyetincorporatedintothepath.
3.2.9.3 Speed in Reach and Reach Transit Time Thereachtransittimeisthetimeavesseltakestotraverseareachfromstartingnodetoendingnode.
Transittimeofavesselthroughareachisdeterminedbasedonthereachlength,andthevesselclass
14 Section 3  HarborSym Overview specificsailingspeed.Ineachreach,thesailingspeedsareassignedforvesselclassesbaseduponthe
cargostatusoflightorloaded.HarborSymdetermineswhichspeedtoapply(lightorloaded)based
upontherelativecommodityquantitiesonboardduringthevessel’sinboundandoutbound
movements.Ifthesumofallthecommoditytransfersforthecallisanetimporttotheport,thenthe
vesselisassumedtobeloadedatarrival;conversely,ifthesumofcommoditytransfersisanetexport
fromtheport,thevesselisassumedtobelightonarrival.Thevesselstatusisswitchedatthefirst
dockatwhichthecommoditytransferatthatdockisconsistentwiththenetbehavior.Forexample,if
thevesselcallisanetexportcall,thenthevesselarriveslight,butwillswitchstatusatthefirstdockat
whichtherearenetexportcommoditytransfers(addingloadingtothevessel).Improvementstothe
harbormaydecreasereachtransittimesbyincreasingtheaveragespeedofvesselsinthereach.
3.2.9.4 Vessel Passing and Overtaking Tomimicrealworldbehavior,HarborSymallowsvesselstoovertakeandpassothershipswithinthe
systemunlessthebehaviorisrestrictedbytheuserthroughatransitrule.Overtakingreferstotwo
vesselsmovinginthesamedirectioninachannelreach.Avesseltravelingatafasterspeedmaymove
infrontof,orovertake,avesselmovingmoreslowlythroughthechannelsegment.InHarborSym
terminology,passingreferstothebi‐directionalmovementoftwovesselswithinareach.Thedefault
settinginHarborSympermitsinboundandoutboundvesselstotravelsimultaneouslythroughthe
channel.Theumbrellaterm,“meeting”,referstobothpassingandovertaking.Nomeetingwould
meannopassingorovertaking.Noovertakingimpliesthatpassingisnotallowedwherebothvessels
aregoinginthesamedirection.Nopassingrestrictsvesselmovementnotallowingpassingwhen
vesselsaregoinginoppositedirections.
3.2.9.5 Intra‐Harbor Movements WithinHarborSym,vesselsarepermittedtomakemultipledockvisits.Whenshipsvisitmultiple
dockswithinasinglevesselcall,theusermustdefinetheorderinwhichthedockswillbevisitedand
providespecificcommoditytransferquantitiesateachlocation.Withthisinformation,HarborSym
calculatesa“docktodock”leg,wherethevesselmaybeforcedtowaitatthefirstdockifsystem
conditionspreventitsfreetransittothenextdockonitsroute.Inthecurrentmodelframework,
vesselsvisitingmultipledocksduringonevesselcallwillturnintheturningbasinassociatedwith
eachdockoftheirvoyage.Themodeldoesnotcurrentlyhavethecapabilitytoeliminateturningbasin
visitsin‐betweenmultipledockvisits.Thepresentversionofthemodelallowsforamaximumof5
dockvisitsforacall.
3.2.10 Elements of Variability HarborSymisaMonteCarlosimulationmodelwithvariabilityincorporatedintospecificelementsof
thesystem.Theseinclude:

VesselArrivalTime:thevesselcalllistimportedintoHarborSymormanuallycreatedintheuser
interfaceprovidesaspecificarrivaldateandtimeforeachvesselcallingthesystem.When
multipleiterationsaresimulatedusingthesamecalllist,HarborSymperturbsthearrivaldate
andtimeofeachcallbetweeniterations.Thisisaccomplishedbyaddingarandomfractionofa
daytothestoredarrivaldate/time.Theperturbationisonlyadditive;thearrivaldate/timefor
iterationsafteriteration#1areneverlessthantheuserprovidedschedule.

VesselOperatingCosts:thevesseloperatingcostsforeachvesselcallaredrawnfromatriangular
distribution.Theminimum,mostlikely,andmaximumoperatingcostsarepopulatedatthe
vesselclasslevel.
15 Section 3  HarborSym Overview 
TurningTime:thetimevesselsspendexecutingturningmaneuversisdrawnfromatriangular
distribution.Theminimum,mostlikely,andmaximumturningtimesarepopulatedforeach
turningarea.

VesselDockingTime:thetimevesselsspenddockingandundockingisdrawnfromauniform
distribution.Theminimumandmaximumdocking/undockingtimesarepopulatedforeach
dock–vesselclasscombination.

CommodityTransferRates:thetimerequiredtoloadandunloadcommoditiesisdrawnfroma
triangulardistributionofunitsperhour.Theminimum,mostlikely,andmaximumloading/
unloadingtimesarepopulatedforeachdock–vesseltype–commoditycategorycombination.

SpeedatSea:thevesselsailingspeedatseaforeachvesselcallisdrawnfromatriangular
distribution.Theminimum,mostlikely,andmaximumsailingspeedsatseaarepopulatedatthe
vesselclasslevel.Expressedinknots,ornauticalmilesperhour.

AtSeaDistances:asdiscussedinSection3.2.8,distancesbetweenthestudyportandprior/next
portsofcall,aswellasanyadditionalatseadistances,areenteredastriangulardistributionsfor
eachRouteGroup.Expressedinnauticalmiles.
3.2.11 Vessel Transit Rules ThedefaultconditioninHarborSymallowsallvesselstomovethroughthesystemwithoutany
restrictions,includingthefreedomtooperatebeyondsetchanneldimensions.Suchoperationsallow
theuserstoestimatethetrafficflowandassociatedtransportationcostsinacompletelyunrestricted
system.However,tobetterapproximatetherealitiesofvesseloperationsinaharbor,HarborSym
includestransitrulestolimitvesselmovements.Theuserassignstransitrulestoreachesofthe
networkfromamenuofpre‐definedrules.Rulesaredefinedintermsofthetypeofrule(e.g.,no
vesselmovement,nopassing),applicablecondition(day,night,anytime),andvessel‐specific
parametersthatcharacterizetherule’sapplication(e.g.,beam,draft,lengthoverall).Forexample,a
rulemaystatethattwovesselsmaynotpassatnightinagivenreachiftheircombinedbeamwidth
exceeds250feet(76.2meters).Otherruleswithinthemodelrelatetovesselmovementunder
maximumcurrentconditionsorspecificdraftlimitations.Capacitylimitscanalsobespecifiedfor
docks,turningbasinsandanchorages/moorings.
Therulescurrentlyimplementedarebasedonproceduresofpilotsinspecificports.However,the
rulesaregeneric,suchthatusersparameterizetheapplicationbyspecifyingtheapplicableconditions
andvesselphysicalcharacteristicsthatapplytoagivenreach.Thisapproachallowsthemodeltobe
portablebetweenmanystudyareas,althoughitisunderstoodthatallpossibletransitrulesmaynot
beincorporatedintotheexistingmodelframework.Allrulescurrentlyimplementedarediscussedin
detailinAppendixB.
Vesseltrafficrulesimpactharbortrafficbypotentiallydelayingavessel’stransitthroughareach
whileitwaitsforharborconditionstochangeorforanothervesseltoleavethereach.Vesselsalready
transitingthesystemaregiventheright‐of‐way,suchthatvesselstestingreachavailabilitywillbe
delayedifanothervesselisalreadyscheduledtooccupythereachandthesimultaneoususagebyboth
shipswouldcreateaconflict.
TheruleswithinHarborSymcanbegeneralizedintoseveralbroadcategoriesofdelay,asoutlinedin
Table2.Evaluatingoutputbaseduponthesegeneralgroupingscanassisttheuserindeterminingthe
16 Section 3  HarborSym Overview primarycausesofdelaywithinthesystem.Itshouldbenoted,however,thatoftenasingledelaycan
becausedbymultipleruletriggersinmanyreachessimultaneously.HarborSymreportsalltriggersto
presentacompletepictureofthesystemconflicts.
Table 2: HarborSym Traffic Rule Wait Cause Categories Cause Association
Abbreviation in Output Vessel Size Constraint Rule
VSC
Congestion Rule
C
Buffer Zone Rule
BZ
Critical Commodity Rule
CC
Tide Rule
T
Anchorage VSU Constraint Anchorage Usage
AVSU
Anchorage Number of Vessels Constraint Anchorage Usage
AVN
Anchorage Depth Constraint Anchorage Usage
AVD
Turning Area Number of Vessels Constraint Turning Area Usage
TAVN
Turning Area Depth Constraint Turning Area Usage
TAD
Turning Area VSU Constraint Turning Area Usage
TAVSU
Dock VSU Constraint Dock Usage
DVSU
Dock Number of Vessels Constraint Dock Usage
DVN
HarborSymincludestwofamiliesoftransitrules,singlevesselandmultiplevessel,asdescribedbelow.
SingleVesselRulesinvolveonlyonevesselandtheappropriatevesselparametersareenteredonlyfor
the“movingvessel.”Anexamplesinglevesselrulerestrictssailingatnightwhenavesselexceedsa
setsizethreshold(e.g.,capacitylimitations).Anothertypicalsinglevesselruleisasailingdraft
restriction,whichwillprohibitvesselsdraftinggreaterthanauserdefinedvaluefromtransitinga
specificreach.
MultipleVesselRulesinvolveencountersbetweentwovessels.Parametersmustbeenteredforthe
“movingvessel”andthe“othervessel.”Anexampleofamultiplevesselruleisarulethatnovessel
overasizethresholdmayencounter(overtakeorpass)apriorityvessel.
Individualtransitrulescanbeappliedport‐wide,suchthattheexactrestrictionappliesinallreaches.
Forexample,ifovertakingisnotpermissibleinanysectionoftheharbor,thiscanbesetasaport
transitruleratherthanenteringtheruleineveryreach.Cautionshouldbetakenwhenaddingport
leveltransitrules,astheyapplytoallreachesthroughoutthesystemandallprojectswithinastudy.
Therefore,activeportleveltransitruleswillenforcetherestrictionuniversallyinallprojects,which
maynotbeaccurateifafutureconditionwillalleviatetheneedforsucharestriction(suchasa
channelwideningalternativeunderwhichovertakingispermissible).
NotethatHarborSymdoesnotenforceany“logical”restrictionsintheabsenceofactivatedrules–in
anactualharbor,vesselsarenotphysicallyabletotransitareachiftheirdraftrequirementsare
greaterthanthereachdraft.InHarborSym,however,thisrestrictionisnotappliedunlessthe
appropriateruleismadeactiveforthereach.
3.2.12 Safety Zones Asafetyzoneissimilartoplacingabubblearoundavesselasitmoves.Thedistanceextendsfromthe
ship’sbowandtheship’sstern,asshowninFigure2.Thesafetydistance,designatedbytheuser,is
17 Section 3  HarborSym Overview equalforbothsides.Nomovingvesselsareallowednexttothedesignatedsafetyvessel.Safetyzones
areuser‐definedcharacteristicsspecifictothecommodity.[A“safedistance”ruleprovidesasimilar
capabilitybutisindependentofthecommoditybeingcarried.]Theuserdefinedcharacteristics
describehowthemodelshouldtreatvesselscarryingthesecommodities.Additionaldetailsonthe
applicationofsafetyzoneswithinHarborSymareavailableinSection6.10.
Stern
Safety Zone
Safety Zone
Bow
Figure 2: Safety Zones Local,state,andnationalagenciessetguidelinesthatrequiresafepassageofcertaincommoditiessuch
asLiquefiedNaturalGas(LNG),LiquefiedPetroleumGas(LPG),AnhydrousAmmonium(NH3)and
otherpotentiallyhazardouscommodities.Safetyzonesrepresentthesevesselmovementsinthe
harbor.Vesselscarryinghazardouscommoditiesrequireagreaterdistancefromothershipsto
ensuresafepassage.HarborSymusersdesignatecommoditiesrequiringsafetyzones,zonesize,when
andwherezonesareactive.Vesselscarryingthedesignatedcommodityaretriggeredtohavesafety
zonesnomattertheamountcarried.
HarborSymrecognizescommoditiesratherthanspecificvesselstotriggersafetyzones.However,
vesselsmayenterportwithasafetycommodityandexittheportwithnone,andviceversa.
HarborSymallowstheusertospecifybothlegsortheonelegwiththecommoditytohaveactive
safetyzones.Safetyzonerulescanbedesignatedtoapplyonlywhenavesseliscarryingthesensitive
commodityorduringtheentirevoyageofavesselthatcarriesthecommodityforonlyaportionofits
trip.Forexample,ifLNGisexportedfromastudyareaandtreatedasasafetyzonecommodity,aLNG
tankermayarriveattheportcarryingnoLNGandloadsomequantityatthedock.Userscan
designatesafetyzonerulestoapplyonlytotheoutboundmovementwhenthevesselcarriesLNGor
forboththeinboundandoutboundlegs,regardlessoftheamountofcargocarriedduringeither
segment.Userswilldeterminethismodelsettingbasedonportrulesandotherguidelines.
HarborSymallowstheusertoactivateallharborreachesorspecificreachestohavesafetyzones
applied.Safetyzonesareexaminedforruleviolationswhenvesselscarryingdesignatedcommodities
enterthereacheswherethesafetyzoneismarkedactiveandasafetyzoneruleexists.Reaches
withoutsafetyzoneswilltreatvesselscarryingdesignatedcommoditiesthesameasallothervessels.
3.2.13 Rule Violations / Triggers Ruleviolationsaredeterminedwhenalegischeckedpriortovesselentry.Ifaruletriggeror
activationoccurs,thenthetestingvesselcannotproceeddirectlytoitsdestinationintheleg.Itmust
18 Section 3  HarborSym Overview insteadeitherdelaytravelingorproceedasfaraspossibletoanavailableanchorage,waitingthere
untilitcanattempttocontinuethejourney.HarborSymdoesnotallowaruleviolationtooccur,but
maintainsafileofalleventsinwhicharulewastriggeredandpreventedvesseltransit.Additional
informationonthemodelprocessinglogic,includinghowruletriggersareimplemented,isincludedin
Section3.3ModelBehavior.
3.2.14 Tide and Current Modeling Wheneverthereisapredictablewaterdepthgreaterthanthechannelcontrollingdepth,the
additionaldepthislikelytobeusedintheoperationsofthedeepestdraftingvesselscallingtheport.
Theadditionalwaterdepthcanallowvesselstoenterthesystemthatwouldotherwisebeprevented
duetoinsufficientcontrollingdepth.Useoftidesmayinvolvevesseldelaycoststhatcanbeimpacted
byphysicalmodificationstothenavigationchannels.Inordertosimulatetheseconditions,
HarborSymrequiresinformationontheapplicabletidelevelsatthestudyport.
TidepredictionisneededforHarborSymbecauseoftide‐relatedrules.Typicaltidalrulesrelateto
singlevesselmovements,limitedbydepthorcurrent.Atypicalcurrentrulewouldrestrictsailingif
vesseldraftisgreaterthanacertainamountwhilecurrentexceedsaspecifiedamount.Adepthrule
limitssailingbasedon“maximumdraftplustide”,i.e.,avesselcannotmoveinachannelunlessthe
draftplusthecurrenttidaldepthisgreaterthansomevalue.Thus,tidepredictionisrequiredforboth
currentandtideheight.
HarborSymutilizesthetidepredictionengineWTidesdevelopedbyPhilipThornton
(http://www.mdr.co.nz/)toestimateastronomicaltideheightandcurrentlevels.Thesearethesame
valuescommonlypublishedintidetables,butarenotthemeteorologicaltideorcurrentvaluesthat
maybeinfluencedbystorms.Tideandcurrentarepredictedandstoredforuserselectedtidal
stationsforthestudyareainone‐hourincrementsforthedurationofthesimulation.Tidereference
stationsareidentifiedseparatelyfromcurrentreferencestations.Uptotwotidestationsarespecified
foreachreach,withauserdefinedweightingvalue(between0and1)assignedtodeterminethe
contributionofeachtidalstationtothereach.Theinterpolationprovidesanestimateofthewater
depthandcurrentvelocitythroughoutthereachduringthesimulation;withinHarborSym,tideor
currentvaluesdonotvaryalongthelengthofareach.Notethattide/currentvaluesarepredicted
onlyforreaches,notfornodes–valuesfornodesarederivedfromthevaluecalculatedforthereach.
Notealsothatunlessreferencestationsandinterpolationvaluesareproperlyselectedforreaches,itis
possibletogetdifferenttidalpredictionatanode,dependinguponwhichreachisusedforthetide
calculation.AdditionaldetailonsettingtidestationsinHarborSymisdescribedinSection6.8.
Currently,HarborSymdoesnotincludethecapabilityforuserstoidentifysecondarytidalstationsnot
includedintheWTidesdatabase.Ifonlyonereferencepointisidentifiedwithinthestudyandan
interpolationvalueof1isenteredforallreaches,allnodesandreacheswillhaveuniformwaterdepth
andcurrentvelocity.TheIWRTideTool,aseparate,standalonemodel,iscapableofgenerating
secondarytidestationsforimportintoHarborSym.TheIWRTideToolUser’sManualprovides
instructiononhowtointegratetheoutputsintoaHarborSymstudy.
3.2.15 Scenario Ascenarioisthesetofdefinedrunparametersthatspecifytheconditionsofasimulation.Scenarios
havenamesandareretainedforfuturereference.Thesamescenariocanbeusedforsimulationsof
vesseltrafficonmultipleprojects.
19 Section 3  HarborSym Overview 3.2.15.1 Simulation Duration and Start Date Themodelsimulatesvesseltrafficstartingatmidnightonthestartdateandcontinuingforthe
durationspecifiedbytheuser.Thedurationisspecifiedinhours(alltimeinthemodelisinhours).
Onlyonesimulationperiodcanbespecifiedinascenario.Theusercanspecifyanysimulationperiod
withinayear,anentireyear,orlonger.Notethatonlyarrivaldateswithinthevesselcalllistthatfall
withinthesimulationperiodareprocessed,soappropriatecorrespondencebetweenthescenario
specificationofstartdateanddurationandthevaluesinthevesselcalllistisnecessary.
3.2.15.2 Number of Iterations AMonteCarlosimulationconsistsofmultipleiterationsofvesseltrafficflowduringthesametime
period.Statisticsaredevelopedfromthemultipleiterationsofthesimulation.Oneiterationofa
simulationisonedurationperiodstartingatthescenariostartdate.Thedifferentparameters
affectingvesselstransit(commoditytransfers,dockingtime,etc.)varybetweeniterationswithinthe
inputrangesetbytheuser.Theuserspecifiesthenumberofiterationsofthesimulationtobecarried
outwhendefiningthescenario,basedupontheneedforaccuracy.Asthenumberofiterations
increases,thestabilityofthesimulationoutputshouldincrease.Theoptimalnumberofiterationswill
varybystudyareadependinguponthedegreeofvariabilityintheuserdefinedparameters.
Evaluatingtheoutputreportswillprovideinsightintothemodelstability.Dependinguponthe
specificconditionsatagivenstudyarea,usersmayconsiderrunningfirst100,then500,then1,000
iterationstoevaluatethevariabilityinoutputsanddeterminetheoptimalnumberofiterationsforuse
throughouttheevaluation.
Forinitialtestingofthevesselcalllistandinputdataviability,onlyasingleiterationofthesimulation
istypicallynecessary.
NotethatwhenusingtheBLTand/orCLTtodevelopafuturesyntheticvesselcalllist,eitherasingle
iterationormultipleiterationVCDBcanbegenerated.IfamultipleiterationVCDBisgenerated,then
HarborSymwillloopthroughtheiterationswhenrunningasimulation.Forexample,if5iterations
weregeneratedwiththeBLT/CLTand100iterationsarespecifiedforaHarborSymsimulation,then
HarborSymwillpulliterations1‐5fromtheBLT/CLT‐generatedVCDBforiterations1‐5,then1‐5for
iterations5‐10andsoon.
3.2.15.3 Wait Times Before Retry Topreventaruleviolation,themovingvesselmustwaitifproceedingwillcauseaconflictinanyreach
ofitsleg.Thelengthoftimethevesselmustwaitbeforearetry(attempttomove)isdefinedbythe
user.Thewaittimeisdefinedinfractionsofanhour.HarborSymqueriesthesystemintheuser
definedintervaltodetermineiftheconflicthasclearedandthevesselisabletoproceed.Providing
morerefinedvaluesforwaittimebeforeretry(i.e.,5minutes)willallowHarborSymtorecognizethat
theconflicthasdissipatedmoreimmediatelyandpreventincorrectassignmentofvesseldelays.
However,inahighlycongestedsystem,requiringthesystemtocheckitsstatusatfrequentintervals
maygreatlyincreasetheprocessingtime.Usersshouldevaluatethesystemconditionsanddetermine
theoptimalvalue.Aninitialvalueof0.25hoursforeachofthewaitincrementshasbeenusedwith
success.
Differentwaittimescanbeenteredforthreetypesoflocationswherevesselswait:theentry,the
docks,andanchorages.
20 Section 3  HarborSym Overview 3.3 Model Behavior HarborSymisaneventdrivenmodel.Vesselcallsareprocessedindividuallyandtheinteractionswith
othervesselsaretakenintoaccount.Foreachiteration,thevesselcallsforaniterationthatfallwithin
thesimulationperiodareaccumulatedandplacedinaqueuebasedonarrivaltime.Whenavessel
arrivesattheport,theroutetoallofthedocksinthevesselcallisdetermined.Thisrouteis
comprisedofdiscretelegs(contiguoussetsofreaches,fromtheentrytothedock,fromadockto
anotherdock,andfromthefinaldocktotheexit).Thevesselattemptstomovealongtheinitiallegof
theroute.Potentialconflictswithothervesselsthathavepreviouslyenteredthesystemareevaluated
accordingtotheuser‐definedsetofrulesforeachreachwithinthecurrentleg,basedoninformation
maintainedbythesimulationastothecurrentandprojectedfuturestateofeachreach.Ifarule
activationoccurs,thearrivingvesselmusteitherdelayentryorproceedasfaraspossibletoan
availableanchorage,waitingthereuntilitcanattempttocontinuethejourney.[Theabilitytoallowor
disallowuseofintermediateanchoragescanbecontrolledgloballyforthesimulationbyadata
parameterintherunscenario.AdditionaldetailisavailableinSection3.2.15].Vesselsmovefrom
reachtoreach,eventuallyarrivingatthedockthatistheterminusoftheleg.
Afterthecargoexchangecalculationsarecompletedandthetimethevesselspendsatthedockhas
beendetermined,thevesselattemptstoexitthedock,startinganewlegofthevesselcall;rulesfor
movingtothenextdestination(anotherdockoranexitoftheharbor)arecheckedinasimilarmanner
totherulecheckingonarrival,beforeitisdeterminedthatthevesselcanproceedonthenextleg.As
withtheentryintothesystem,thevesselmayneedtodelaydepartureandre‐tryatalatertimeto
avoidruleviolationsand,similarly,thewaitingtimeatthedockisrecorded.
Avesselencounteringruleconflictsthatwouldpreventitfromcompletelytraversingalegmaybe
abletomovepartiallyalongtheleg,toananchorageormooring.Ifso,andifthevesselcanusethe
anchorage(whichmaybeimpossibleduetosizeconstraintsorthefactthattheanchorageisfilledby
othervessels),thenHarborSymwilldirectthevesseltoproceedalongthelegtotheanchorage,where
itwillstayandattempttodepartperiodically,untilitcandosowithoutcausingruleconflictsinthe
remainderoftheleg.Thedeterminationofthetotaltimeavesselspendswithinthesystemisthe
summationoftimewaitingatentry,timetransitingthereaches,timeturning,timetransferringcargo,
andtimewaitingatdocksoranchorages.HarborSymcollectsandreportsstatisticsonindividual
vesselmovements,includingtimeinsystem,aswellasoverallsummationsforallmovementsinan
iteration.
3.3.1 HarborSym Deepening Cost Allocation Calculations HarborSymwasinitiallydevelopedasatoolforanalyzingchannelwideningprojects,whichwere
orientedtowarddeterminingtimesavingsorvesselstransitingaharbor.Itdidnotallowforassessing
changesinvesselloadingorinshippingpatterns.ThemostrecentreleaseofHarborSymwas
designedtoassistanalystsinevaluatingchanneldeepeningprojects,inadditiontotheoriginalmodel
capabilities.Thedeepeningfeaturesconsiderfleetandloadingchanges,aswellasincorporating
calculationsforbothwithinharborcostsandcostsassociatedwithoceanvoyage.Thegoalofthe
deepeningversionistoassisttheuserinevaluatingtheeffectsofproposedchanneldeepeningin
termsoftransportationcostsavingsforvariousalternatives.Whileoverall(portlevel)informationis
ofprimaryinterest,moredetailedinformationcanbeassociatedwithvesselclasses,commoditiesand
individualvesselcalls,mayalsobeofinterest.Allocationcalculations,carriedoutatthevesselcall
level,arethekeytothisprocedure.
21 Section 3  HarborSym Overview Eachvesselcallhasaknown(calculated)associatedcost,basedontimespentintheharborandocean
voyageandcostperhour.Alsoforeachvesselcall,thetotalquantityofcommoditytransferredtothe
port(bothimportandexport)isknown,intermsofcommoditycategory,quantity,tonnageandvalue.
Thebasicproblemistoallocatethetotalcostofthecalltothevariouscommoditytransfersthatare
made.
Eachvesselcallmayhavemultipledockvisitsandmultiplecommoditytransfersateachvisit,buteach
commoditytransferrecordreferstoasinglecommodityandspecifiestheimportandexporttonnage.
Also,atthecommoditylevel,the“tonsperunit”forthecommodityisknown,sothateachcommodity
transfercanbeassociatedwithanexportandimporttonnage.Asnotedabove,theprocessisgreatly
simplifiedifallcommoditytransferswithinacallareforcategoriesthataremeasuredinthesame
unit,butthatneednotbethecase.
Whenavesselleavesthesystem,thetotaltonnage,exporttonnage,andimporttonnagetransferredby
thecallareavailable,asisthetotalcostofthecall.Thecostpertoncanbecalculatedatthecalllevel
(dividetotalcostbyrespectivetotaloftonnage).Oncethesevaluesareavailable,itispossibletocycle
throughallofthecommoditytransfersforthevesselcall.Eachcommoditytransferforacallis
associatedwithasinglevesselclassandunitofmeasure.Multiplyingthetonsorvalueinthetransfer
bytheappropriatepertoncost,thecosttotalsbyclassandunitfortheiterationcanbeincremented.
Inthisfashion,thetotalcostofeachvesselcallisallocatedproportionatelytotheunitsofmeasure
thatarecarriedbythecall,bothonatonnageandavaluebasis.Notethatthisapproachdoesnot
requirethateachclassorcallcarryonlyacommensurateunitofmeasure.
Themodelcalculatesimportandexporttons,importandexportvalue,andimportandexport
allocatedcost.Thisinformationallowsforthecalculationoftotaltonsandtotalcost,allowingforthe
derivationofthedesiredmetricsattheclassandtotallevel.Themodelcanthusdeliverahighlevelof
detailonindividualvessel,class,andcommodityleveltotalsandcosts.
Eitheralloraportionoftheat‐seacostsareassociatedwiththesubjectport,dependingonwhether
thevesselcallisapartialorfullload.Theat‐seacostallocationprocedureisimplementedwithinthe
HarborSymkernelandutilizestheestimatetotaltripcargo(ETTC)fieldfromthevesselcall
informationalongwithimporttonnageandexporttonnage.InallcasestheETTCistheuser’sbest
estimateoftotaltripcargo.WithintheBLTandCLT,theETTCfieldisestimatedascargoonboardthe
vesselatarrivalpluscargoonboardthevesselatdeparture,intons.ETTCcanalsobeexpressedas:
ETTC=2*CargoonBoardatArrival–Importtons+Exporttons
Thereisabasicalgorithmimplementedtodeterminethefractionofat‐seacoststobeallocatedtothe
subjectport.First,ifETTCforavesselcallisequaltozeroornull,thennoneoftheat‐seacostsare
associatedwiththeport.Thealgorithmthenchecksifimportorexporttonsarezeroforavesselcall.
Ifeitherarezero,thenthefollowingequationisappliedtodeterminetheat‐seacostallocation
fractionassociatedwiththesubjectport:
At‐SeaCostAllocationFraction=(Importtons+Exporttons)/ETTC
Finally,whenbothimportandexporttonsaregreaterthanzero,thefollowingequationisappliedto
determinetheat‐seacostallocationfractionassociatedwiththesubjectport:
At‐SeaCostAllocationFraction=0.5*(Importtons/Tonnageonboardatarrival)
+0.5*(Exporttons/Tonnageonboardatdeparture)
22 Section 3  HarborSym Overview Where:
Tonnageonboardatarrival=(ETTC+Imports–Exports)/2
Tonnageonboardatdeparture=Tonnageonboardatarrival–Imports+Exports
ForusercraftedvesselcallliststhatareimportedintoHarborSym,caremustbetakentoproperly
populatetheETTCfield.TheBLTandCLTmoduleswillpopulatetheETTCfield.Note,however,that
theBLTpopulatesthefieldinafashionthatassumesforallvesselcallstheat‐seacostallocation
fractionis1.Iftheuserknowsthatbulkvesselsarecarryingcargoloadedatanotherportnotdestined
forthesubjectport,theETTCfieldshouldbemanuallyadjustedaccordingly.Alsonotethatiftheuser
desiresforallat‐seacoststobeallocatedtotheport,thenETTCforagivenvesselcallshouldbe
expressedasimporttons+exporttons.
Analystsfacethedifficultissueofgeneratingvesselcallliststhatrepresentfleetarrivalsandloadings
underfuturewithout‐andwith‐projectconditions.Thatis,awith‐projectvesselcalllistmust
representthefuturefleetandcommoditydemandsforimportandexportattheport,andthe
associatedcommoditytransfersandvesselloadingsmustbereflectiveofthepossibilitiesofferedby
thedeepenedchannels.GenerationofthesevesselcalllistsistheroleoftheHarborSymBLT,CLT,and
Combinermodules.Themodulesaredesignedtogenerateavesselcalllistthatcanberunthrough
HarborSym,basedonuserprovidedinformationonthefleetandchannelconstraintsaswellas
commoditydemands,forgeneralbulkandcontainerizedvessels.Additionalinformationonthese
modulescanbefoundinSection4
3.3.2 Draft Adjustments Onarrivalatadock,thequantityofcommoditytransferredisused,inconjunctionwiththevesselTPI,
tocalculatethedeparturedraftbasedonthearrivaldraft.Draftondeparturefromthedockis
importantintheprocessofcheckingthelegtodetermineifthevesselcanproceed.IntheHarborSym
databasethearrivaldraftatthebaristhestartingpointforthesecalculations.Giventhemannerin
whichthevesselcalldatabasemaybeconstructed(fromavarietyofdatasourcesandassumptions),
andthefactthatbehaviorsuchasballastingandbunkeringisnotaccountedforinthemodel,itis
possibleforthesimpledraftadjustmentcalculationbasedonTPIandcommoditytransfertoleadto
departuredraftsthat,inconjunctionwithtransitrules,precludethevesselfromdepartingthedock.
Accordingly,provisionismadewithinHarborSymforaprocessthatadjuststheoutbounddraft,if
necessary,toplaceitwithinareasonablerangesothatthevesselcanproceed.Themaximumdraft
thatcantraversethenextleg,basedonunderkeelclearanceandtide,iscalculatedandcomparedwith
thedraftcalculatedoncommoditytransfers.Adjustmentsaremadetothedeparturedraftifneeded,
takingintoaccountuser‐definedvesselclassmaximumandminimumdrafts.Inthisfashion,vessels
donot“getstuck”whileattemptingtodepartadockaftertransferringcommodities.Theuseris
informedofanysuchautomaticadjustmentsinanoutputfile.
3.4 HarborSym User Interface WhenselectingView/StudyExplorerfromtheHarborSymmainmenu,threepanesarevisibletothe
user;theGraphicsPane,theNavigationPane,andtheDataEntryPane,asshowninFigure3.Together
thesestructuresprovidetheuserwithauserinterface(UI)thatsupportsdataentryandvisualization.
Thisstructurepresentstheuserwithavisualrepresentationofthestudyarea,detailedinformation
onasingledataelement,andtherelativepositioningoftheelementwithinthestructuralhierarchy.
23 Section 3  HarborSym Overview Figure 3: HarborSym Study Explorer
Therelativesizesofthethreepanescanbemodifiedbytheuserbymovingthebordersbetweenthe
panes.Thethreepanesarelinked,asshowninFigure4.
TheGraphicsPaneprovidesavisualrepresentationoftheharborandcanbeusedtodrawanddefine
thetopologicalfeatures.TheNavigationPanecontainsahierarchicallistingofprojectcomponents
andisprimarilyusedtocallupthedataentrygridsintheDataEntryPane.TheDataEntryPane
containsthedataentrygridsfortheusertoviewandinputdata.Thethreepanesarelinkedthrough
theinterfaceandshowrelatedinformation.Forexample,whenauserselectsadockintheNavigation
Pane,thatdockishighlightedintheGraphicsPane.TheDataEntryPaneautomaticallynavigatesto
thedockgrid,highlightingtherowwithdataassociatedwiththeselecteddock.
24 Section 3  HarborSym Overview Figure 4: Three Pane Linkage 3.4.1 Graphics Pane TheGraphicsPaneshowsthenodenetworkdevelopedbythe
user,whichisavisualrepresentationoftheharbor,asshownin
Figure5.Thenodenetworkrepresentsaprojectusingnodes
andreaches.Nodesarepointsthatrepresentanentry/exit
point,aturningarea,ananchorage,adock,oratopologicnode
indicatingachangeinchannelconditions.TheGraphicsPaneis
usedtocreatethetopologicalfeaturesofthestudyharbor.
AdditionalinformationoncreatinganetworkwiththeGraphics
PaneispresentedinSection6.2.
Figure 5: HarborSym Graphics Pane
25 Section 3  HarborSym Overview 3.4.2 Navigation Pane NavigationPanecontainsfivehierarchicallistingsforeach
project;VesselInfo,CommodityInfo,PortStructures,Port
Traffic,andTide.Theselistingsareobtainedbyclickingon
theplusicontotheleftoftheprojectnameasshowninFigure
6.Totheleftofeachoftheselistingisaplusicon,whichcan
callthenextlevelofdetail.TheplusicontotheleftofVessel
Infowillcallthevesseltypes.
Figure 6: Navigation Pane TheplusicontotheleftofCommodityInfowillcallupeachof
thecommoditycategories.TheplusiconnexttoVesselInfo
willcallupinformationonVesselTypesandRouteGroups.Likewise,theplusicontotheleftofPort
StructureswillcallupEntry/Exit,TurningBasins,Anchorage,Docks,Reaches,andtheDock/Turning
basinMatrix.TheplusicontotheleftofPortTrafficwillcallupUniqueVessels,VesselCalls,Dock
Visits,andCommodityTransfers.ThistreestructureisshowninFigure7.
Figure 7: Navigation Pane Expanded
TwoadditionalbranchesarevisibleontheNavigationPanetreestructure:“PortTransitRules”and
“Scenarios”.SelectingPortTransitRuleswillnavigatetoallrulesthatareappliedtoallreachesinthe
system.TheplusicontotheleftofScenarioswillrevealtheestablishedscenariosforprocessing
simulations.
3.4.3 Data Entry Pane TheDataEntryPanecontainsthe
dataentrygridsthatareusedto
inputdataintoHarborSymand
viewthisdata.Thedataentry
gridsareusedprimarilytoenter
thedataassociatedwiththe
selectedtreenodecategory.
Theseformshavetabsatthetop
ofthepanetocallupadditional
associateddataentrygridsas
Figure 8: Data Grid
showninFigure8.
3.5 Model Outputs TherearethreeprimaryformsofHarborSymmodeloutput:(a)informationstoredbackintothe
databasesassociatedwithascenario,(b)detailedoutputfilesforthescenario,and(c)detailed
26 Section 3  HarborSym Overview outputsgeneratedintheScenarioOutputDatabase(.SODA).Theinformationstoredbackintothe
databasesisusedtodisplayindividualandcomparativeresultsforscenariosthroughoutputreports.
Theoutputfilesareusedforverificationofinput,anddetailedexplorationanddebuggingofmodel
behavior.ModeloutputsarediscussedingreaterdetailinSection9andAppendixC.TheLoading
Moduleshavesimilaroutputs,asdescribedinAppendixE.
27 Section 3  HarborSym Overview Thispageintentionallyleftblank.
28 Section 4 Loading Modules Overview HarborSymdoesananalysisofavesselcalldatabase(VCDB),developingdetailedcostdataforthe
situationpresentedinthedata.Typically,theexistingconditionVCDBwillbebasedonhistorical
vesselcalldata,butprojectionsmustbedevelopedforfutureandwith‐projectsituations.Separate
HarborSymsimulationsaremadeforthewithout‐andwith‐projectconditions,forexistingconditions
andprojectedfuturesforthedesiredplanninghorizon.
AcomplicationinusingHarborSymforplanningstudiesisthusthegenerationofvesselcallliststhat
representfleetarrivalsandloadingsunderfuturewithout‐andwith‐projectconditions.Thatis,a
with‐projectvesselcalllistmustrepresentthefuturefleetandcommoditydemandsforimportand
exportattheportandtheassociatedcommoditytransfersandvesselloadingsmustbereflectiveof
thepossibilitiesofferedbythechannelimprovements.
Anumberoftools,referredtoastheHarborSymLoadingModules,wereaddedtoHarborSymtoassist
theuserindevelopingdatarequiredforawideningand/ordeepeningproject.Specifically,these
modulesassisttheuserindevelopingasyntheticVCDBthatsatisfiesagivencommodityforecastfor
non‐containerizedandcontainerizedshipsrespectingthedepthconstraintsofthedocksandthe
availablefleet.
Giventhedistinctnatureofnon‐containerizedandcontainerizedships,separatetoolsweredeveloped
toaddresstheirspecificvesselloadingbehavior.TheBulkLoadingTool(BLT)modulegeneratesa
syntheticfutureVCDBbasedonuserprovidedinformationonthefleetandcommoditydemandsfor
allnon‐containershipvessels,suchasbreak‐bulk,bulkcarriers,barges,cruiseships,andtanker
vessels.TheContainerLoadingTool(CLT)moduleproducesacontainership‐onlysyntheticVCDB
basedonuserinputsdescribingcommodityforecastsatdocksandtheavailablefleet.Giventhenature
oftheHarborSymdatabasestructure,theBLTandCLT‐generatedVCDBsmustbecombinedintoa
singleVCDBforcaseswherebothtypesoftrafficaretobemodeledinHarborSym.TheCombiner
modulewasdevelopedtoaddressthisneed.
TheloadingModulesarelaunchedfromtheHarborSymToolsmenu.Thefollowingsectionsprovide
anoverviewoftheLoadingModules,includingthearchitecture,basicconcepts,inputrequirements,
processingbehavior,anduserinterface.DetailsonhowtousetheLoadingModulestogeneratea
syntheticVCDBforuseinaHarborSymsimulationareprovidedinSection7.
4.1 Bulk Loading Tool HarborSymincludestheBLTmodulethatcanbeusedtogeneratesyntheticvesselcalllistsforgeneral
bulkcarriers.DuetothenatureofthedatarequiredbytheBLTandtheBLTsuseofdataalready
enteredforaHarborSymstudy,completinghistoricalinformationonvesselcallsintoHarborSymis
theappropriatestartingpointforananalysis.Syntheticallygeneratedvesselcalllistsfacilitate
forecastchangesincommoditytransfersandfleetvariationsovertheprojectlife.Thegeneral
featuresandcapabilitiesoftheBLTinclude:

PopulationofallvesselcalldatafieldsnecessarytorunHarborSym;
29 Section 4  Loading Modules Overview 
Usersuppliedannualcommodityforecastsatthedocklevel;

Usersuppliedforecastsofannualfleetavailabilityatthevesselclasslevel,intermsofthenumber
ofvesselcallsinayearmadebytheclass;

Developmentofsyntheticallygeneratedvesselswithexplicitphysicalcharacteristicsbasedon
statisticalmodels;

Loadingtheavailablefleetinordertosatisfydocklevelimportandexportforecasts;

Focusonbulk,generalcargo,andothervesseltypesthatoperateona“thereandbackagain”
serviceroute,duetotheuniquebehavioranddatarequirementsnecessaryforforecastingand
loadingcontainerships.
TheBLTisdesignedtoprocesstwouniquestepstogenerateashipmentlistforuseinaHarborSym
analyses.First,asyntheticfleetofvesselsisgeneratedthatcanservicetheport.Thisfleetincludesthe
maximumpossiblevesselcallsbasedontheuserprovidedavailabilityinformation.Second,the
commodityforecastdemandisallocatedtoindividualvesselsfromthegeneratedfleet,creatinga
vesselcalland“usingup”anavailablecallfromthesyntheticfleet.Additionaldetailsoneachofthese
stepsareprovidedinsubsequentsubsections.
4.1.1 Architecture AsingleHarborSymstudyiscomposedofseveraldistinctMicrosoft®Accessdatabases,asoutlinedin
Table1.TheBLThasbeendesignedtoreducetheamountofdatainputrequiredbytheuser.Rather
thanreassertthebasicparametersofthestudy,suchasdocks,vesseltypes,commodities,androute
groups,theusercandirecttheBLTtotheHarborSymIDBthatalreadycontainsthisinformation.
Additionally,theBLTcanbedirectedtoahistoricalVCDBthatcontainspertinentvesselclass
informationthatisusedtocreatethesyntheticvesselsforthefuturecalllist.Thisfeatureofthe
modulenotonlysavestheusertimebyeliminatingtheneedforduplicatedataentry,butitalso
ensurestheaccuracyofthedataanditsconsistencywithaHarborSymIDB.Figure9providesthe
schematicoverviewofthedatabaserelationshipswithintheBLTarchitecture.
TheusermustlinktheBLTmoduletotheappropriateinput(IDB),vesselcall(VCDB),andforecast
(FCDB)databases.TheIDB,orinputdatabase,describestheprojectlayout,includingthedocks,vessel
types,vesselclasses,andcommoditycategories.Notethatanychangesinvesselcharacteristics,
commoditiesexchanged,orvesselroutegroupsfromthehistoricalconditionmustbeimplemented
withintheIDBthroughtheHarborSymUI.Forexample,anewclassortypeofvesselcallingtheport
mustbeaddedtotheprojectthroughHarborSym,includingdataregardingvesseldockingand
undockingtimes,vesselturningtimes,vesselRouteGroupassignments,changesindesignparameters,
etc.Thesamepremiseistrueforchangesindocks(includingnewdocksormoredepthatexisting
docks),commoditiestransferredattheport,andRouteGroupschangesanticipatedforthefuture.All
datafieldsintheIDBmustbecomplete.
TheVCDB,orvesselcalldatabase,documentstheuniquevesselsthatcalltheport,andallthecallsand
commoditytransfersmadebythesevessels.Initially,apopulatedVCDB,possiblyhousingtheexisting
conditioncalllist,shouldbeattachedtotheBLT.Anexistingcondition(orotherpopulatedvesselcall
database)isusedtopopulatebasicinformationfortheBLTforecast,suchasthelogicalconstraints
andvesselclassstatistics.
30 Section 4  Loading Modules Overview Figure 9: Bulk Loading Tool Architecture
ThefinaldatabasethatmustbeattachedistheFCDB,orforecastdatabase.Thisdatabaseisuniqueto
theBLTandstoresinformationaboutcommodityforecastsatdocks,constraintsonvesselclass
capabilitytocarrycommoditiesandserveindividualdocks,andthevesselfleet.Inaddition,the
statisticalinformationnecessarytogeneratesyntheticvesselsisstoredinthisdatabase.
4.1.2 Input Requirements Usersmustprovidedatatospecifytheframeworkforgeneratingthesyntheticvesselcalllist.In
addition,theusermustspecifyallvesselcharacteristiccategorieswithintheHarborSymUIbecause
theseareusedasdatachecks,seeSection6.3.WithintheBLT,theinputrequirementsinclude:

Commodityforecasts(annualimport/export)ateachdock;

Descriptionoftheavailablefleetbyvesselclass,including:
- Statisticaldatadescribingthecumulativedistributionfunctionfordeadweighttonsofvessels
withintheclass,
- Regressioninformationforderivinglengthoverall(LOA),beamanddesigndraftfrom
capacity,
- RegressioninformationforcalculatingTPIbasedonbeam,designdraft,capacityandLOA;
31 Section 4  Loading Modules Overview - Thenumberofpotentialcallsthatcanbemadeannuallybyeachvesselclass;
Logicalconstraintsdescribing:

- Commoditiesthatcanbecarriedbyeachvesselclass,
- Vesselclassesthatcanbeservicedateachdock,
- Parameters,definedatthevesselclass/commoditylevelfordeterminationofhowindividual
callsandcommoditytransfersaregenerated,suchascommodityloadingfactors,allocation
priorities,andcommodityflowdirection(importorexportcalls).
TheabovelisteduserprovidedinformationdescribingforecastconditionsisenteredthroughtheBLT
UIandisstoredinanAccessdatabasereferredtoasaforecastdatabase,withan.FCDBextension.
Generalproject‐wideinformation,suchasvesselclassdefinitionsanddockdescriptions,isstoredin
separatedatabases.Underatypicalworkflow,theproject‐wideinformationwillbepopulatedinthe
HarborSymNavigationPane(seeSection6),andtheuserwilldirecttheBLTtothesepopulated
databasespriortogeneratingasyntheticcalllist.
Proceduresexist,usingtheExtremeOptimizationpackageandsomeAccessroutines,topopulate
muchoftherequiredforecastinformationbasedonanexaminationofanexistingvesselcalllist
createdfromhistoricaldata.Statisticalmeasures,commoditytransferamounts,andlogical
constraintscanallbederivedfromanexaminationofasetofhistoricalcallsthathavebeenstoredina
HarborSymdatabase.Thispopulatorfunctionfacilitatesdataentrybyprovidingabasisforthe
forecasts,whichtheusercaneditasnecessary.Section7.1describesthestepstocreateasynthetic
calllistusingtheBLT.
4.1.3 Model Behavior Withtheuserprovidedinputrequirementsidentifiedintheprevioussection,theBLTcreatesand
loadsasyntheticfleetaccordingtothefollowingsteps.
1. Generationofafleetofspecificvesselsbaseduponaknownnumberofvesselcallsbyclassanda
statisticaldescriptionofthecharacteristicsofthevesselclass.Thisprocessbeginsby
generatingonespecificvesselforeachcallintheclass.Thecapacityofthevesselissetbya
randomdrawfromthecumulativedensityfunctionthatisstoredfortheclass.Basedonthe
regressioncoefficientsthatarestoredfortheclass,eachofwhichisoftheform:
log(parameter)=a+b*log(Capacity)
LOA,BeamandDesignDraftaredeterminedforthevesselusingalinearregressionoftheform:
TPI=a+b*Beam+c*DesignDraft+d*Capacity+e*LOA
TheTPIiscalculatedbasedonthepreviouslygeneratedphysicalcharacteristicsandcoefficients
stored,attheclasslevel,forthisregressionmodel.Thisprocessisrepeateduntilauniquevessel
iscreatedforeachavailablecallintheforecast.IfnoTPIisgenerated,thedefaultTPIfromthe
linkedIDBforthevesselclassisassigned.
32 Section 4  Loading Modules Overview 2. Attempttoassignaportionofthecommodityforecastatadocktoavessel.Eachcommodity
forecastatadockisprocessedinturn.Ifavesselisavailablethatcanservethecommodityat
thedock,itisloadedforeitherexportonly,importonlyorbothexportandimport.Potential
vesselsthatcancarrytheforecastareassignedinauser‐specified(attheclasslevel)allocation
order,sothatthemosteconomicalvesselclasseswillalwaysbeusedfirst.Underthecurrent
assumptions,avesselcallhandlesasinglecommodityatasingledock,i.e.,eachcallconsistsofa
singledockvisitandasinglecommoditytransfer(whichmaycontainbothanexportquantity
andanimportquantity).Thespecificationoftheactualcallassignmentandcommodityloading
isdependentuponthemaximumthatavesselcandraftandstillreachandleavethedock.
Theamountofthecommodityforecastthatisactuallycarriedonthevesselisusedtodecrement
theremainingquantitytobeallocatedforthatparticularcommodityforecast.Afterasingle
vesselcallisassignedtoaparticularforecast,thetotalnumberofremainingavailablevessels
fortheclassisdecrementedandthenextcommodityforecastinturnisprocessed.Thatis,each
forecastattemptstohaveaportionofitsdemandsatisfiedbyasinglevesselcallandthenthe
nextforecastisprocessed.Thisistopreventallofthemostefficientvesselsfrombeingassigned
toasinglecommodityforecast.
Thisprocessproceeds,inaloop,continuallyattemptingtoassigncommoditytoavesselfrom
theremainingavailablefleet.Wheneverasuccessfulassignmentismade,thisgeneratesavessel
call,dockvisitandtheassociatedcommoditytransfer.Thiseffortcontinuesuntilnomore
assignmentstoavesselcallcanbemade,eitherbecauseallcommodityforecastshavebeen
satisfiedorthereisnoavailablevesselthatcanservicetheremainingquantities(becausethere
isnovesseloftherequiredclassthatcanhandletheparticularcommodity/dockcombinationof
theforecastorbecausenovesselcanbeloadedtosatisfythedockcontrollingdepthconstraint).
3. Attheendoftheprocess,whennomoreassignmentsarepossible,arrivaltimesareassignedfor
eachvessel.Thealgorithmusedtoassignarrivaltimesassumesauniforminter‐arrivaltimefor
allcallswithinaclass.Aftertheallocationprocessiscomplete,thenumberofcallsmadebyeach
classofvesselisknown.Thisisusedtocalculatetheinter‐arrivaltimeofvesselsforthatclass.
Thearrivalofthefirstvesselintheclassissetrandomlyatatimebetweenthestartoftheyear
andthecalculatedinter‐arrivaltime,butallsubsequentvesselarrivalsfortheclasswillhavethe
identicalinter‐arrivaltime.
4. ThegeneratedvesselcallsarewrittentoaHarborSymvesselcalldatabaseandtheuseris
presentedwithoutputinformationonwhichcommodityforecastsweresatisfied,anyremaining
unsatisfiedforecastsanddetailedinformationoneachvesselloadingandthevesselsthatwere
usedtosatisfyeachcommodityforecast.
TheintendedapproachisfortheusertoworkiterativelywithintheBLT,makingruns,examiningthe
forecastsatisfactionthatisachievedandvaryingthefleetcharacterandcompositionforsubsequent
runs,sothatthefinalresultisabalanced,reasonableprojectionofvesselcallstosatisfytheinput
forecastdemand.TheBLTprovidesextensiveoutputtoassisttheuserinthisregard.
Onceavesselisdeterminedtobeavailableforloadingforaparticularforecast,theBLTmust
determinethetypeofloading,thequantityloadedandthearrivaldraftofthevessel.Theusercan
controlcertainaspectsoftheprocessthroughdataspecification,inparticularthetypeofcall(import,
exportorboth)andthepercentofcapacitythatisloadedforimportandexport,asdescribedbelow.
33 Section 4  Loading Modules Overview Anygivenvesselcallcanattempttosatisfyanimportdemand(arrivewithcargofortheport,leave
empty),anexportdemand(arriveempty,leavewithcargoloadedattheport)orsimultaneouslyan
importandexportdemand(thatis,arrivingwithcargotounloadattheport[import],andthen
departingwithcargoboundforanotherport[export]),basedontheuserdefineddirectional
movementassignedtothevesselclass.Fourpossibilitiesaredefinedforthisbehavior,with
specificationattheVesselClass/CommodityCategorylevel:

ExportOnly

ImportOnly

Random

BothExportandImport
Certaincombinationsofclassandcommoditycategoriesmightbeexclusivelyimportonlyorexport
only.A“Random”assignmentdesignatesthatcallsfromtheclass/commoditycombinationcanbe
eitherimportorexportatadock,butnotbothsimultaneously.Ifa“Random”typeisassigned,thenthe
ratioofcallsthatwillberandomlygeneratedasimportisspecified.
Thequantityofavessel’scapacitythatistobeloadedforsatisfactionoftheimportandexport
demandsisdescribed,againattheVesselClass/CommodityCategorylevel,byatriangular
distributionthatspecifiesaloadingfactor.Aminimum,mostlikely,andmaximum,inpercentoftotal
availablecapacity,isdefinedforbothexportandimport.
Whenavesselisavailableforsatisfyingademand,firstthetypeofsatisfaction(importonly,export
only,randomorboth)isdetermined,asnotedabove.If“random”isassociatedwiththecurrent
class/commodity,thenarandomdrawismadefromauniformdistributionandcomparedwiththe
user‐specifiedimportratio,todetermineifthecallisimportonlyorexportonly.Forexample,ifthe
userhasenteredavalueof70percentforimports,indicatingthat30percentofthecallsareexports,
thenarandomdrawismadefromauniform(0,1)distribution.Iftherandomnumberislessthanor
equalto0.7,thenthecallisassignedasanimport,otherwiseitisassignedasexport.
Oncethetypeofcallisdetermined,theBLTmustnextascertainhowmuchcapacitycanbeloadedon
thevesselwhilesatisfyingthedraftconstraints.Theprocessissimilarforbothexportandimport.
First,adrawismadefromtherespectivetriangulardistributiontogetapercentageloadingfactor.
ThisisthenappliedtothevesselDWT,adjustedtoreducetheavailabletonnagebasedonallowance
foroperations,togetatentativequantitytobeloaded.Theimport/exportcapacitytobeloadedis
adjustedonlyiftheavailableloadingcapacityislessthantheinitialcalculation(seeAppendixE.2.3for
specificationsontentativeloading).
ThetonnageassociatedwithallowanceforoperationsisbasedonIWR‐developeddatagiven
fractionalallowanceforoperationsasafunctionofvesseltonnage(DWT),seeFigure10.The
additionaldraftimpliedbythetentativequantitytobeloadediscalculatedbasedonthevesselTPI.A
valueofemptyvesseldraftforeachvesselhaspreviouslybeencalculated,basedonanassumption
thatthevesselDWTisassociatedwiththevesseldesigndraft.Theemptyvesseldraftfromwhich
loadingcanstartisthencalculatedas:
EmptyVesselDraft=DesignDraft–(DWT/TPI)/12.0
34 Section 4  Loading Modules Overview Figure 10: Allowance for Operations by Vessel DWT
Thetotaldraftassociatedwiththetentativeloadingisthencalculatedasthesumoffourdrafts:
TotalDraft(tentativeloading)=EmptyVesselDraft+AdditionalDraftAssociatedwithTentative
Loading+AdditionalDraftassociatedwithAllowanceforOperations+UnderkeelClearance
Inordertotesttheabilityofthevesseltoarriveatorleavethedock,tothistotaldraftassociatedwith
tentativeloadingmustbeaddedtherequiredunderkeelclearance(afunctionofthevesselclass).This
givesthe“testdraft”thatischeckedagainstthelimitingdepthtothedock.Notethatthisisnotthe
sameastheeventuallycalculatedarrivaldraftofthevesselatthebar,whichiswrittentothevessel
calldatabase.Ifthistestdraftisgreaterthanthelimitingdepthtothedock(asdefinedbyuserinput),
thequantityloadedmustbereduced,sothatthecalculateddraftislessthanthelimitingdepthtothe
dock.Thiscalculationisexecutedtodetermineifthetentativeloadingcanbereducedsufficientlyto
meetthedocklimitingdepth.Ifso,thenthevesselisloadedwiththeamountofcommoditytoreach
thetargetdraft.Ifitisnotpossibletoassignacommodityquantitythat,whenloadedonthevessel,
doesnotexceedthedocklimitingdepth,thenthevesselcannotservicetheallocation.
Oncethecommodityallocationhasbeencompleted,thevesselloadingisknownandthearrivaldraft
(atthebar)mustbedetermined.Aclasslevel“minimumsailingdraft”hasbeenspecifiedbytheuser
atthevesselclasslevel.Thisminimumsailingdraft,oremptyvesseldraft,reflectstheballasteddraft
atwhichalightvesselwillsail.Ifavesselishandlinganexportonly,thenitisassumedtoarrivelight,
attheemptyvesselsailingdraft.Ifavesselishandlinganimporttotheport,thenitarrivesatthedraft
associatedwiththeimportloading(whichmayhavebeenreducedtothelimitingdepthatthedock).It
isimportanttonotethatunderkeelclearanceisnotincludedinthearrivaldraftthatisstoredinthe
35 Section 4  Loading Modules Overview vesselcalldatabasebecauseitdoesnotfactorintotheactualsailingdraft,but,asnotedaboveitis
usedincheckingtheconstraintassociatedwiththelimitingdepthtothedock.Inpractice,underkeel
clearanceisusedintheBLTtohandlethedepthconstraint,butisnotincorporatedintheactual
sailingdraft.Underkeelclearanceisthenaddedbackinasanadditionalconstraintthatisappliedin
HarborSymitselfbasedonsailingrules.Inthismanner,thearrivaldraftisconsistentlycalculated
basedonthesumofemptyvesseldraft,draftassociatedwithloading,anddraftassociatedwith
allowanceforoperations.
TheBLTmodulewritesalltheneededfieldstothevesselcalldatabase.OfnoteishowtheETTCfield
ishandled.WithintheBLT,ETTCispopulatedbysimplyaddingtogetherimporttonsandexporttons.
AsdiscussedinSection3.3.1,theETTCfieldisusedbytheHarborSymkerneltoallocateat‐seacosts
tothesubjectport.BecausetheBLTispopulatingthefieldassuch,theassumptionisthatallat‐sea
costsforavesselcallgeneratedbytheBLTareallocatedtothesubjectport.Iftheuserhas
informationthatpartialloadingandunloadingisoccurring,theETTCfieldshouldbemanually
adjustedaccordingly.
Also,notethatallowancefortideisnotexplicitlyincorporatedintheBLT.Userscanfactorintide
heightavailabilitybyadjustingthedocklimitingdepthaccordingly.
4.1.4 BLT User Interface TheBLTUIiscomposedoffourmenuoptionsandthreedistinctpanes,theNavigationPane,Data
Pane,andtheOptionsPane,asshowninFigure11.Under‘File’,selectingthe‘Close’optionwillexit
theBLTapplication.Selectingthe‘Options’menuwillprovidealistofseveraldatabasesneededfor
theBLTtoproperlyfunction.ThesefilesareincludedwiththeHarborSyminstallation.Thesefiles
locationsareautomaticallyspecifiedduringtheHarborSyminstallationprocess.Specificationofthese
fileswillnotberequiredbytheaverageuser.The‘Diagnostics’menuallowstheusertoOptimize
Figure 11: Bulk Loading Tool User Interface
36 Section 4  Loading Modules Overview MasterMDBs,whichwilllaunchaproceduretoimprovethespeedoftheBLTdatabaseprocesses.
Finally,theHelpmenuprovidesan‘About’optionthat,whenselected,willdisplaytheversionnumber
oftheBLT.
TheNavigationPaneprovidestheuserwithatreestructurethathas5numbereditems,Number3and
Number5havesub‐itemsavailable.TheitemsfoundintheNavigationPanearenumberedaccording
totheordertheusershouldfollowtocreateasyntheticvesselcalllistforgeneralizedbulktraffic.
AccordingtowhichitemisselectedintheNavigationPane,differentoptionswillbeavailableinthe
OptionsPane,anddifferentdatawilldisplayintheDataPane.DetailsonhowtousetheNavigation
PanetoreviewandeditdataareprovidedinSection7.1.3.
4.2 Container Loading Tool TheCLTmoduleproducesacontainership‐onlysyntheticfuturevesselcalllistbasedonuserinputs
describingcommodityforecastsatdocksandtheavailablefleet.Themoduleisdesignedtoprocessin
twouniquestepstogenerateashipmentlistforuseinHarborSymorinstandaloneanalyses.First,a
syntheticfleetofvesselsisgeneratedthatcanservicetheport.Thisfleetincludesthemaximum
possiblevesselcallsbasedontheuserprovidedavailabilityinformation.Second,thecommodity
forecastdemandisallocatedtoindividualvesselsfromthegeneratedfleet,creatingavesselcalland
fulfillinganavailablecallfromthesyntheticfleet.
Inordertosuccessfullyutilizethistoolonaplanningstudy,userswillneedextensivedatadescribing
containershiploadingpatternsandservicesfrequentingthestudyport.Theusermustprovidea
vesselfleetforecastbyvesselclass,season,andservice,andacommodityforecastbydock,season,
andregion.Asolidunderstandingofanticipatedshippingpatterns,loadingbehaviors,andforecast
demandswillbenecessarytogeneratefuturecalllistsusingtheCLT.Section7.2providesdetailson
howtousetheCLTtogenerateafuturesyntheticcalllist.
4.2.1 Architecture AsingleHarborSymstudyiscomposedofseveraldistinctMicrosoft®Accessdatabases.Before
generatingsyntheticcalllists,usersmustfirstattachtheCLTmoduletotheappropriatemaster,input,
vesselcall,forecast,andgeographydatabases.Table1describesthedifferentinformationcontainedin
eachdatabase.Figure12providesaschematicoverviewoftheCLTdatabasearchitecture.
TheMasterdatabaselinkstogetherallrelevantinformationneededforCLTgenerations.This
databaselocationshouldbespecifiedfirstpriortospecifyingtheadditionaldatabases.Itcanbefound
intheHarborSymprogramsfileslocation,mosttypicallyatC:\ProgramFiles\HarborSym.Thefileis
named‘CLTGeneratorMaster.mdb’.IftheuserresetsthelinktotheMasterdatabase,linkstothe
remainingdatabaseswillbebrokenandwillneedtobereestablished.
TheIDB,orinputdatabase,describesprojectlayout,includingthedocks,vesseltypes,vesselclasses,
commoditycategories,androutegroups.ItisimportanttoattachtheCLTmoduletothecorrectinput
databaseasthisdatabasedefinesthevesselandcommodityclassificationsthatprovidethebasisfora
syntheticallygeneratedcalllist.Typically,theIDBspecifiedherewillbetheHarborSymIDB
correspondingtothefutureprojectforwhichtheCLTisbeingusedtogenerateasyntheticVCDB.
TheVCDB,orvesselcalldatabase,documentstheuniquevesselsthatcalltheport,andallthecallsand
commoditytransfersmadebythesevessels.TheCLTvesselcalldatabasegenerationprocessvaries
37 Section 4  Loading Modules Overview Figure 12: CLT Architecture fromtheBLTprocessinthattheuserwilldirecttheCLTtocreateaVCDBfromtemplateratherthan
startingwithanexistingconditionVCDB.
ThenextdatabasethatmustbespecifiedistheCFCDB,orcontainershipforecastdatabase.This
databasestoresinformationaboutcommodityforecastsatdocks,thecontainerfleetspecification,
parametersettings,seasons,dockparametersandvesselclassspecifications,services,regions,route
groups,arrivaldraftfunctions,andvesselsubclasses.Initially,ablankCFCDBshouldbeattachedto
theCLT.
4.2.2 Input Requirements Developingacontainershipvesselcallforecastrequiresextensivedatacollection,processing,and
input.ThefollowingdescribesthedatarequirementsoftheCLTindetail.
Seasons Seasonsaredefinedbytheuserandmustcovertheentireyear.Eachseasonisspecifiedbyastart
monthanddayandanendmonthandday.Theusercandefineasmanyseasonsasnecessaryand
apparentattheportofstudy.
Regions RegionsaredefinedintheGeographydatabaseandarenoteditablebytheuser.Itis,however,
importantthattheuserknowstheregionsavailablesothatacommodityforecastbyregioncanbe
38 Section 4  Loading Modules Overview developed.ThedefinedregionswithdetailedinformationcanbefoundthroughtheView
Tables/Geography/Regionmenuoption.
Commodities CommoditycategoryinformationisstoredintheHarborSymIDBlinkedtotheCLT.Itisvisiblefrom
withintheCLTUIinthestandarddatagridformatbuttheuserispreventedfromeditingthisdatato
avoidcreatingconflictswithusageinHarborSymsimulations.
Commodity Forecast at Dock Forecastsaredefinedatthecommodity,dock,season,andregionlevelasimportandexportquantities
inmetrictons.ThisinformationisstoredintheCFCDB,andisuser‐editable.Aforecastnameisalso
provided(e.g.“FC1”)foruseinreferencingoutputtoaparticularforecast.
Service InthecontextoftheCLT,aserviceisaregularvesseltransitacrossasetofregions.Servicesarenot
necessarilydefinedattheportlevelbutratherrepresentalarger‐pictureforthevessel.Withinthe
geographichierarchydefinedintheGeographydatabase,aportlieswithinacountryandacountry
fallswithinaregion.Servicesareuser‐definedwithintheCLTandstoredintheCFCDB.Theuser
definestheServicenameanddescription.TheIWRdevelopedA‐DAPPtoolprovidesdetailed
informationonserviceforagivenportandvesselcall.ThroughuseoftheA‐DAPPandtheIWR
createdW‐DAPP,theuserhasthetoolsanddatanecessarytopopulateServicedatafortheCLT.See
theA‐DAPPandW‐DAPPUser’sGuidesfordetailsonhowtoprocesstheserviceinformation.
AdditionaldatarelatingtoServicesmustbepopulatedintheCLT:

CorrespondencebetweenServicesandRegions(region‐service);

AssociationofRouteGroups(definedinHarborSymandviewablethroughtheCLTIDBlink)to
Services(routegroup‐service)includingthepercentageofRouteGroupstraversingagiven
Service;

DetailedinformationoncontainershipcharacteristicssailingonaparticularService(service‐
vesselclass)suchasarrivaldraftCDFs,averageladingweightperloadedTEU,averagecontainer
weightperTEU,emptyTEUallotment,vacantslotallotment,allowanceforoperations,variable
ballast,minimumandmaximumarrivaldraft(ifarrivaldraftCDFisnotavailable),andimport
andexportfractiontriangulardistributions.
Fleet Specification Afleetspecificationisdefinedasamaximumnumberofportvisitswithinagivenseasonofavesselof
agivenclass,operatingonaparticularservice.Aspecificationessentiallysays:“Inthefirst6months
oftheyear,thereare30availablecallsofSubpanamaxvesselsoperatingontheEastCoastUS–South
AmericaPendulumservice”.Anallocationpriorityisassignedtoindividualfleetspecifications,and
theCLTobservesthesepriorities,attemptingtofillaforecastbyusingvesselsfromthefleetwiththe
highestallocationprioritybeforeusingvesselsofalowerpriority.Notethatthehighestallocation
priorityis1,thelargerthenumber,thelowerthepriority.
Route Groups TheRouteGroupisasspecifiedthroughtheHarborSymUIandisstoredintheIDB.Itisastatistical
abstractionofaportionofaservice,centeredonthesubjectport,withinformationondistributionof
39 Section 4  Loading Modules Overview distancestopriorandnextportsandatseadistance,allowingforatotalvoyagelengthdetermination,
andfixedvaluesforpriorandnextportlimitingdepths,usedintheallocationprocess.Inasmuchasa
serviceisalarger‐area,regiontoregionmovement,anddoesnottakeintoaccountmovement
betweenportswithinaregion,thehierarchyisservice–routegroup,suchthattotaltrafficona
servicecanbeassigned,basedonuserpercentages,toindividualroutegroupswithinthatservice.
RouteGroupsaredefinedintheHarborSymuser’sinterface.FordetailsseeSection3.2.8,VesselRoute
Groups.
Constraint Tables Anumberofdatatablesprovidelogicalconstraintinformation,definingwhatvesselclassescanusea
specificdock,theassociationofregionstoservices,etc.Theconstraintsarebaseduponconcepts
employedintheBLTframework.Theseareuser‐editabletables,locatedintheCFCDB.

Dock‐VesselClass
- Thistableidentifiesthevesselclassesthatcanuseaparticulardock,andthusareavailableto
satisfyforecastsatthatdock.

Region–Service
- Theregion‐servicetableidentifiestheregionsthatarevisitedbyaparticularservice.The
orderisnotimportant.ThistableallowstheCLTtoidentifyalloftheservicesthatcanbe
usedtosatisfyaparticularforecasttoagivenregion.TheServicestablemustbecompleted
priortopopulatingthistable.

CLTParameters
- Thistableisdesignedtostore,inatag‐valueformat,informationforthesimulation.Thetag‐
valueformatiseasilyextendedasnewport‐widevaluesareincorporatedintheCLT
algorithms.Thisissimilartothe“configurationssettings”tableinthemainHarborSym
module,whichismodifiedwithadditionaluser‐definedsimulationparametersasneeded.
Atpresent,theonlyvalueinthistableisforaport‐widesealevelchangevalue.

DockParameters
- Thedockparameterstablecurrentlystoresadditionaltidalavailabilityatthedock,infeet.
Thisinformationisused,withotherinformation,todeterminefeasibleloadingdepthofa
vesselforthegivendock.Notethatthereisnodurationassociatedwiththisvalue,itis
assumedthattheadditionaltidalvaluecanbeusedbythevesselinreachingthedock.The
IWR‐createdTideToolcanbeusedtodeterminetheadditionaltidalavailabilityatagiven
dock.

RouteGroup–ServiceAssignment
- Thegeographyhierarchyhasroutegroupsasasubsetofservices.Thatis,aservice,whichis
definedattheregiontoregionlevel,canhavemanyroutegroups,whicharedefinedatthe
abstractporttoabstractportlevel.Theroutegroup–serviceassignmenttableassociates
routegroupswithservices,anddefinesanumericalvalueindicatinghowmanycalls
assignedtotheserviceshouldbeassignedtothespecificroutegroup.Notethatthe
percentageassignmentofRouteGroupsshouldaddupto100foreachService.TheA‐DAPP
40 Section 4  Loading Modules Overview providesdetailsontheserviceandroutegroupforagivencall.Thisinformationcanbe
usedinconjunctionwiththeW‐DAPPtodeterminethestatisticsnecessarytopopulatethis
table.

Service‐VesselClass
- Threebasictypesofinformationarestoredwithinthetable:1)informationforusein
determinationofarrivaldraft;2)informationforuseintheloadinganalysis;and3)
informationforuseindeterminingthefractionofthevesselloadonarrivalthatis
imported/exportedtothesubjectport.Allofthisinformationisstoredinasingletable
withintheCFCDB,butisshowninthreepartsforclarity.Theusercanprovideeither:
o
Aminimum/maximumarrivaldraftforavesselclassonagivenservice,inwhichcase
thegenerationprocessselectsrandomlybetweenthetwovaluestoassignarrival
drafttoavessel;alsonecessarytobrackettheCDFfunctions,or
o
Acumulativedistributionfunction(CDF)ofarrivaldrafts,inwhichcasethe
generationprocessusestheCDFtorandomlyassignthearrivaldraft.
o
IfnoCDFvaluesareknownthena“NULL”[mustbeexact]CDFfunctionmustbe
specifiedandthentheCLTgeneratorwillautomaticallyusethemin/maxarrival
drafts.Note,however,thatifCDFvaluesareprovided,thenthemin/maxarrivaldraft
fieldsmustbespecified.TheCLTvesselgenerationprocesswillcheckthatthe
randomlydrawnCDFvalueiswithinthemin/max.
- CDFinformationisavailablefromtheA‐DAPP,andisstoredineditablefunctiontables.Note
thatCDFfunctionswillneedtobeexpandedbytheuserinthewith‐projectconditionto
accountforvesselsarrivingattheportofstudydraftingdeeperasthewith‐projectchannel
depthallows.
Thefollowinginformationisusedinconjunctionwiththearrivaldraftdeterminedusingthe
informationabovetodeterminetheallowabletonnagethatcanbecarriedonarrival:vessel‐specific
informationondesigndraftandTEUrating,limitingdepths,andtidalavailability.
Itisassumedthattheimport/exportquantitiestothesubjectportarebasedonhistoricalfractionsof
vesselloading.Thisinformationischaracterizedastriangulardistributionsforeachofimportand
export,withP1beingtheminimum,P2themostlikelyandP3themaximumpercentageoftotal
loadingthatisimported/exported.
Vessel SubClasses WithintheCLTprocess,avesselcalliscreatedbasedonavesselclass.Specificvesselcharacteristics
aredeterminedbychoosingavesselfromthevesselsubclasstable.Thesubclasstableprovides
standardvesseldataforsetsofvesselswithinagivenvesselclass.Thisinformationhasbeendefined
byIWRforcontainerships,with45distinctsubclassesforfourvesselclasses(SubPanamax,Panamax,
PostPanamaxGen1,andPostPanamaxGen2),andshouldnotbechangedbytheuser.The
proportionalassignmentofvesselsubclassestoaclassisauser‐enteredparameter,definedina
similarfashiontothepercentageassignmentofroutegroupstoservices.Theonlythingthatshould
bechangedbytheuseristhepercentageofsubclassassignmenttothevesselclass.Thetotal
percentagewithinaclassshouldsumto100.Anysubclassesnotservicingtheportcanberemoved
(deleted)fromthedatagrid.
41 Section 4  Loading Modules Overview 4.2.3 Model Behavior TheCLTgeneratesavesselcalllistbyfirstgeneratingasyntheticvesselfleetbasedonuserinputs.
EachvesselinthefleetisrandomlyassignedphysicalcharacteristicsbaseddatawithintheVessel‐
Subclasstable.
Tentativearrivaldraftisdeterminedforeachgeneratedvesselbasedonthevaluescontainedinthe
ServiceVesselClasstable.Thistablecontainsaminimumarrivaldraft,amaximumarrivaldraft,and
optionally,thenameofastoredCDFofarrivaldrafts.IfastoredCDFisavailable,thenarandomdraw
ismadefromthatCDF.Therandomlydrawnvalueistestedagainstthelimitsofminimumand
maximumarrivaldraft,andiftheCDFvalueisoutsideofthatrange,itissettotheappropriatelimit
(minimumormaximumarrivaldraft).
IfnoCDFisavailable(FunctionDescription=“NULL”),thenarandomdrawismadefromauniform
distributionbetweentheminimumandmaximumarrivaldraft.
Thearrivaldraftisinitiallysettothetentativearrivaldraft,asdeterminedabove.
TheMaximumAllowableArrivalDraftisdeterminedastheminimumof:
1) priorportlimitingdepth
2) designdraft
3) limitingdepthatthedock+underkeelclearance+sinkageadjustment+tidalavailability+sea
levelchange
Thearrivaldraftascalculatedabove(i.e.tentativearrivaldraft)isthencomparedtotheMaximum
AllowableArrivalDraft,andsettothelesservalue,thatis,eitherthestatisticallyestimatedvalueor
theconstrainedvalue.
Next,theCLTconductsaLoadingFactorAnalysis(LFA)giventhephysicalcharacteristicsofeach
generatedvessel.LFAexplorestherelationshipsbetweenashipsphysicalattributes,considerations
foroperationsandattributesofthetraderoutecargotoevaluatetheoperatingefficienciesofvessel
classesatalternativesailingdrafts.Severalintermediatecalculationsarerequired.Thefollowing
variablesareusedbytheloadfactoranalysismodelbutarecalculatedfromtheinputs.
42 
Vesseloperatingcostper1000milesiscalculatedas1000milesdividedbytheappliedspeed
timesthehourlyatseascost.
=1000miles/(AppliedSpeedXHourlyCost)

Theallocationofvesselspacetovacantslots,emptyandloadedcontainersiscalculatedby
addingthecargoweightperboxplustheboxweightplusanallowancefortheempty.

Totalweightperloadedcontainer=
AverageLadingWeightperLoadedTEUbyRoute(MetricTonnes)
+AverageContainer(Boxonly)WeightperTEU(MetricTonnes)
+(AverageContainer(Boxonly)WeightperTEU(MetricTonnes)*(PercentEmptyTEUs))

Sharesofvesselcapacityarethencalculatedas:
Section 4  Loading Modules Overview 

o
CargoShare=AverageLadingWeightperLoadedTEUbyRoute(MetricTonnes)
TotalweightperloadedcontainerinMetricTonnes
o
LadenContainerShare=AverageContainer(Boxonly)WeightperTEU(Metric
Tonnes)
TotalweightperloadedcontainerinMetricTonnes
o
EmptyContainerShare=((AverageContainer(Boxonly)WeightperTEU(Metric
Tonnes))*(PercentEmptyTEUs))
TotalweightperloadedcontainerinMetricTonnes)
Volumecapacitylimitsarecalculatedasfollows:
o
Numberofvacantslots=NominalTEURating*PercentVacantSlots
o
MaxOccupiedSlots=NominalTEURating‐Numberofvacantsslots
o
MaxLadenTEUs=OccupiedSlots/(1+PercentEmpties)
o
MaxEmptyTEUs=OccupiedSlots‐LadenTEUs
MaximumVolumeRestrictedTonnageisthencalculatedas:
o
Maxweightforcargo(tonnes)=MaxLadenTEUs*AverageLadingWeightperLoaded
TEUbyRoute(MetricTonnes)
o
Maxweightforladenboxes(tonnes)=MaxLadenTEUs*AverageContainer(Box
only)WeightperTEU(MetricTonnes)
o
Maxweightforempties(tonnes)=MaxEmptyTEUs*AverageContainer(Boxonly)
WeightperTEU(MetricTonnes)
o
Totalvolumerestrictedtonnage(cubedouttonnage)(tonnes)=Maxweightforcargo
+Maxweightforladenboxes+Maxweightforempties
Theloadfactoranalysisproceedsasfollows:

Theinitialdraftisvariedfromthevesselsmaximum(loaded)tominimum(empty).Ateach
sailingdraftthetotaltonnagethatcanbecarriediscalculatedusingtheTPIratingforthe
vessel.
o

DeadweightTonnageAvailableforVesselDraft=DeadweightTonnageRating(Metric
Tonnes)–[(AggregateMaximumSummerLoadLineDraft–SailingDraft)*12
inches*TPI]
Thiscapacityisthenallocated,firsttoballastandoperationstoyieldcapacityavailablefor
cargo.
o
ApproximateVariableBallast=DeadweightTonnageAvailableforVesselDraft*
PercentAssumptionforVariableBallast
43 Section 4  Loading Modules Overview 
o
AllowanceforOperationsinMetricTonnes=DeadweightTonnageRating(Metric
Tonnes)*PercentAllowanceforOperations
o
AvailableforCargo=(DeadweightTonnageAvailableforVesselDraft)
‐(ApproximateVariableBallast)‐(AllowanceforOperations)
Thecapacityavailableforcargoisrestrictedifthevesselhas“cubed”or“volumed”out:
o



AvailableforCargoadjustedforvolumerestrictionifany(tonnes)=thelesserof
AvailableforCargoandTotalvolumerestrictedtonnage(cubedouttonnage)
Thetonnageavailableforcargoisthenallocatedtocargo,ladenandemptycontainersbased
onthesharesofvesselcapacity.
o
DistributionofSpaceAvailableforCargo(tonnes)=AvailableforCargoadjustedfor
volumerestrictionifanyinMetricTonnes*CargoShareinpercent
o
DistributionofSpaceAvailableforLadenTEUs(tones)=AvailableforCargoadjusted
forvolumerestrictionifanyinMetricTonnes*LadenContainerShareinpercent
o
DistributionofSpaceAvailableforEmptyTEUs(tonnes)=AvailableforCargo
adjustedforvolumerestrictionifany*EmptyContainerShare
ThenumberofTEUsisthenestimatedforeachshareuse:
o
NumberofLadenTEUs=DistributionofSpaceAvailableforCargo/AverageLading
WeightperLoadedTEUbyRoute(MetricTonnes)
o
NumberEmptyTEUs=DistributionofSpaceAvailableforEmptyTEUs/Average
Container(Boxonly)WeightperTEU(MetricTonnes)
o
OccupiedTEUSlotsonVessel=NumberofLadenTEUs+NumberEmptyTEUs
o
VacantSlots=NominalTEURating‐OccupiedTEUSlots
IntheCLTtheETTC(estimateoftotaltripcargo)iscalculatedforeachvesselcallasthecargo
onboardthevesselatarrivalplusthecargoonboardthevesselatdeparture,intons.See
Section3.3.1foradditionalinformationonETTC.
TheCLTworkstoloadeachvesselavailabletocarrythecommodityonthegivenrouteuntilthe
forecastissatisfiedortheavailablefleetisexhausted.
4.2.4 CLT User Interface TheCLTUIisessentiallymenudriven,asshowninFigure13.TheTitleBarprovidesthenameofthe
module,versionnumber,andreleasedate.TheMenuBarhasfiveoptions,asdiscussedbelow.The
QuickAccessBarprovidestheuserwithoptionstoquicklysetthescenarioform,generateaVCDB,
andviewresults.Theseoptionscanalsobeaccessedthroughthemenu.StandardWindowOptionsare
providedontheupperrighthandofthemodulethatallowstheusertominimize,maximize,andclose
theCLT.Finally,theCLThasaWorkingFilespanethatprovidesthelinktothefilesthatareattached
totheCLT.Theusercanalsospecifynewfilesusingthispanebyselectingthedescriptivebuttonsto
theleftofeachfilelink.
44 Section 4  Loading Modules Overview Figure 13: CLT User Interface Overview
TheCLThasfivemenuoptionsavailabletotheuser:File,ViewTables,Generate,Tools,andOptions.
TheCLTmenuprovidestheuseraccesstothedatastoragetablesandprocessingtoolsneededto
successfullycreateaVCDBforuseinHarborSym.Thefollowingprovidesageneraloverviewofthe
menuoptionsavailabletotheuser:

File:allowstheusertospecifythedatabasesattachedtotheCLT(forreferencedatabasesare
describedinTable1onpage6),tosaveorloadconfigurationsettings,andtoexittheCLT.See
Section2.3forthelocationofthereferencedatabases.FileMenuoptionsinclude:
- GeneratorMDB:whenselected,willallowtheusertospecifythelocationoftheCLTGenerator
Masterdatabase.Thisdatabaseisnamed‘CLTGeneratorMaster.mdb’.
- GeographyMDB:whenselected,willallowtheusertospecifythelocationoftheGeography
databaserequiredbytheCLT.Thisdatabaseisname‘Geography.mdb’.
- IDB:allowstheusertospecifytheIDBdatabaseforwhichthecurrentCLTstudyisbased.
- VCDB:allowstheusertospecifytheVCDBthatwillbepopulatedforaCLTstudy.Optionsare
toChoose(anexistingVCDB),CreateFromTemplate(willcreateablankVCDB),orCopy
Existing.EachuniqueHarborSymconditionwillrequireanewblankVCDB.UnliketheBLT,
theCLTdoesnotworkfromanexistingVCDBcreatedusingHarborSym.
- CFCDB:allowstheusertospecifytheCFCDBthatwillbepopulatedforaCLTstudy.Options
aretoChoose(anexistingCFCDB),CreateFromTemplate(willcreateablankCFCDB),or
CopyExisting.StartinganewprojectwilltypicallyrequiretheusertocreateaCFCDBfrom
Template,whilestudiesalreadyinprogressmayutilizeexistingCFCDBsthatwerecreated
withtheCLT.Thisoptionwilllikelyreducetheamountofdatainputrequiredbytheuseras
thedatastructureforawith‐andwithout‐projectwillbesimilar.
- LoadConfig:willloadthelastsavedfileconfiguration.
- SaveConfig:willsavethecurrentfileconfiguration.
- Exit:willexittheCLT.Theuserwillbeaskediftheconfigurationsettingsshouldbesaved.
Select‘Yes’tosaveor‘Cancel’toexitwithoutsaving.
45 Section 4  Loading Modules Overview 
ViewTables:allowstheusertoviewand/oreditthetablesintheIDB,VCDB,CFCDB,and
Geographydatabases.Selectingatablewithinanyofthedatabaseswillopenagridviewofthe
data.Fieldsthatcanbeeditedarecoloredblueandfieldsthatarereadonlyarecoloredwhite.
Eachtableinthedatabasesisdescribedindetailthesectionsthatfollow.

Generate:providestheuserwithmenuoptionstocheckdata,setscenarioparameters,generatea
VCDB,andviewstandardizedresulttables.

Tools:includesoptionstoexpandthreeCFCDBtablesbasedoninformationspecifiedin
associatedtables.
- ExpandServiceVesselClassTable:oncedatahavebeenspecifiedintheSeason,Service,and
ContainerFleetSpecificationtablesfoundintheCFCDB,thisoptionwillcreateadatamatrix
intheServiceVesselClasstableintheCFCDB.
- ExpandDockParametersTable:thisoptionwillexpandtheDockParameterstableinthe
CFCDBaccordingtotheDocksspecifiedintheIDB.
- ExpandFunctionTable:oncetheappropriatenumberoffunctionshavebeenspecifiedinthe
ArrivalDraftFunctiontableintheCFCDB,thisoptionwillexpandtheArrivalDraftFunction
DetailtableintheCFCDBbyadding20rowsforX,Ydataforeachfunctionspecified.

Options:allowstheusertospecifytheCLTtemplatedirectoryandtospecifyoptions.
- SetTemplateDirectory:actionthatmustbeperformedbyuserwhenCLTisfirstinstalledorif
reinstalledontheuser’scomputer.SeeSection2.3forthelocationoftheTemplate
Directory.
- SetOptions:allowstheusertospecifytheoutputdecimalprecisionfortheoutputfiles
availableafterVCDBgeneration.Anoptionisalsoavailabletospecifywhetherthegraphis
viewableduringVCDBgenerationandifresultsaredisplayedoncethegenerationprocess
iscomplete.Finally,theusercanspecifyfortheCLTgeneratortowriteadebugfilethat
providesdetailsonthearrivaldraft.
4.3 Combiner Tool TheCombineVCDBmoduleallowsfortheintegrationoftheBLTvesselcalllistandtheCLTvesselcall
listintoonecombinedVCDBthatcanbeusedtosimulatefuturetrafficinHarborSym.TheCombiner
toolisquitesimpletouse.TheuserdirectstheCombinertotheVCDBsthatarewishedtobecombined
andtoanIDBforwhichthedataassumptionswillbechecked.Theusermaywishtoimplementthe
DataCheckoption,toensurethattheVCDBscorrespondtotheIDB.Section7.3providesdetailson
howtousetheCombinerTooltogenerateasingleVCDBusingthecombinedoutputoftheBLTand
CLTmodules.
4.3.1 Select Files TheVCDBCombinemoduletakesasinputfouritems.TheuserwillneedtoattachanIDBagainst
whichthedocks,vesselclasses,andcommoditycategoriesarechecked,twoVCDB’s,onecreatedusing
theBLTandonefromtheCLT,andthedesiredcombinedVCDB.Theuseridentifiesthefourfilesby
clickingoneachofthedatabases.Thesefilescanbesavedunderthefilemenu(SaveConfig).Load
Configtakesplaceautomaticallyonprogramstart‐up.
46 Section 4  Loading Modules Overview 4.3.2 Data Check Thischeckinsurescompatibilityoftheid’sforvesselclass,commoditycategory,anddocksineach
VCDBwiththeselectedIDB.Forproperbehavior,bothVCDB’sthataretobecombinedneedto
referenceacommonsetofcategories,classes,anddocks,soareferenceIDBisprovidedtoaccomplish
thistest.
SincetheVCDBcarriesonlyid’s,notthedefinitionoftheid,allthischeckdoesisinsurethatthereis
noidnumberintheVCDBthatisnotalsointheIDB.Itdoesnotinsurethatthemeaningoftheidis
thesame.Forexample,iftheVCDBreferencesvesselclassid’s1,4,5,andtheIDBhas1,2,3,4,5,6,then
alliswell.If,however,theVCDBreferences1,4,5,7,amessagewillbegenerated.NOTE:thedata
checkisoptional,andisnottestedbeforecombining–thecombinewillstillfunctionevenifthedata
checkisfailed.
ThetestalsoreportsthenumberofuniquevesselsineachVCDBandthedatarange.Thesumofthe
uniquevesselsshouldbelessthanthecurrentHarborSymlimitof10,000,butthe10,000valueisnot
checkedorenforced.Ifincompatibilityisfound,thenamessagedialogappearsfortheuser.
47 Section 4  Loading Modules Overview This page intentionally left blank.
48 Section 5 Basic HarborSym Commands and Functions Aharborisastructureofconnectedreaches,docksandfacilitiesthatmustbeestablishedcorrectlyto
simulatetraffic.Enteringthisinformationcanbetimeconsumingandhasbeenalargeconsideration
intheapplicationdevelopment,leadingtotheimplementationofmanytimesavingtechniques.
HarborSymusesatraditionalmenuaswellastoolbarsforimmediateaccesstofunctions.Whenthe
userright‐clicksonthemapareaofthegraphicspane,acontext‐derivedmenuisdisplayedforthe
correspondingobject.Messagepromptsarealsoappliedforcontextmenus.
ThefollowingchapterdescribesthebasicmenucommandsandfunctionsavailableinHarborSym.
Themenucommandsarepresentedintheorderthattheyappearonthemenutoolbarofthemain
applicationwindowwithexplanationsofwhathappenswhentheparticularoptionisselected.
AdditionaldetailonthevariousHarborSymfeaturesandtheapproachtodatapopulationisdiscussed
inSection6.
5.1 File ThefollowingitemsarefoundontheFilemenupillar,asshowninFigure14:“StudyManager,
“ConfigurationSettings”,and“Print.”
Figure 14: HarborSym File Menu
5.1.1 Study Manager Whenthe“StudyManager”itemisselected,adialogboxisprompted.Thisdialogboxallowstheuser
toacreatenewprojectoropenexistingprojects.Throughthisviewtheusercanspecifythefile
locationforallprojectswithinastudy.Theuserwillbenefitbykeepingallthefilesforastudyinthe
samedirectory.
StudyManagerallowstheuserto“clone”aprojectandtherebyavoidduplicatedataentry.The
“cloned”projectcanthenbemodifiedtoreflecttheharborimprovementalternativebeingevaluated.
ThedetailsofthisdialogboxarediscussedinSection6.1,StudiesandProjects,whichalsoincludesan
explanationofthestudy/projecthierarchy.
49 Section 5  Basic HarborSym Commands and Functions 5.1.2 Configuration Settings ThisfunctionbringsuptheConfigurationSettingsformwherevalidationandsimulationsettingscan
beinputandedited.Thevalidationsettings,showninFigure15,arerangesofvalues,assetbythe
user,thatareavailablefortheusertodefine.HarborSymhasadatavalidationtoolthatenablesthe
usertoverifythatcurrentHarborSymdatavaluesfallwithintheseacceptablelimits.Inputvalues
outsideofthedefinedrangegeneratewarninganderrormessagesduringthedatavalidationroutine.
Additionalinformationonthedatavalidationtoolandrangesforvalidationsettingsisavailablein
Section6.11.
Figure 15: Configuration Settings ‐ Validation
ThesecondtabontheConfigurationSettingswindow,showninFigure16,displaysuser‐definedfields
relevanttothesimulationprocessing.Thesefieldsrelatetovesseloperatingcostthresholdsor
priorityvesselsimulationduration(asdescribedinSection3.2.5),andothervariablefields.The
vessellegwaitlimitcount,forexample,willimpactthedeletionofvesselcallsifvesselsbecome
“stuck,”andcannotmovebecauseofvesseltrafficrules.Completedescriptionsofthesesettingscanbe
promptedbyhoveringthecursoroverthedescriptionblock.Section8.1,Table7:SimulationSettings
Fields,providesadescriptionandexplanationofallthesimulationsettingsavailableinthistab.
50 Section 5  Basic HarborSym Commands and Functions Figure 16: Configuration Settings ‐ Simulation
5.1.3 Print ThisfunctionprintsHarborSymDataEntryGrids.PageSetupandPrintPreviewoptionsareavailable.
ThePrintcommandprintstheDataEntryGridshownintheDataEntryPane.
5.1.4 Additional Studies Alistofexistingstudiesisshownwithinthefilemenupillar.Theusercanchangetoanotherstudy
quickly,andavoidusingStudyManager,byclickingonthestudyname.
5.2 View Twomenuitemsarelistedunderthismenupillar:“StudyExplorer”and“DisplayOptions”,asshown
inFigure17.TheseitemscontroltheprimaryHarborSymscreen,whichcontainsthethreepanes.
Figure 17: View Menu
5.2.1 Study Explorer ThisfunctionreturnsthethreeHarborSympanes(GraphicsPane,NavigationPaneandDataEntry
Pane)toview.ThiscommandistypicallyusedafteraccessingtheStudyManagerfunction.
51 Section 5  Basic HarborSym Commands and Functions 5.2.2 Display Options ThisfunctioncallstheDisplayOptionsScreen,asshowninFigure18,whichallowstheusertoadjust
thecolorsandrepresentationsusedtodepictnodesandreachesintheGraphicsPane.Eachnodetype
representationcanbemodifiedbyclickingonthenodetypeontheleftsideoftheGraphicPane
OptionsScreen,whereallnodetypesarelisted.Selectionofeachnodetypeallowstheusertoselect
theicontorepresentthatnodetypeintheGraphicsPane.Thisscreenisusedtodeterminewhether
nodedescriptionsandnodenumbersareshownintheGraphicsPane,andhowtheyarerepresented.
Theusershouldconsiderthecomplexityoftheharbortoberepresentedwhenselectingandsizing
icons.
Figure 18: Graphics Pane Options
5.3 Import FivemenuitemsareavailableundertheImportmenupillar,as
showninFigure19:“CommodityTransferRate“VesselDocking
Time”,“VesselTurningTimes”,“VesselSpeedinReach”,and
“PortTraffic.”Theseselectionsallowtheusertousetemplates
inMicrosoftExcelandimportlargeamountsofdata.This
featureismostbeneficialforprojectswithalargenetworkor
greatvarietyofvesselclassifications.Creatingthetablesin
ExcelandimportingintoHarborSymmayprovideadditional
efficienciesoverdirectdataentryusingtheuserinterface.
Figure 19: Import Menu 52 Section 5  Basic HarborSym Commands and Functions Eachitemhastwooptions;CreateLookupSpreadsheet,andImport,asshowninFigure20.The“Create
LookupSpreadsheet”mustbeusedfirst.Theuserwillthendefineanameforthespreadsheetand
assignthefiletoadirectory.AdditionalinformationaboutHarborSymtemplatesisavailablein
AppendixA.
Figure 20: Import Sub‐Menu
5.3.1 Commodity Transfer Rate TheCommodityTransferRateistherateatwhichacommodity,orcargo,isloadedorunloadedfroma
vessel.Aminimumrate,mostlikelyrate,andmaximumrateforloadingandunloadingmustbe
assignedtoeachcommoditycategoryforeachvesselclassification.Therateismeasuredinunitsper
hour.
5.3.2 Vessel Docking Time TheVesselDockingTimeistheamountoftimeavesselspendsdockingorundocking.Minimumand
maximumvesseldockingtimes,inhours,mustbeassignedtoeachvesselclassificationateachdock.
5.3.3 Vessel Turning Time TheVesselTurningTimeisthespeed,inhours,foreachvesseltypetoturninaturningbasin.A
minimum,mostlikely,andmaximumturningtimemustbeassignedtoeachvesseltypeforeach
turningbasin.
5.3.4 Vessel Speed in Reach TheVesselSpeedinReachisthespeed,inknotsperhour,thatavesselcantravelinareach.Alight
andloadedspeedmustbedefinedforeachvesselclassificationforeachreach.Vesseloperatingcosts
aredevelopedbasedonvesselspeeds,thusthetwoaredirectlyassociated.Theusershouldtakecare
toassurevesseloperatingcostsandvesselsailingspeedsarebaseduponconsistentdataand
assumptions.
5.3.5 Port Traffic ThePortTraffictemplateimportsthevesselcalllist.Thistemplateincludesanextensiveamountof
dataonthevesselsvisitingtheharborandthecommoditiestheytransferred.Porttrafficisdiscussed
ingreaterdetailinSection6.6andAppendixA.
53 Section 5  Basic HarborSym Commands and Functions 5.4 Output TheOutputpillarprovidesaccesstosimulationoutputinstandardgraphs
andreports.ThethreemenuoptionsavailableundertheOutputmenu
pillar,asshowninFigure21,are:“Graphs,”“Reports”and“Export.”
Detailedoutputfilesgeneratedduringtheanalysiscontainmoredataabout
simulationsbutarenotaccessedthroughthisfilepillar.Outputfilesare
storedinthesamefiledirectoryastheHarborSymstudyandcanbe
accessedthroughWindowsExplorer.Section8.3,ViewingSimulations;
Figure 21: Output Menu
Section9,UnderstandingHarborSymOutput;andAppendixCprovide
detailsonaccessingandinterpretingHarborSymoutputdata.
5.4.1 Graphs TheGraphBuilderScreen,showninFigure22,
allowstheusertospecifythescenarioand
projectstoincludeinthegraph.HarborSym
offerssixgraphicaloptionsthatcanbeviewed
foranyscenarioorproject.Notethatinorder
fortheVesselTimegraphtodisplaythecorrect
averagevesseltime,theusermustselectthe
‘Iteration’outputoptionunderOutput
Controls.
5.4.2 Reports Severalreportoptionsareavailable,“Project
Comparison”,“SingleScenario”,“ReachRule
Violations”,“TransitRules”,“VesselClass
Characteristics”,and“CommodityInfo”,as
showninFigure23.TheProjectComparison
Reportprovidesacomparisonofmultiple
scenariosunderasinglescenario.TheSingle
ScenarioReportprovidesdetaileddataonthe
simulationofonescenariowithasingle
project.TheTransitRuleReportliststhe
vesseltrafficrulesbyreach.TheVesselClass
Figure 22: Graph Builder
MovementThresholdsReportliststherange
foreachvesselclassineachproject.The
CommodityInfoReportliststheUnitsofMeasureandtonsper
unitofmeasureforeachcommoditycategory.
5.4.3 Export Theexportfunctionprovidestheuserwiththeoptiontoexport
thevesselcalllistdatawithinHarborSym.Thisfunctionis
usefulbecausevesseldatamaybemodifiedorcorrectedafter
theoriginalvesselcalllistisimportedintoHarborSym.Selecting
theExport/PortTrafficoptionwillopenadialogbox.Theuser
Figure 23: Report Sub‐Menu
selectstheprojectdesiredandspecifiesatemplatedirectoryto
54 Section 5  Basic HarborSym Commands and Functions savethefile.Theuserthenselects“Export”.Theuserispromptedthattheexportwascomplete.An
Excelspreadsheetisexportedtothedirectoryspecifiedbytheuser.Thespreadsheetwilllookexactto
theImportTemplateSpreadsheet,describedinSection5.3.5.TheselectionoftheExportPortTraffic
FunctionfromtheOutputmenuisshowninFigure24.
Figure 24: Port Traffic Sub‐Menu
5.5 Tools TheToolspillarprovidesaccesstotheBulkLoadingTool(BLT),theContainerLoadingTool(CLT),
andCombinerVCDB’smodulesofHarborSym,asshowninFigure25.ThroughtheBLTmodule,users
cangeneratesyntheticvesselcalllistsforgeneralbulkcarriersforuseinfutureorwith‐project
scenariosinHarborSym.TheBLTisintroducedinSection4.1.TheCLTmoduleassistsusersin
creatingasyntheticvesselcalllistforcontainerizedvesselforuseinfutureorwith‐projectscenarios
inHarborSym.TheCLTisintroducedinSection4.2.TheCombineVCDB’smodule,introducedin
Section4.3,isusedtocombinetheVCDBoutputsoftheBLTandCLTintoasinglevesselcalldatabase
tobeusedbyHarborSym.InstructionsonhowtousethetoolsareprovidedinSection7.
Figure 25: Tools Menu
5.6 Help TheHelpmenupillarisshowninFigure26.The“Help”menupillaroffersthe“About”command,
whichdisplaystheversionnumberoftheapplication.Thiscommandwillobtainthestandard“About”
dialogbox.The“Contents”optionwillopenaHTMLversionoftheuser’sguide.Theusercanbrowse
theguide’soutlineorindex,orsearchforkeywords.
Figure 26: Help Menu
55 Section 5  Basic HarborSym Commands and Functions 5.7 Project Specific Menu Options Aproject‐specificmenuisavailablebyright‐clickingontheprojectnameinthenavigationtree,as
showninFigure27.Thesixmenuoptionsaredescribedinthesubsectionsbelow.
Figure 27: Project Specific Menu Options
5.7.1 Create Lookup Spreadsheet Selectingthe“CreateLookupSpreadsheet”optionlaunchesthewindowtogenerateaMicrosoftExcel
spreadsheetforimportingthevesselcalllist.Thisoptionisalsoavailableunderthe“Import”,Port
Trafficmenuoption,asdiscussedinSection5.3.5.PorttrafficisdiscussedingreaterdetailinSection
6.6andAppendixA.
5.7.2 Import Port Traffic Selectingthe“ImportPortTraffic”optionlaunchesthewindowtoimporttheMicrosoftExcel
spreadsheetcontainingthevesselcalllist.Thisoptionisalsoavailableunderthe“Import”,PortTraffic
menuoption.
5.7.3 Output HSAM Information Selectingthe“OutputHSAMInformation”optionwillgeneratethefilesnecessarytorunthe
HarborSymAnimationModule(HSAM).Section10discussesHSAMandhowtoutilizetheoutputfiles.
5.7.4 Populate Tide Stations ThisoptionlaunchesthePopulateTideStationswindow,whichisthefirststeptoaddingtidal
influencetothesimulation.Theprocessforassigningtideandcurrentstationsandestablishingtidal
rulesisoutlinedinSection6.8.
5.7.5 Validate TheDataValidatorisapowerfultoolavailablewithinHarborSym.Selecting“ValidateData”fromthe
rightclickmenulaunchesthetool,whichisdesignedtoverifytheuserinputdataandconfirmthatall
mandatoryfieldsarepopulated.Section6.11discussesthedatavalidationtool.
56 Section 5  Basic HarborSym Commands and Functions 5.7.6 Assign Route Groups to Vessel Calls Selecting“AssignRouteGroupstoVesselCalls”fromtherightclickmenuwillautomaticallyallocatea
specificroutegrouptoeachvesselcall.Routegroups(seeSection3.2.8foradefinition)arerequired
forallvesselcalls.Asroutegroupassignmentsaremadeduringthevesselcalllistimport,usersdo
notneedtoimplementthisstepforimporteddata.However,iftheroutegroupdistributionshave
changedsinceimportorifvesselcallsaremanuallyenteredthroughthedataentrygrids,thisaction
mustbeexecutedbeforeHarborSymwillprocessasimulation.Theuserisgiventheoptiontoassign
allroutegroupsorassignonlyblanks.Iftheroutegroupforagivenvesselcallisknownand
designatedinthePortTrafficspreadsheet,thentheusercanselect‘No’toassignroutegroupstoblank
callsonly.Notethatroutegrouppercentagesforagivenvesselclassmustequal100oranerror
messagewilloccurandtheassignmentwillbeunsuccessful.
57 Section 5  Basic HarborSym Commands and Functions Thispageintentionallyleftblank.
58 Section 6 Developing a HarborSym Study ThissectiondefinesthetermsandconceptsnecessarytodevelopaHarborSymstudy.Thetermsand
conceptsaredefinedinasequencetoallowtheusertologicallyandefficientlydevelopaHarborSym
study.Step‐by‐stepinstructionstoappropriatelypopulatethemodelwithdataareprovidedinthe
HarborSymtrainingmaterials.Thischapterisdividedintosubsections,withthecontentofeach
groupedbyareawithintheNavigationPane.
6.1 Studies and Projects Itiskeytounderstandthedifferencebetweenastudyandproject,asthesetermsareusedthroughout
thisguide.Studiescanhaveseveralprojectsbutaprojectisassociatedwithonlyonestudy.
6.1.1 Studies AHarborSymstudyisthedesignationfortheoverallanalysisconductedwithinthemodel.Astudyis
limitedtoonecontiguousgeographicarea,mostcommonlyasingleharbor.Thestudyconcept
providesabroadframeworkfororganizingdataforvaryingconditionswithinthestudyarea.Eachof
thesedifferingconditionsistermedaprojectinHarborSym.Astudycontainsatleastoneprojectand
musthavetwoprojectstoconductacomparativeanalysis.
6.1.2 Projects AHarborSymprojectisadefinitionofaharborataspecifiedperiodintime,includingallthephysical
characteristicsofthedocks,turningbasins,anchoragesandreacheswithinthatharbor.Thevessel
transitrulesarepartofaproject.Projectsconsistofboththephysicallayoutofthestudyareaandthe
porttraffic;thus,aprojectmustconsidertheelementoftrafficdemandforagiventimeperiod.
Projectswithinastudycanhavethesamevesselcalllist.IfusingHarborSymintheframeworkof
USACEplanningstudies,thefirstprojectshouldrepresentthecurrentconditionsattheharbor(the
“existingcondition”).HarborSymshouldbecalibratedbycomparingtheoutputsofthisprojectwith
actualdataavailablefromtheharbor.Additionalprojectsarecreatedtorepresentpossibleharbor
improvementprojectsandvaryingtrafficdemandovertime.Acomparisonofsimulationoutputs
fromtheexistingconditionprojectwiththefutureprojectswillassisttheuserinunderstandingthe
potentialchangesintransportationcostsovertimeandunderdifferentchannelconfigurations.
6.1.3 Study Manager and Study Explorer TheHarborSymStudyManagerisafunctionusedtocreatestudiesandprojectsandtonavigate
betweenstudies.UnlesstheHarborSymuserisworkingonnavigationanalysesinmultiplelocations,
theStudyManagerfunctionwillbeusedmainlytocreatenewprojectswithinanexistingstudywith
whichtoanalyzealternativeharborimprovements.Thefiledirectoriesforstoringstudiesand
projectsareselectedinStudyManager.Tocreateanewstudy,selectStudyManagerfromtheFile
menu.TheStudyManagerform,asshowninFigure28:StudyManager,willopen.
Theformisdividedintotwoportions;fieldsinthetopportiondescribethestudylocation,whilethe
bottomportionallowstheusertocreateandmanageprojectswithinthestudy.Specificitemsinthe
studydescriptionportioninclude:
59 Section 6  Developing a HarborSym Study 
PortDesc:thisfieldshouldcontainashortdescriptionofthestudyport,possiblytheharbor
name.

LatitudeandLongitude:valuesenteredintothesefieldsshouldapproximatethegeneral
geographicpositionofthestudyarea,suchasthecenteroftheharborortheentrancechannel.
HarborSymusesthisinformationtodeterminethesunriseandsunsettimes,whichisnecessary
fortheappropriateapplicationofseveraltransitrules.ThelongitudevaluesforNorthAmerica
shouldbenegative.

UTCOffset:thisfieldshouldcontaintheCoordinatedUniversalTime(UTC)adjustmentforthe
studyarea.ForportsalongtheU.S.eastcoast,thecorrectvalueis(‐5);forU.S.westcoastports
thevalueis(‐8).Aswithlatitudeandlongitude,HarborSymusesthisinformationtodetermine
thesunriseandsunsettimes.

DSTFields:thesefieldsrequireinformationontheapplicationofdaylightsavingstime
adjustments.Thisinformationisalsousedtodeterminethesunriseandsunsettimeswithinthe
model.
ThebottomportionoftheStudyManagerwindowcontainsfieldsenablingtheusertocreate,modify,
clone,anddeleteprojects.
Figure 28: Study Manager 6.1.3.1 Create New Study ClicktheCreateNewStudybutton.Clickthebutton(
)besidethelocationfieldtoselectthe
locationwherefilesrelatedtothisstudywillbestored.Next,enterthenameofthestudyintothe
StudyNamefieldandaprojectname,suchasExistingConditions,intotheProjectNamefield.Click
60 Section 6  Developing a HarborSym Study Createtocreatethestudy.Section3.1andTable1:DatabasesUsedInAnalysiscontainadiscussionof
thedifferentdatabasesidentifiedintheStudyManager.TheStudyManagerformcannowbeclosed
byclickingontheClosebutton.
TheHarborSymmodelusesMicrosoftAccessfilesextensivelyandtheStudyManagercontainsan
OptimizefunctionthatperformstheCompactfunctionofMicrosoftAccess.PressingtheOptimize
buttonwillrunthisfunctionandmayresultinadecreasedfilesizeforthevariousMicrosoftAccess
databasessupportingthestudy.Doingsowillnotimpactthedatastoredwithinthedatabases.
6.1.3.2 Accessing a Study TheStudyExplorerisusedtoaccesstheHarborSymuserinterfaceaftersettingorchangingproject
parametersusingtheStudyManager.ToaccessthestudyselectedintheStudyManager,select“Study
Explorer”underthe“View”menuoption.
6.2 The Node Network Thenodenetworkrepresentstheharborandconsistsofnodesandreaches.Inmanystudies,most
aspectsofthenodenetworkwillremainunchangedinthewithout‐andwith‐projectconditions.
Unlessnewchannelsordocksarebeingconsidered,thenodenetworklayoutwillnotchange.All
docks,turningareas,harborentrancesandchannelsneedtobemappedinthenodenetworkatthe
onset.Itisrecommendedtoincludefuturefeaturesintheexistingconditionnetworktoensure
consistencyamongstableelementsofthenetwork.Forexample,ifaproposedimprovementincludes
addingananchorage,itisrecommendedtobuildthenetworkwithatopologicnodeintheproposed
anchoragelocationforallprojects,includingtheexistingcondition.Inwith‐projectconditions,the
nodetypecanbechangedto“Anchorage”toreflecttheproposedfacility.Suchanapproachhelps
ensuretheonlychangebetweenthetwoprojectsistheadditionalanchorage.Specificcharacteristics
ofnetworkfeatures,suchaschannelwidthordockdepth,canvaryamongtheprojectswithinastudy.
6.2.1 Port Structures PortStructuresareoneofthefivemainheadingsundereachprojectnameintheNavigationPane.
PortStructuresconsistofnodesandreaches.ThetypesofnodesarelistedintheNavigationPane
underPortStructures.Nodesrepresentpointsintheharbor.Nodesarespecifiedbytypetoinclude:
docks,turningareas,anchorages,entry/exitpointsandtopologicpoints.Reachesarealsolistedunder
PortStructuresintheNavigationPane.Reachesrepresentchannelsbetweennodesintheharbor.
Vesselstransittheharborreachesfromtheharborentrancetotheirdestinationdock.
6.2.2 Mapping Nodes and Reaches AgraphicalrepresentationoftheharbornetworkiscreatedinHarborSymbyusingacomputermouse
toinsertnodesintoablankGraphicsPane.Thistechniqueallowsfortheeasypositioningofnodesso
thattheyareavisualrepresentationoftheirrelativepositionstoeachother.Optimalmappingof
nodesandreachesrequiresproportionaldistancingofnodes.However,theHarborSymgraphicspane
isnotcurrentlygeo‐referencedsopreciserelativeplacementbetweennodesisnotpossibleor
necessary.Thedistancesbetweennodesusedinthesimulationareenteredindependentlyasreach
lengths,butthereachlengthsinputintothedataentrygridarenotreflectedintheGraphicsPane.
Tomapthediagram,usetheNodeandReachMappingToolsasshowninTable3.Toaddanewnode,
clickontheAddaNewNodebuttonwiththeleftmousebutton.ClickontheblankGraphicsPane
wherethisnodeistobelocated.Placeothernodesonthediagramsothatalldocks,entry/exitpoints,
61 Section 6  Developing a HarborSym Study turning/holdingareasandtopologicalpointsarerepresented.Oncethisiscompletetheusershould
connectthenodesusingreaches.SelecttheAddaNewReachtool,clickonanodeintheGraphics
Pane,andthenclickonanothernode.Thiswillconnectthetwonodeswithareach.Continueuntilall
reachesarerepresentedintheGraphicsPane.Afterthediagramiscomplete,selectatypeforeach
nodebyrightclickingoneachnodeandselectingtheappropriatetype.
Table 3: Node and Reach Mapping Tools Map Options
The following map options are available:
Normal Selection: Add a New Node: Add a New Reach: Move an Item: Negates the selection of other map options Places node symbols on the screen Places reach symbols on the screen Moves Node and Reach symbols on the screen Zoom in/Out 100%: Zoom Function 6.2.3 Adding Background Image AlthoughtheHarborSymGraphicsPaneisnotgeo‐referenced,abackgroundimagemaybehelpfulin
developingareach‐nodenetwork.Anyimagein.bmp,.jpg,or.gifformatcanbedisplayedbyright
clickingintheGraphicsPaneandselecting“AddBackgroundImage”.Recommendedimagesinclude
mapsorharborsystemschematics.Addingtheimagebeforebuildingthenetworkcanassistin
establishingreasonablyrelativedistancesbetweennodes.Theimagecanalsobeusefulinproviding
contextwhencommunicatingmodelconceptsandfindingstostakeholders.
6.2.4 Defining Nodes Nodetypes(topologic,dock,turningbasin,anchorage,
orentry/exit)aredefinedintheGraphicsPanebyright‐
clickingonthenodeandselectingthedesiredstructure.
Onceatypeisassignedtothenode,HarborSym
populatesdefaultvaluesinarowinthecorresponding
PortStructureDataEntryGrid.Thedefaultvalues
includeagenericdescriptionandID(#).
Tonameeachnode,clicktheplusiconbesidePort
StructuresintheNavigationPaneandselectTopologic
asshowninFigure29.SelecttheDescriptionfieldfor
eachnodeandprovideamoremeaningfulnameinthe
DataEntryGrid.
6.2.4.1 Topologic Points Allnodesareinitiallytopologicnodesbydefault,butcan
bechangedtorepresentfunctionalnodes(docks,
anchorages,etc.).Often,harborconfigurationsrequire
62 Figure 29: Node Descriptions Section 6  Developing a HarborSym Study nodesthatarenotfunctionalnodes.Thesenodesmightrepresentthebeginningofanewchannel
depthorwidth,ormaybeajunctionpointbetweenthemainchannelandabranchchannel.The
representationofsuchelementsshouldbemadewithatopographicnode.Thesenodesdonotrequire
dataentryformeasurements.Thedescriptionsenteredinthetopologictabwillappearinthe
GraphicsPaneforallnodetypes.Nodedescriptionsmustalsobeenteredinthespecificnodetype
dataentrygrids.Forexample,anodetypemaybechangedfromtopologictodock.Thisnodewillstill
appearintheTopologicdataentrygrid.ThedescriptionenteredintheTopologicgridwilldisplayin
thegraphicspane,evenafterthenodetypehasbeenchangedtodock.However,theusermustalso
enterthenodedescriptionintheDockdataentrygridinordertohavetheinformationdisplayedin
thedocktables.Thisalsoappliestoturningbasins,anchorages,andentry/exitpoints.
6.2.4.2 Node Numbering and Deletion AdeletenodeoptionisavailablebyrightclickingonthenodeintheGraphicsPane.Whenthisoption
isselected,HarborSymwilllaunchawindowtoconfirmthedeletion.Ifthedeletenodeisconfirmed,
alldataassociatedwiththenodewillberemovedfromthemodelandcannotberestored.
Ifnodesaredeletedfromthesystem,usersmustverifythatsequentialIDnumbersareassociated
withtheremainingnodesofagiventype.ThevaluesintheID(#)fieldofthespecificnodetypetable
andalsothetopologicnodetableareautomaticallypopulatedwhenthenodeiscreated.Ifanodeis
removedfromthenetwork,theautopopulatednumbersmustbemanuallyadjustedtoensure
sequentialordering.Forexample,ahypotheticalthreedocksystemcontainsnodesnamedDock1,
Dock2,andDock3.Inthissystem,thesedocknameshavecorrespondingID(#)valuesof1,2,and3,
respectively.IfDock2(withID(#)2)isdeleted,theremainingID(#)fieldsarenolongersequential.
TheID(#)fieldforDock3mustbeupdatedmanuallytoread2.
TherequirementforsequentialnumberingofIDfieldsappliesuniversallythroughoutthemodel.
FailuretomaintainsequentialIDvalueswillpreventHarborSymfromprocessingasimulation.The
DataValidator(Section6.11)canreviewthesequentialnumberingpriortoprocessingasimulationto
highlightpotentialerrorsinthesystemsetup.
6.2.5 Entering Turning Basin, Dock, and Anchorage Data Thespecificcharacteristicsrelatedtoeachnodecannowbedefined.Eachnodecanbeselectedinthe
graphicspane,whichwillguidethenavigationpaneanddataentrypanetothecorrectdataentry
form.
6.2.5.1 Docks Docksarenodeswherevesselsloadandunloadcommodities.Docksarecapableoftransferring
specificcommoditycategoriesasselectedbytheuser.Thedockdescriptionisthenamethatwill
appearintheNavigationPaneandshouldmatchthecorrespondingnodedescriptionintheTopologic
table.Inatypicallargeharbor,theuserwillneedtoaggregatedockstoallowrepresentationinthe
nodenetwork.Forexample,aharborwith100docksmightberepresentedwith10docksinthenode
network.Thedeterminationtoaggregatedocksshouldconsidergeographicproximity,operating
practices(e.g.,commoditytransferrates),andthetypesofcommoditiesandvesselsserviced.
Thedockdataentrygridcontainsthreetabs:Dock;VesselDockingTime;andCommodityTransfer
Rate.WithintheDocktab,allfieldsaremandatory.TheDefaultTurningBasinfieldispopulatedfrom
allpulldownmenu,whichisemptyuntilturningbasinshavebeenaddedtothenetwork.
63 Section 6  Developing a HarborSym Study Vessel Docking Time Tab TherowsintheVesselDockingTimetabwillbepopulatedautomaticallywhenvesseltypesand
classesareenteredintothedatabase.Theusermustprovidedockingandundockingtimes,inhours,
forallvesselclassesthatwillvisitthedock.Nullvaluesareacceptableforvesselclassesthatdonot
visitthedock.ThedatagridisshowninFigure30.TheusercanimportthisdataintoHarborSym
throughatemplateifdesired,ratherthanmanuallycompletingthedatagrid.Thisisdonebyfirst
selectingImport/VesselDockingTime/CreateTemplatefromHarborSym’smainmenu.Oncethe
templatespreadsheetiscompleted,theuserimportsthedataintotheprojectbyselecting
Import/VesselDockingTime/ImportfromHarborSym’smainmenu.
Figure 30: Vessel Docking Time Tab Commodity Transfer Rate Tab Theamountoftimespenttransferringcommodities(cargo)isdependentuponthedock,thevessel
type,andthecommoditycategory.Aminimum,mostlikely,andmaximumloadingandunloadingtime
shouldbeentered.TherowsintheCommodityTransferRateTimetabwillpopulateautomatically
whenvesseltypes,classes,andcommoditycategoriesareenteredintothedatabase.Thedatagridis
showninFigure31:CommodityTransferRateTab.Loadingandunloadingratesaremandatoryforall
commoditytypesthatareexchangedatthedock.Tofiltertherows,clickonthecolumnheadinginthe
DataEntryPane.TheusercanimportthisdataintoHarborSymthroughatemplateifdesired,rather
thanmanuallycompletingthedatagrid.ThisisdonebyfirstselectingImport/CommodityTransfer
Rate/CreateTemplatefromHarborSym’smainmenu.Oncethetemplatespreadsheetiscompleted,the
userimportsthedataintotheprojectbyselectingImport/CommodityTransferRate/Importfrom
HarborSym’smainmenu.
Figure 31: Commodity Transfer Rate Tab
64 Section 6  Developing a HarborSym Study 6.2.5.2 Turning Basins ThetermsturningbasinandturningareaareusedinterchangeablyinHarborSym.Turningbasinsare
nodeswherevesselsturn.TheTurningBasindataentrygrid,showninFigure32,storestheturning
basindescription,thevesselcapacity,whethertheturningareablocksthechannel,andtheVSU
capacity.Thecapacityfieldreferstothemaximumnumberofvesselsthatcansimultaneouslyutilize
theturningbasin,whiletheVSUcapacityrelatestothetotalabstractedvesselsizeunitsthatcanbe
accommodated.Duringsimulations,HarborSymconsidersbothvalueswhendeterminingifaturning
basinisfreeforuse.Theuserselectswhethervesselsturnintheturningbasinbeforeorafterreaching
theirdestinationdock,orwhenthevesselisheaviestorlightestduringitsvesselcallintheDocksData
EntryGrid.
Figure 32: Turning Basin Data Entry Grid
Vessel Turning Basin Time Tab IntheVesselTurningBasinTimetab,showninFigure33,usersentertheminimum,maximum,and
mostlikelyturningtimeinhoursbyvesseltype.Thesefieldsaremandatory.Theusercanimportthis
dataintoHarborSymthroughatemplateifdesired,ratherthanmanuallycompletingthedatagrid.
ThisisdonebyfirstselectingImport/VesselTurningTimes/CreateTemplatefromHarborSym’smain
menu.Oncethetemplatespreadsheetiscompleted,theuserimportsthedataintotheprojectby
selectingImport/VesselTurningTimes/ImportfromHarborSym’smainmenu.
Figure 33: Vessel Turning Basin Time Tab
65 Section 6  Developing a HarborSym Study 6.2.5.3 Entry/Exit Points Entry/exitpointsarenodeswherevesselsenterorexittheharbor.Anameshouldbeenteredforat
leastoneEntry/Exitpoint.ToaccessdataforAnchorages,theusercaneitherselectthedesired
anchoragefromtheGraphicsPaneorselectAnchoragefromtheNavigationPane.
6.2.5.4 Anchorages Anchoragesarenodeswherevesselscanwaitbeforeenteringthenextreach.Anchoragesexistas
potentialstoppingpointswithinaleg,andarenotconsideredendpointsoflegs.Anchorageshave
capacitylimitsdefinedbybothmaximumvesselsandVSUs.Althoughthefield“BlocksChannel”is
availableinthedataentrygrid,thisfeatureisnotpresentlyimplementedforanchorages,onlyfor
turningareas.Foreachanchorage,theusermustprovideadescription,capacity,depth,VSUcapacity,
andindicatewhethertheanchorageblocksthechannel.ToaccessdataforAnchorages,theusercan
eitherselectthedesiredanchoragefromtheGraphicsPaneorselectAnchoragefromtheNavigation
Pane.
6.2.6 Defining Reaches Informationmustbeentereddefiningthephysicalcharacteristicsofeachreach.Tocompletethis
task,selectReachesintheNavigationPaneandtheDataPanewillprovidegridsforenteringdataas
showninFigure34.Theusercanhighlightparticularreachesandtheircorrespondingrowsinthe
DataEntryGridbyclickingtheplusiconbesideReachesintheNavigationPaneandthenselectinga
particularreach.ThereachwillthenbehighlightedintheGraphicsPaneandtherowof
correspondingdatawillbedisplayingtheDataEntryGrid.Likewise,theusercanselectareachinthe
GraphicsPaneandthecorrespondingrowintheDataEntryGridwillbehighlighted.
Thelength,width,depth,anddescriptioncanbeenteredforeachreachintheDataEntryGrid.Units
shouldbeexpressedinfeet.Inaddition,ifsafetyzoneswillbeactiveinanyofthereaches,theuser
shouldmakethedesignationbyselectingthecheckboxavailableforthereach.Iftherewillbeany
shipscarryingsafetyzonecommoditiesthatrequireasafetyzonethroughaparticularreach,theuser
shouldselectthecheckboxbesideReachSafetyZoneActiveforthatparticularreach.
Thedataentrygridforeachreachcontainstwoadditionaltabsforenteringdataonvesselspeedin
reachandtransitrules.
66 Section 6  Developing a HarborSym Study Figure 34: Reach Information Speed in Reach Tab TherowsintheSpeedinReachtab,showninFigure35,areautomaticallygeneratedwithallthe
populatedvesselclasses.Lightandloadedspeeds,inknotsperhour,aremandatoryfieldsforall
vesselclassesthatwilltraverseagivenreach.Vesseloperatingcostsaredevelopedbasedonvessel
speed.Thus,theusershouldtakecaretoassurevesseloperatingcostsandvesselsailingspeedsare
baseduponconsistentdataandassumptions.
Figure 35: Speed in Reach 67 Section 6  Developing a HarborSym Study Transit Rule Tab Individualreachtransitrulesareenteredon
theTransitRuletab.Theusershouldselect
thedesiredruletypefromthepredetermined
listinthe“Type”pull‐downmenu.Parameters
tocustomizetheruleareenteredintothe
appropriatefields;themandatoryfieldswill
behighlightedblueoncetheruletypehas
beenselected.
Selectingthe(
)buttoninthe“Desc”field
willlaunchapop‐upwindowdescribingthe
selectedreachandidentifyingwhichfields
Figure 36: Rule Description Window mustbepopulate,asshowninFigure36.For
example,iftheruletype“DraftPlusTide”is
selected,atestingvesselwillberestrictedfrommovingifits
draftexceedstheuserdefinedmaximumsailingdraftplusthe
minimumtideduringthesailinginterval.Theusermustenter
theapplicablemaximumsailingdraftinthedataentrygrid,
underParameter2.
Toentertransitrulesthatapplytotheentireport,theuser
shouldselectPortTransitRulesintheNavigationPaneas
showninFigure37.Aspecifictypeoftransitrule,the
applicationofsafetyzones,isdescribedinmoredetailin
Section6.10.
6.3 Vessels Vesselsaretheshipsthatvisittheharbor.Vesseltypesand
Figure 37: Port Transit Rules vesselclassesaredefinedbytheuserbeforethevesselcalllist
isenteredintoHarborSym.Vesselclassesaresubsetsof
vesseltype.Anextensiveamountofdatamustbeenteredtodescribethevesselclasscharacteristics,
suchasphysicalcharacteristics,sailingspeeds,typesofcommoditiescarried,sailingcosts,and
associatedroutegroups.
HarborSymprovidesflexibilityindefiningvesseltypesandvesselclasses,buttheusershould
considertheavailabilityofdatawhendefiningvesseltypesandvesselclassifications.Theusermust
alsoconsiderthecharacteristicsofthefuturefleetandcreatevesseltypesandclassesthatcapturethe
possibilityoflargevesselscallingtheport.ThisisespeciallyimportantiftheLoadingModuleswillbe
usedtogenerateasyntheticvesselcalllistforthefuture.Classificationsforcontainershipsshouldalso
beconsiderediftheCLTwillbeutilized.
6.3.1 Vessel Types VesseltypesmustbedefinedbytheuserforeachHarborSymstudy.Itisgenerallyrecommendedto
followmaritimeconventionwhenestablishingvesselclasses.Examplesofvesseltypesinclude
tankers,bulkers,generalcargoshipsandcontainerships.Tocreatevesseltypesandassign
parameterstoeachvesseltype,theusershouldclicktheplusiconbesideVesselInfointheNavigation
68 Section 6  Developing a HarborSym Study Pane.Next,selectVesselTypesintheNavigationPane.Theusercannowenterthevesseltypesand
selecttheappropriateclassificationoptionsintheDataEntryPaneasshowninFigure38.
Figure 38: Vessel Type Information
6.3.2 Vessel Classifications VesselclassesaresubgroupsofvesseltypesandarethebasisforHarborSymdataentry.Theaverage
speedtransitingtheharbor,thedockingandundockingtimes,therateatwhichcommoditiesare
loadedandunloadedaredependentuponvesselclassifications.Vesselclassesareestablishedby
groupinguniquevesselsfrequentingthestudyareaintocategoriesbasedononeormoredefining
measurements(LOA,BeamandCapacity).Whiletheclassesaredefinedbaseduponthephysical
characteristics,vesselswithinaclassmustalsocarrycommoditiesappropriatetotheclass,andhave
approximatelyequalsailingspeeds,drafts,andoperatingcosts.Thefollowingsubsectionsoutlinethe
fivevesselclasstabsavailablefordataentry.
ItshouldbenotedthatwhentheCLTwillbeutilizedforgeneratingasyntheticvesselcalllist,the
vesselclassesshouldbegenerallyalignedwiththeassumptionsinherentintheCLT(vesseltypeof
ContainershipandVesselClasses:SubPanamax,Panamax,PostPanamaxGen1,andPostPanamax
Gen2).SeeSection7.2.4.10foradditionaldetails.
Vessel Type and Classification Tab Thistabestablishestheparametersforbracketingvesselsbyclass.Theoptionsforclassdefinitions
areallbaseduponthevesselphysicaldimensions.Themeasurementsusedcandifferbetweenvessel
classes.Also,morethanonemeasurementcanbeusedtodefinevesselclassifications.Inanexample
study,forinstance,tankersmaybeassignedtoclassesbasedupontheirdesigndraft.However,inthe
69 Section 6  Developing a HarborSym Study samestudy,containershipsmaybeclassifiedbasedonthevesselbeamandlengthoverall.The
optionsforclassificationinclude:

LOA–lengthoverallofthevessel,expressedinfeet

Beam–widthofthevessel,expressedinfeet

Draft–thedesigndraftofthevessel(notthesailingdraft),expressedinfeet

Capacity–theamountofcommodities(cargo)avesselcancarry,measuredinNRT(net
registeredtons),GRT(grossregisteredtons)orDWT(deadweighttons).Note:iftheBLTwillbe
usedtodevelopfuturecalllists,DWTmustbeusedtodefinecapacity.
Whentheuserimportsporttrafficintothestudy,HarborSymidentifieseachuniquevesselinthe
datasetandassignsavesseltypebasedonthecriteriaspecifiedintheVesselTypeandClassification
tab,thevesseltypeattributes,andtheattributesofeachvessel.
Vessel Class Definition Tab Todefinevesselclasseswithinvesseltypes,clicktheplusiconbesideVesselTypesandselectavessel
typeasshowninFigure39.Alternatively,avesseltypecanbeselectedintheVesselTypeand
Classificationtabbyhighlightingthedesiredrow.TheusershouldselecttheVesselClassDefinition
Tabafterchoosingthedesiredvesseltype.
Figure 39: User Selection of Vessel Type Classification
TheVesselTypefieldisautomaticallypopulatedandcannotbechangedbytheuser,asshownin
Figure40.DefaultvaluesareprovidedforDescriptionandShortDescriptionbaseduponthevessel
typedescription.Thesefieldscanbemodifiedtoreflectmoreappropriatedescriptions.Forexample,
thevesseltype“Tanker”mayhavetwovesselclasses:“TankerLarge”and“TankerSmall”,withthese
70 Section 6  Developing a HarborSym Study namesenteredintothedescriptionsfields.Theshortdescriptionfieldappearsinselectoutputfiles
andmustbepopulated.Ifthevesselclassisgivenpriorityaccessintheharbor,selectthe“Priority
Vessel”checkbox.
Figure 40: Vessel Class Definition Tab Oftheremainingfields,onlythosewhichareusedinthevesseltypeclassificationmustbepopulated
forHarborSym.However,thevesselclassdefinitionsareusedbytheBLTtoassessthevalidityof
generatedvessels.Thus,iftheBLTwillbeusedtogenerateasyntheticvesselcalllistthenallfieldsin
theVesselClassDefinitiontabmustbecompleted.
TheuserdeterminesthecharacteristicsofclassificationintheVesselTypeandClassificationtab.
Minimumandmaximumvaluesarerequiredtobracketthevesselclasses.Theappropriate
assignmentofvesselsintovesselclassesiscriticalforthemodeltofunctionproperly.Severaltransit
rulesareappliedbasedonvesselclass;ifuniquevesselsareincorrectlyassignedtovesselclassesthe
transportationcostsmaybeinaccurate.Duringthevesselcalllistimport,HarborSymassignsunique
vesselstospecificvesselclassesbaseduponthecharacteristicsdefinedinthistab.Additional
informationinSection6.6describestheproceduresforvesselclassificationandtheprocessfor
managinguniquevesselsthatmayfallwithinmultipleoverlappingcategories.
Initially,onlyonerowwillappearintheVesselClassDefinitiontab.Additionalrowsaregenerated
automaticallyoncetheusereditsthepreviousrow.
Vessel Class Commodity Tab IntheVesselClassCommoditiesTab,showninFigure41,theusershouldidentifywhichcommodities
canbecarriedoneachvesselclass.Multiplecommoditiescanbeselected.Therowsofthistabare
automaticallypopulatedwiththevesselclassesenteredintheVesselClassDefinitionsTab.The
commoditycategories,shownacrossthecolumnheadings,areautomaticallypopulatedwiththe
categoriesenteredintheCommodityCategorytab.Thus,thevesselclasscommoditiescannotbe
assigneduntilthecommoditycategorieshavebeendefined.
Figure 41: Vessel Class Commodities Tab
71 Section 6  Developing a HarborSym Study Vessel Class Attributes Tab TheVesselClassAttributesTabhasdataentryfieldsforvariousdescriptorsthatareuniquebyvessel
class,asshowninFigure42.Therequiredfieldsaredescribedbelow.

VesselSizeUnits(VSU):ThevalueintheVSUfieldrepresentsanabstractunitofmeasure
designedtoaccountformulti‐dimensionalvesselsizes.AdditionalinformationonVSUusageis
availableinSection3.2.5.

UnderkeelClearance:Underkeelclearanceisthedistancerequiredbetweenthekeel,thelowest
partofthevessel,andtheharborfloor,expressedinfeet.Thedefaultvalueforunderkeel
clearanceis0.5feet.

DefaultTPI:thisfieldisnotmandatory.ValuespopulatedhereareusedbytheBLTwhennoTPI
regressionisavailable.SeeSection7.1fordetails.TPIshouldbeenteredastonspersquareinch.

SpeedatSea:Thisfieldisnotusedinwideningversioncalculations.Thisvalueisusedto
calculatevoyagecosts,includingoceanlegs.Iftheatseamileagewillnotimpactthestudy
results,aplaceholdervalueof1canbeentered(thefieldmustbepopulated).Speedatseashould
beenteredasknots,ornauticalmilesperhour.

SailingDraft:Themaximum/minimumsailingdraftsareusedinthedraftadjustment
calculations,asdescribedinSection3.3.2.Sailingdraftsshouldbeexpressedinfeet.

HourlyOperatingCosts:Minimum,maximum,andmostlikelyhourlyoperatingcostsmustbe
providedforHarborSymtoestimatetransportationcosts.Theoperatingcostsmustbedefined
byvesselstatus(atseaorinport)andalsobyvesselflag(foreignordomestic).Operatingcosts
aredescribedinSection3.2.5.
Figure 42: Vessel Class Attributes Tab Vessel Class Route Group Tab AsshowninFigure43,theVesselClassRouteGrouptaballowstheusertoestablishthedistributionof
vesselcallswithinavesselclassthattravelinpreviouslyidentifiedroutegroups(seeSection6.4for
furtherdetailsonroutegroupcreation).Thevaluesarepercentagesandwillbedividedby100
internallywithinthemodel.Thus,if25%ofavesselclasssailsanAsiatoU.S.EastCoastcircuit,“25”
shouldbeenteredintothedatagrid.Notethatroutegrouppercentagesmustequal100forgiven
Figure 43: Vessel Class Route Group Tab 72 Section 6  Developing a HarborSym Study vesselclassoranerrorwilloccurwhenassigningroutegroupstovesselcalls.
TherowsoftheVesselClassRouteGrouptabwillautomaticallypopulatewiththeuser‐definedvessel
classesoftheselectedvesseltype.Thecolumnheaderswillautomaticallypopulatewiththeuser‐
definedroutegroups.Thus,thistabcannotbepopulateduntilroutegroupshavebeenestablished.
Forwideningstudies,thefieldsinthistablearenotmandatoryforpropermodelfunctioning.The
defaultroutegroupcanbeusedwith100forallvesselclasses.IftheBLTwillbeusedtogeneratea
futuresyntheticvesselcalllist,thenthefutureconditionforvesselclassandroutegroupmustbe
specifiedwithinthistabfortheproject.
6.4 Route Groups RoutegroupsarenecessaryinHarborSymforchannel
deepeningstudies,asdescribedinSection3.2.8.Information
onroutegroupscanbeenteredbyselecting“RouteGroups”
under“VesselInfo”intheNavigationPane,asshowninFigure
44.TheDataEntryPanewilldisplayagridforenteringdata
requiredforroutegroups,asshowninFigure45.
Foreachroutegroup,theusermustprovideminimum,most
likely,andmaximumdistancesandlimitingdepthfortheprior
andnextportsofcall.Theusershouldbecertaintoassessthe
potentiallimitingdepthunderfutureconditionsconsidering
thefutureplannedexpansionofthePanamaCanal.“Additional
SeaDistance”canalsobedefinedwithatriangulardistribution
toaddressanyseasailingnotcoveredinthepriorandnext
portofcallfields.Alldistancesshouldbeenteredinnautical
milesandshouldconsiderareasonablecircuitforeachgroup.
TheA‐DAPPprovidestheAdditionalSeaDistanceforagiven
RouteGroup,seetheA‐DAPPUser’sGuidefordetails.Region‐
Figure 44: Route Groups to‐regiondistancescanbeusedasastartingpointfor
estimatingthedistancefromtheportofstudytopriorandnext
port.TheNationalGeospatialPublication151isanadditional
sourceforport‐to‐portsailingdistances.
Forwideningstudiesthedistancefieldsinthistablearenotmandatoryforpropermodelfunctioning.
Thelimitingdepthsmustbepopulatedwithvaluesgreaterthanthelimitingdepthofthestudyharbor.
Figure 45: Route Group Tab 73 Section 6  Developing a HarborSym Study Figure 46: Assignment of Route Groups Routegroupsmustbeassignedtoindividual
vesselcalls.TheA‐DAPPprovidesthis
information.A‐DAPPdatacanthenbecombined
withWCSCdatausingtheW‐DAPPandexported
inaformatcompatiblewiththePortTraffic
importspreadsheetusedbyHarborSym.Ifa
vesselcalllistisimportedusingtheHarborSym
importfunction,theuserwillbeaskedwhether
toassignRouteGroupstoallcallsortocallswith
ablankRouteGrouponly.Ifavesselcalllisthas
beenmanuallyenteredormodifiedafterimport,
userscanassignroutegroupsbyright‐clicking
ontheprojectnameandselecting“AssignRoute
GroupstoVesselCalls”,asshowninFigure46.
Notethatroutegrouppercentagesmustequal
100forgivenvesselclassoranerrorwilloccurwhenassigningroutegroupstovesselcalls.Afterthe
assignmentiscomplete,HarborSymprovidesaconfirmationmessage.Notethatroutegroup
percentagesmustequal100forgivenvesselclassoranerrorwilloccurwhenassigningroutegroups
tovesselcalls
6.5 Commodities Commoditiesarethecargothatvesselstransferatdocksintheharbor.Commoditiesaredefinedinto
categoriesbasedupontheavailablemanifestdata.Theweightofeachcommoditycategoryisinputin
tonsperunitofmeasure.Thesecommodityweightsdeterminethedraftofvesselsexitingtheharbor.
Commoditycategoriesarealsousedtoestablishtransferrates(vesselloadingandunloadingrates)
forvesselsatdocks.
6.5.1 Commodities Todefinethedesired
commoditycategoriesfor
aproject,select
CommodityInfointhe
NavigationPaneas
showninFigure47.The
usercanenterthe
commoditycategory
description,unitsof
measureandtonsper
unitforeachcommodity
categoryasshownin
Figure48.Theusercan
choosebetweenfour
programmedcommodity
units:Tons,Containers,
Automobiles,and
Passengers.Iftheunitof Figure 47: Commodity Information
74 Section 6  Developing a HarborSym Study measureis“Tons”thevalueinthe“TonsPerUnit”fieldshouldbe1.Ifcontainers,automobiles,or
passengersareselectedastheunitofmeasure,avaluetoconverttheunitintotonsmustbeprovided.
FortheCLT,commoditiesmustbeinTons.
Figure 48: Commodity Category Tab Vesselcallcommoditytransfersaredefinedasquantities,expectedtobeinunitsofthegiven
commodity.HarborSymperformsthenecessarycalculationstoconvertthisinputintotonsforeach
commoditytransfer.HarborSymrequiresinformationontonstransferredinordertoperformdraft
adjustments,whichrelyonthetonsperinchimmersionfactor.Inaddition,informationontonsper
unitandquantitiestransferredarecriticalintheproperdevelopmentofasyntheticvesselcalllistin
theBLTandCLTmodules.
Valueperunitisanoptionalfield.Thisinformationisusedinthevesselclassstatisticsgeneratedas
simulationoutput.Valueperunitisnotcurrentlyutilizedintransportationcostcalculations.
ForuserswishingtoutilizetheContainers,Automobiles,orPassengerunits,itisrecommendedthat
theanalystcontacttheDeepDraftNavigationCenterofExpertise(DDNPCX)orIWRforguidanceand
considerations.
6.5.2 Critical Commodities and Safety Zones Twomethodsareavailableforidentifyingsituationsinwhichavesselcarryingaspecialcommodity
willreceivepreferentialtreatment.Theusercanclassifycommoditycategoriesascritical
commoditiesbyselectingthecheckboxintheCriticalCommoditycolumn.VesselscarryingCritical
CommoditiesaretestediftheCriticalCommodityRuleisineffect.Vesselscanalsohavesafetyzones.
Safetyzonesarerequireddistancesbetweenvessels.Ifthecommodityisasafetyzonecommodity,
theusershouldselecttheSafetyZoneTypeandentertheSafetyZoneDistanceforthiscommodity.
AdditionalinformationonSafetyZonesisavailableinSection3.2.12andSection6.10.
6.6 Port Traffic Thevesselcalllististhelistofporttraffic.Thelistcontainsextensivedataaboutthevesselscalling
andthecommoditiestransferredattheharbor.TheA‐DAPPandW‐DAPPweredevelopedtoassist
usersindevelopingtheporttrafficspreadsheetrequiredforaHarborSymstudy.Seetherespective
user’sguidesandtrainingmaterialsfordetailsonhowtousethesetoolstodevelopahistorically‐
basedvesselcalllist.TheBLTandCLTweredevelopedtoassisttheuserincreatingavesselcalllist
thatrepresentsfutureconditions.ThesemodulescreateaVCDBthat,whenlinkedtotheHarborSym
projectthroughtheStudyManager,populatesthedatainthissectionoftheHarborSymnavigation
pane.
Therequireddataforthevesselcalllistincludes:uniquemovementnumber,arrivaldate,arrivaltime,
vesselname,harborentrypoint,harborexitpoint,vesselarrivaldraft,dockname,docknumber,dock
75 Section 6  Developing a HarborSym Study order,commodity,commoditynumber,unitsofeachcommoditytransferred,commoditymovement
direction(importorexport),vesseltypename,vesseltypenumber,vesselcapacity,LOA(length
overall),vesselbeam,vesseldraft,vesselTPIFactor,
Flag(nationality),andETTC(estimateoftotaltrip
cargo).Optionaldatainthevesselcalllistincludes
thevesseldestination(destinationportofexiting
vessel),NRT(netregisteredtons),GRT(gross
registeredtons),DWT(deadweighttons),Route
GroupName,RouteGroupNumber,VesselClass
Name,andVesselClassNumber.Theusercanselect
NRT,GRT,orDWTtorepresentthevesselcapacity
foreachvesseltype,asappropriateforthespecific
shiptype.Note:ifusingtheBLTtodevelopafuture
vesselcalldatabase,DWTmustbeselectedas
capacity.Whendeterminingthecorrect“capacity”of
thevesseltype,considerationmustbegivento
reasonabledeductions,suchasstores,bunkerage,or
emptyslotsoncontainerships.Capacityassignments
mustalsobeconsistentwithanyapplicabletransit
rules.Forexample,transitrulescanbe
parameterizedbasedoncapacityvalues.If,in
practice,theserulesareappliedbasedonvesselNRT,
thismustbeconsideredwhendefiningthecapacity
valueforindividualvessels.
Thevesselcalllistcanbepopulatedmosteasily
throughtheImportPortTrafficTemplatefunction.
ThistemplateisaMicrosoftExcelworkbookwith
Figure 49: Create Lookup Spreadsheet multipleworksheets.Importingthevesselcalllist
willfillfourdataentrygridsunderPortTrafficinthe
NavigationPane.Alternatively,theusercan
manuallyenterallinformationforthevesselcallsthroughtheHarborSymUserInterface.Giventhe
amountofdataandthenecessitytocorrectlylinkallelementsofindividualcalls,usersarestrongly
encouragedtoutilizetheimportfunction.Forfuturesimulatedporttraffic,theBLTandCLTcanbe
usedtogenerateaVCDB.WhenproperlylinkedtotheHarborSymproject,theVCDBisviewable
throughthePortTrafficsectionundertheprojectnameinthenavigationpane.
6.6.1 Create Lookup Spreadsheet Toensurethevessel,dock,andcommoditynumbersmatchthoseassignedwithinHarborSym,the
usercanexportatemplatespreadsheetthatisinthecorrectformatandhasthecorrectnumberof
columns.Tocreatethistemplate,rightclickontheprojectnameintheNavigationPaneandselect
CreateLookupSpreadsheetasshowninFigure49.
76 Section 6  Developing a HarborSym Study Selecttheappropriatelocationforthisfilebyclickingthebutton( )besidetheCreateSpreadsheet
Filefield.Afterselectingthelocationofthefile,clickOKontheCreateLookupSpreadsheetformas
showninFigure50.Amessagewillappearinformingtheuserthatthespreadsheetisreadyfordata
entry.TheusershouldclicktheOKbutton,navigatetothespecifieddirectory,andthenopenthe
spreadsheetusingMicrosoftExcel.
Figure 50: Create Lookup Spreadsheet Dialog Prompt
6.6.2 Populate Lookup Spreadsheet Thetemplatespreadsheetwillcontainthefollowingtabs:

Field_Descriptions:containsadefinitionofallfieldsincludedinthe“Calls”worksheet.

Commodity:containstwocolumnslistingthecommoditycategorydescriptionsenteredinto
HarborSymfortheprojectandthecorrespondingcommoditycategorynumber.

Dock:containstwocolumnslistingthedockdescriptionsenteredintoHarborSymandthe
correspondingdocknumber.

Vessel_Types:containstwocolumnslistingthevesseltypedescriptionsenteredintoHarborSym
andthecorrespondingvesseltypenumber.

Vessel_Classes:containsthreecolumnslistingthevesselclassdescriptionsenteredinto
HarborSymandthecorrespondingvesselclassnumberandvesseltype.

Route_Groups:containsthreecolumnslistingtheRouteGroupname,RouteGroupDescription,
andRouteGroupnumberenteredintoHarborSym.

Flag:containstwocolumnslistingthecountriesandcorrespondingcodesthatcanbeenteredfor
vesselflag.Thevalue“Z_Foreign”canbeusedasadefaultvaluefornon‐U.S.flagvessels.

Calls:contains30columnsthatdefinethevesselcalls,asdescribedbelowandinAppendixA.
Userscanpopulatethe“Calls”tabofthelookupspreadsheetwiththevesselcallinformation.
ReferencingthedatapopulatedbyHarborSymintheothertabsensuresthespreadsheetwillbe
importedcorrectlyintothemodel.TheDockNumbercolumnshouldbepopulatedbasedonthedock
worksheet.TheCommodityNumbercolumnshouldbepopulatedbasedontheinformationonthe
commodityworksheetandtheVesselTypeNumbershouldbepopulatedbasedontheinformationon
thevesselsworksheet.Similarly,VesselClassandRouteGroupinformationshouldbepopulated
77 Section 6  Developing a HarborSym Study basedonthedataprovidedinthecorrespondingworksheet.TheFlagfieldcanbepopulatedbasedon
theinformationontheflagsworksheet.Foralargecalllist,userscanutilizetheMicrosoftExcel
VlookUpfunctiontoassistwiththeentryofthesevalues.Forasmallcalllist,userscanmanuallyenter
thesevalues.
Theremaininginformationshouldbecompletedbasedonporttraffic.Usersshouldviewthevessel
calllistasdocumentationofallvesselsarrivingattheharborentrancepoint(s)duringthedesired
period.AlluniquevesselarrivalsmustbeassignedauniqueMovementNumber.Thisfieldisusedto
trackvesselcallswithmultiplerowentriesinthespreadsheet.Forexample,avesselarrivingatthe
entrancepointplanningtovisittwodockswithinthestudysystemwillhavetworowentriesinthe
importspreadsheet,oneforeachdockvisit,bothwiththesamemovementnumber.The
“Dock_Order”fieldindicatestheorderinwhichthevesselwillvisiteachofthedocks.Likewise,ifa
vesseliscallingonlyonedockbutexchangingmultiplecommodities(orimportingandexporting
commodities),theusermustentermultiplerowsintothespreadsheetforeachcommodityexchange
(theorderofrowsisimmaterial).Thesemultiplerowsmustbetaggedwiththecommonmovement
number.AppendixAcontainsatabledefiningthecolumnheadingsandrequireddataentryvaluesfor
thevesselcalllistimport.
Whenusingtheporttraffictemplate,theusermustspecifyETTCforeachvesselcall.ETTCisusedby
theHarborSymkerneltoallocateallorafractionoftheat‐seacostsforagivenvesselcalltothe
subjectport.CaremustbetakenthatETTCisenteredaccuratelyforhand‐craftedvesselcalllists
importedintoHarborSym.SeeSection3.3.1fordetailsonhowETTCisdefinedandused.
Afterthespreadsheetiscompletedandhasallcallinformationenteredtheusershouldsaveandclose
thespreadsheet.
6.6.3 Import Completed Vessel Call Spreadsheet TheHarborSymimportroutinedissectstheMicrosoftExcelworkbookandpopulatestheextracted
datainthecorrectlocationwithintheHarborSymVCDB.Beneficialfeaturesofthiscapabilityinclude
theidentificationofuniquevesselswithinacalllistandtheassignmentofuniquevesselstovessel
classes(ifvesselclassisblank).Uniquevesselsaredeterminedbasedontheexternalidentifier,vessel
name,andphysicalcharacteristicsincludingLOA,beam,capacity,anddraft.Theexternalidentifiers,
suchasLloyd’snumbers,shouldrepresentauniquevesselcallingtheport.Duringtheimportprocess,
Figure 51: Import Port Traffic 78 Section 6  Developing a HarborSym Study HarborSymallowsonlyonecombinationofexternalidentifier–vesselname–physicalcharacteristics
inacalllist.Vesselcallsshowingidenticalexternalidentifiersandnon‐identicalvesselnamesand/or
physicalcharacteristicswillnotbeimportedintoHarborSym.(Itis,however,possibletohave
multiplevesselsinthecalllistwithnon‐uniqueexternalidentifiersandidenticalvesselnames).All
vesselcallsunsuccessfullyimportedintoHarborSymaredocumented.Ifnecessary,userscanmodify
thecalllisttoreflectuniquevesselsandre‐importthedata.
EachuniquevesselimportedintoHarborSymisassignedtoavesselclassbasedonthevesseltypeand
physicalcharacteristicsifthevesselclassisblank.Insomeinstances,theusermayknowthevessel
classandmaywanttospecifythisinthevesselcallworksheetinthetemplate(e.g.,whendesignation
ofPanamax,SubPanamax,etc.isknown).Forthevesselswherethevesselclassisunknown,theuser
establishesthevesselclassthresholdsbasedonanycombinationoflength,beam,capacity,ordraft.
DuringtheHarborSymimport,vesselswithoverlappingclassificationsareassignedtothedefault
vesselclassforthecorrespondingvesseltype.
ThevesselcalllistspreadsheetisimportedintoHarborSymbyselectingImportPortTrafficfromthe
ImportmenuintheTaskBarasshowninFigure51.Thiscanalsobeachievedbyright‐clickingthe
projectnameandselectingImportPortTraffic.Clickonthebutton( )andbrowseandfindthe
completedvesselcallspreadsheetandthenensurethattheproperworksheetisselectedintheSelect
Worksheetfield.CreateImportLogisselectedbydefaultanditisrecommendedthatthisoptionbe
selected.TheCreateImportLogwillcreatealogoftheimportandnotifytheuserofanyrowsthat
werenotimportedduetoerroneousdata,suchasnon‐uniquevesselinformation.
ClicktheNextbuttontocontinuewiththeimport.Theusermustnowselectadefaultvesselclassfor
eachvesseltype.Ensurethatadefaultclassisselectedforallvesseltypes.Thedefaultclasscanbe
changedbychangingthevalueintheVesselTypeFieldasshowninFigure52.
Figure 52: Selection of Default Vessel Class
ThedefaultforeachvesseltypeissignifiedbyacheckintherowfortheDefaultClassvalue.
HarborSymwillusethedefaultclasstomakevesselclassassignmentswhenvesselscannotbe
assignedtoaspecificclassbaseduponitsmeasurements.Afterthedefaultvesselclasshasbeen
79 Section 6  Developing a HarborSym Study selectedforeachvesseltypeclicktheImportbutton.Whentheimportiscompletetheuserwill
receiveamessageaskingwhethertoassignRouteGroupstoblanksortoallvesselcalls.Aftermaking
theselection,amessagewillappeartoindicatethattheimporthascompleted.IfvesselclassRoute
GrouppercentagesareinconsistentwiththeRouteGroupsinthevesselcallspreadsheet,anerror
messagewillappearindicatingwhichvesselclassesneedreview.Ifthisoccurs,theimportwill
functionbutRouteGroupsthatwereblankuponimportwillremainblank.
6.6.4 Import Error Log HarborSymcreatesanImportErrorLogthatshouldbecheckedtoensureallvesselcalldatahasbeen
importedsuccessfully.Thisfileisinthesamelocationasthevesselcallimportspreadsheet.Locate
thisfileusingWindowsExplorerandopenitusingNotepad(orothertexteditorprogram).The
errorlogdocumentsdefaultvesselclassinformation,theassignmentofeachuniquevesseltoavessel
classtoandliststhetotalnumberofvesselcalls,dockvisitsandcommoditytransfers.Anyrecords
thatwerenotimportedduetodataerrorswillbelistedinthelastsectionofthisdocument.Asample
importerrorlogisavailableinAppendixA.
Iftherearenumerousimporterrorsrecordedinthelog,theMicrosoftExcelfileshouldberevised
andre‐imported.Whenusingthisapproach,allvesselcallinformationinHarborSymisautomatically
deletedbeforethenewspreadsheetisimported.
6.6.5 Port Traffic Data Entry Grids Afterthevesselcalllistisimported,thefourporttrafficdataentrygridsintheHarborSymStudy
Explorershouldbereviewed.Theseinclude:UniqueVessels,VesselCalls,DockVisits,and
CommodityTransfers.Eachofthecolumnsinthesegridscontainsasortfunctionthatallowstheuser
toreviewdatamoreeasily.Forexample,thehighestandlowestbeamofvesselscaneasilybe
reviewedbyclickingonthearrowimmediatelytotherightofthebeamcolumnheading.Vesselcalls
canberenderedinactiveduringasimulationbyremovingthecheckintheactivecolumn.
Unique Vessels Thisgridispopulatedwithalltheuniquevesselscallingthestudyharbor.Auniquevesselmaycallat
theportmultipletimesbutwillonlybelistedonceintheUniqueVesselstab.IfthePortTrafficis
populatedusingtheimportroutine,thentheuniquevesselsaredeterminedfromtheimported
spreadsheetbasedupontheexternalidentifierfield,thevesselname,andphysicalcharacteristics
Vessel Calls Thisgridprovidesinformationonthecallsmadebyeachuniquevessel.Thefieldsincludedinthis
gridare:

VesselCallID:Thisfieldisanautomaticallygeneratedidentifieruniqueforeachvesselcall.The
usercannoteditthisfield

IterationNumber:InthecurrentversionofHarborSymthevalueinthisfieldshouldbeone(1)
forallentries.WhenusingtheHarborSymimportfeature,theappropriatevaluewillbe
populatedautomatically.

MovementNumber:Thisnumberispopulatedduringtheimportroutineandwillmatchtheuser
definedmovementnumberfieldintheimportspreadsheet.
80 Section 6  Developing a HarborSym Study 
VesselName:ThisfieldmustcorrespondwiththenameofavesselintheUniqueVesselstable.
Userscaneditthisfieldthroughthepulldownmenu.

ArrivalDate:Thevalueenteredinthearrivaldatefieldrepresentsthedate(MM/DD/YY)and
timethevesselarrivesatthesystementrypoint.Userscaneditthisfieldthroughthepulldown
calendar.

Entrance/ExitPoint:Thisfieldmustcorrespondwithanodeidentifiedasanentranceorexit
point.Userscaneditthisfieldthroughthepulldownmenu.

Active:Byactivatingthischeckbox,usersinstructHarborSymtosimulatethecallduringall
scenariosfortheproject.Ifthecheckboxisnotselected,HarborSymwillnotincludethevessel
callinsimulations.

EntryDraft:Thevalueinthisfieldisthevesseldraftuponarrivaltothesystem,expressedin
feet.

RouteGroup:Thisistheroutespecifiedorassignedtothespecificvesselcallandmust
correspondwitharoutegroupenteredinthe“VesselInfo”portionofthenavigationtree.

ETTC–Estimateoftotaltripcargo,estimatedintheCLTascargoonboardthevesselatarrival
pluscargoonboardthevesselatdeparture,intons.ThisfieldisusedbyHarborSymtoallocate
alloraportionoftheat‐seacoststothesubjectport.SeeSection3.3.1fordetails.
Dock Visits TheDockVisitstabprovidesinformationonalldockvisitsmadeduringeachvesselcall.Thedock
visitislinkedtothevesselinformationthroughthe“VesselCallID”field.Theorderfieldindicatesthe
sequenceinwhichavesselwillvisitmultipledocksinasinglevesselcall.
Commodity Transfers Thisdataentrygridcontainsinformationonthequantityofcargomovedateachdockduringthedock
visits.Aseparateentrymustbemadeforeachcommoditycategoryexchangedateachdock.The
quantity,inunits,mustbeprovidedforbothimportandexportmovements.
6.7 Dock/Turning Basin Matrix Foreachvesselclass–dockcombination,theusermustassignaturningbasinthatthevesselswilluse
Figure 53: Dock/Turning Basin Matrix 81 Section 6  Developing a HarborSym Study forturningmaneuvers,andindicateifthevesselswillturnbefore,after,heaviest,lightest,ornotatall.
Thisassignmentisdonethroughthe“DockTurningBasinMatrix”,locatedwithinthe“PortTraffic”
branchofthenavigationpane.ThisisdepictedinFigure53.Thematrixcanonlybepopulatedafter
vesselclasses,docks,andturningbasinshavebeenentered.Onceinformationontheseport
structuresisentered,theDockTurningBasinMatrixwillautomaticallypopulatethevesselclassand
dockcombinations.Theusercanselecttheappropriateturningbasinandusagetypefrompulldown
menus.
6.8 Tide and Current Tidehasasignificantimpactonharborvesseltraffic,becauseofdepthconstraintsandvesseltraffic
rules.Tideshouldbeintroducedtothemodelifthedraftofanycallingvesselapproximatesthe
channeldepthsintheharbor.Currentisintroducedtothemodelonlyifavesseltrafficrulerequires
considerationofcurrent.
6.8.1 Tidal Stations Tidalstationsarelocationsatwhichtides
aremeasured.Standardtidalstationsare
availableinHarborSymandthe
appropriatelocalstationsshouldbe
selectedforuseinastudy.Topopulatethe
tidalstations,right‐clickontheproject
nameandselectPopulateTideStations,as
showninFigure54.Thelatitudeand
longitudeoftheharborandasearchradius
mustbeenteredtoobtainalistofthe
relevanttidalstations.Oncethisdatahas
beenenteredclicktheRetrievebutton.
Theappropriatetidalstationsneedtobe
Figure 54: Populate Tide Stations
enabledbycheckingtheenablebox.Select
“Tide”fromthemenuforstationtype.
ClicktheSavebuttontosavethesechanges.ThePopulateTideStationswindowisshowninFigure55.
82 Section 6  Developing a HarborSym Study Figure 55: Populate Tide Stations Window
Oncetidestationsinthestudyareahavebeenidentified,theusershouldassigntheappropriatetide
stationstoeachreachthroughthe“TidalStations”branchunder“Tide”intheNavigationPane.The
dataentrygridwillautomaticallypopulatewiththeavailablereachname.Foreachreachtheusercan
selecttwonearbytidestationsfromwhichHarborSymwillpullnecessarytidalinformation.Thetide
stationsidentifiedinthe“PopulateTideStations”stepwillappearasoptionsinthepulldownmenus.
Theinterpolationfieldshouldbeavaluebetween0and1,whereanentryof0pullstidevalueentirely
fromTideStation1andanentryof1pullstidevalueentirelyfromTideStation2.Forexample,ifa
reachisclosertoTideStation1thanTideStation2,avalueof0.25mightbeentered.
Toviewthecompletelistoftidestationsselectedduringthe“PopulateTideStations”stepselectthe
main“Tide”branchfromthenavigationtree.Thisscreenisblankuntiltidestationsarepopulatedin
thepop‐outwindow.
6.8.2 Current Stations Currentstationsarestationsfromwhichtheflowofcurrentismeasured.Allcurrentstationsare
availableintheHarborSymmodel.Toenablecurrentstationsfollowthesameprocessastidal
stationsexceptselect“current”asthestationtypeinthe“PopulateTideStations”window.Current
stationsareassignedtoreachesbyclickingon“CurrentStations”intheNavigationPane.Theuser
shouldclicktheplusiconbesideTideintheNavigationPanesothatCurrentStationswillappear.
ClickingonCurrentStationsintheNavigationPanewillprompttheCurrentStationsDataEntryGrid
toappear.Onlythereacheswithvesseltrafficrulesconsideringcurrentwillappearinthedataentry
grid.Acurrentstationmustbeselectedforeachreachwhereavesseltrafficruleusescurrent.
83 Section 6  Developing a HarborSym Study 6.9 Vessel Speeds and Times Tosimulatevesselstransitingtheharborandtransferringcargo,thesailingspeedandtheamountof
timespentatthedocksissimulated.Arangeofsailingspeedsandtimes(e.g.dockingtimeorturning
time)mustbeenteredintoHarborSym.Speedsareenteredforeachvesselclass/reachcombination
forlightandloadedvesselstatusinknots.Triangulardistributionsforeachvesselclassarerequired
forthevarioustimecategories.Section6.2.6providesdetailonenteringspeedsandreachesthrough
thedataentrygrids.Alternatively,userscanpopulatethesefieldsbyimportingaMicrosoftExcel®
spreadsheet.AppendixAdescribeshowtousetemplatesfordataentryofspeedsandtimes.
6.10 Safety Zones Asafetyzoneisaparticulartransitrulethatfunctionssimilarlytoplacingaprotectivebubblearound
avesselasitmoves.Thedistanceextendsfromtheship’sbowandtheship’sstern.Thesafety
distance,designatedbytheuser,isequalforbothsides.Nomovingvesselsareallowednexttothe
designatedsafetyvessel.Safetyzonesareuser‐defined,commodity‐specificcharacteristics.These
characteristicsdescribehowthemodelshouldtreatvesselscarryingthesecommodities.
Thethreechoices(notsafetyzonecommodity,alwayssafetyzonecommodity,andsafetyzone
commoditywhencarrying)definetheapplicationofsafetyzonerulesforeachcommodity.When
selected,“AlwaysSafetyZoneCommodity”willrequirethesafetyzonedistancetobefollowed
regardlessofthequantityofcommoditycarriedonthevessel.Underthe“SafetyZoneCommodity
WhenCarrying”option,HarborSymwillonlyapplythesafetyzonewhentheselectedcommodityis
presentonthevessel.Regardlessoftheoptionselected,safetyzonesareonlyappliedinreacheswith
activesafetyzonerules.
Forexample,considerasituationwhereavesselimportsliquefiedgasintoahypotheticalharbor,
completelydischargesitscargoatthedock,anddepartstheportwithoutanycargo.Inthisscenario,
the“MaintainSafetyZone”transitrulehasbeenactivatedattheportlevelandthusappliesinall
reaches.Ifliquefiedgashasbeendesignatedasafetyzonecommodityunderthe“AlwaysSafetyZone
Commodity”option,thesafetyzonewillbeappliedtoboththeinboundandoutboundtransits
becausethevesselcarriedthecommodityduringthecurrentvesselcall.Ifthe“SafetyZone
CommodityWhenCarrying”optionwasselected,thesafetyzonewouldapplytoallreachesonthe
vessel’sinboundtransitonly.Ifthe“NotSafetyZoneCommodity”optionwasselected,safetyzones
wouldnotapplytoliquefiedgas,regardlessoftheactivated
portleveltransitrule.
6.10.1 Activate Safety Zones Therearetwomainprocessestoactivatesafetyzonesin
HarborSym.First,theusermustdesignatecommoditiesfor
safetyzoneandentertheassociatedspecificdetails.Then,the
“MaintainSafetyZone”rulemustbedesignatedforallreaches,
orforspecificreaches.
6.10.2 Designate Safety Zone Commodities Theapplicationofsafetyzonesistriggeredbythe
commoditiescarriedbyavessel,ratherthanthevesseltypeor
class.Designatingsafetyzonecommoditiesisdonethrough
Figure 56: Commodity Information
84 Section 6  Developing a HarborSym Study theCommodityCategorytabwithintheCommodityInfobranchoftheNavigationPane,asshownin
Figure56.
IntheCommodityCategorytab,showninFigure57,the“SafetyZoneType”fieldispopulatedusinga
pulldownmenu.Forcommoditiesdesignatedaseither“AlwaysSafetyZoneCommodity”or“Safety
ZoneCommodityWhenCarrying”,asafetyzonedistancemustalsobeentered,measuredinfeet.This
istheadditionalbufferthatwillbeincludedonboththebowandsternofthevesselinreacheswith
activesafetyzonerules.
Figure 57: Selecting Safety Zone Commodity
6.10.3 Activate Safety Zone Rules for Reaches Aport‐leveltransitrulecanbeappliedifsafetyzonesmustbeobserveduniversallythroughoutall
reacheswithinthenetwork.Ifdefinedandactivated,theMaintainSafetyZonerulewillbeenforcedin
allreachesforallsafetyzonecommodities.Thisprovidesefficienciesovermanuallyenteringtherule
inallreaches.Note,however,thatifmultipleprojectshavebeencreatedwithinonestudy(e.g.,
existingcondition,futurewith‐projectconditions),allprojects
willbeimpactedbytheport‐levelrule.
Aport‐leveltransitcanbeenteredbyselectingthe“Port
TransitRule”branchintheNavigationPane,showninFigure
58.SelecttheMaintainSafetyZoneruleintheRuleTypepull‐
downlist.Theapplicableconditionunderwhichthesafety
zonerulewillapplycanbedefinedas“Always”,“Day”,or
“Night”basedonportrules,showninFigure59.Thelatitude
andlongitudeenteredintothe“StudyManager”willdetermine
daylightandnighthours.Specifichourscannotbedesignated.
Figure 58: Port Transit Rules Selection Figure 59: Selecting Port Transit Rule Conditions 85 Section 6  Developing a HarborSym Study Vesselpassingtype(overtakingorpassing)isnotapplicableforthisruleandshouldbedesignatedas
such.The“Active”boxmusthaveacheckmarkinordertoactivatetherule.
Ifsafetyzonesareappliedonlytoselectreacheswithintheharbor,therulemustbeenteredintoeach
applicablereachindividually.Todefineandactivatesafezonesinspecificreaches,navigatetothe
Reachdataentrygridunder“PortStructures”.Clickonthe“ReachSafetyZoneActive”boxforall
reacheswherethesafetyzonesmustbeobserved,asshowninFigure60Aswithport‐levelsafety
zonerules,vesselpassingtype(overtakingorpassing)isnotapplicableforthisruleandshouldbe
designatedassuch.The“Active”boxmusthaveacheckmarkinordertoactivatetherule.
Figure 60: Activating Reach Safety Zones
Figure 61: Reach Transit Rule Selection
The“MaintainSafetyZone”rulemustbeparameterizedforeachreachwithacheckmarkinthe
“ReachSafetyZoneActive”field.Todoso,highlightthereachasshowninFigure60andnavigateto
theTransitRuletab.The“MaintainSafetyZone”ruleshouldbeselectedwiththecorrectapplicable
conditions(always,day,ornight),asdisplayedinFigure61.
6.11 Data Validator 86 Section 6  Developing a HarborSym Study AsHarborSymrequiresagreatdealof
consistentuserdefinedinformationto
functionproperly,adatavalidationtool
hasbeendevelopedtoaidtheuserin
determiningthecompletenessand
reasonablenessoftheinformation
entered.Userscanaccessthedata
validationtoolbyrightclickingonthe
projectnameandselectingValidateData,
asshowninFigure62.Thiswilllaunch
theDataValidationForm,withinwhich
theusercandeterminewhichdatafields Figure 62: Data Validation Tool
shouldbeverified,toinclude:Port
Information,VesselInformation,Port
Structures,PortTraffic,andTideInformation.Aftercheckingthedesireddataelementsforvalidation,
theusershouldselect“CheckData”.HarborSymthengeneratesareportoutliningthestatusofthe
user‐provideddata.ThereportwillstateErrororWarningandlisttheprobleminanycategoriesfor
whichdataneedsattention.Thisreportcanbeprintedorsaved.Asampledatavalidationreportis
includedinAppendixA.
TheDataValidatorwilllistanydataentryfieldsthatareempty,buttheseemptydataentryfieldswill
notnecessarilycauseaproblem.Asanexample,theDataValidatorwillnoteanyvesselclasswithout
speedsenteredinareach.However,notallvesselclassestransiteveryreach.Nothavingaspeed
enteredforpassengervesselsonareachusedonlytoaccessacontainerdockmaynotcausea
problem.HavingtheautomatedDataValidatorfunctionlistallmissingdatafieldsallowstheuserto
systematicallycheckforproblems.
TheDataValidatortoolcomparestheuserprovideddataagainstestablishedrangesofvalues,asset
bytheuser,thatareacceptableforinput.Inputvaluesoutsideofthedefinedrangegenerateanerror
messageduringdatavalidation.Theconfigurationsettingscanbesetupselecting“Configuration
Settings”underthe“File”menuoption.Figure63capturestheconfigurationsettingswindow.
Figure 63: Data Validation in Configuration Settings
87 Section 6  Developing a HarborSym Study Thedatavalidationsettingsavailableunderthe“Validation”taboftheConfigurationSettingswindow
includefieldscoveringphysicaldimensionsofthereaches(length,width,depth),vesselspeeds,and
dockingtimes,asdefinedinTable4.Forthesefields,theusermustprovideminimumandmaximum
valuesthatrepresentareasonablerangewithinwhichdatavaluescanfall.Theusershouldcheckthe
“Error”boxforalldatafieldsthatrepresentabsolutemaximum/minimumvalues.Thedatavalidation
reportwillhighlightdatavaluesthatfallbeyondtheestablishedthresholds,notinginparticularthose
valuesidentifiedaserrors.
Table 4: Validation Settings FIELD DESCRIPTION VALUE TPIFactor
Checkoftonsperinchimmersion(TPI)factor,usedprimarily
indraftadjustmentcalculationsaftercargoexchanges(see
Section3.3.2).
ReachLength
Checkofreachlengthtoidentifydataentryerrorsinnetwork
design.Allreachesinthenetworkarecomparedagainstthis
field.
Checkofreachdepthtoidentifydataentryerrorsinnetwork
design.Allreachesinthenetworkarecomparedagainstthis
field.
Checkofreachwidthtoidentifydataentryerrorsinnetwork
design.Allreachesinthenetworkarecomparedagainstthis
field.
Checkofminimumspeedinreach.Allreachesinthenetwork
arecomparedagainstthisfield.
Checkofmaximumspeedinreach. Allreachesinthenetwork
arecomparedagainstthisfield.
Checkofminimumtimevesselswillspenddocking.Alldocks
andvesselclassesarecomparedagainstthisfield.
Checkofmaximumtimevesselswillspenddocking.Alldocks
andvesselclassesarecomparedagainstthisfield.
Checkofmaximumtimevesselswillspendundocking.All
docksandvesselclassesarecomparedagainstthisfield.
Enterasingle
minimumand
maximumvalue
againstwhichall
vesselclasseswill
bechecked,
expressedininches.
Entervaluesinfeet.
ReachDepth
ReachWidth
SpeedInReach
Minimum
SpeedInReach
Maximum
Minimum
DockingTime
Maximum
DockingTime
Maximum
UndockingTime
Minimum
UndockingTime
MinVessel
TurningTime
MaxVessel
TurningTime
88 Checkofminimumtimevesselswillspendundocking.All
docksandvesselclassesarecomparedagainstthisfield.
Checkofminimumtimevesselswillspendinturning
maneuvers.Allturningbasinsinthenetworkarecompared
againstthisfield.
Checkofmaximumtimevesselswillspendinturning
maneuvers.Allturningbasinsinthenetworkarecompared
againstthisfield.
Entervaluesinfeet.
Entervaluesinfeet.
Entervaluesin
knots.
Entervaluesin
knots.
Entervaluesin
hours.
Entervaluesin
hours.
Entervaluesin
hours.
Entervaluesin
hours.
Entervaluesin
hours.
Entervaluesin
hours.
Section 6  Developing a HarborSym Study 6.12 Simulations Asimulationprovidesestimatesofvesseltransittimesandoperatingcostsbasedupontheprojectand
therunparameters.Therunparametersaredefinedbythescenario,whichspecifiesthetimingand
durationofthesimulation.Simulationsconsistofoneormoreiterations,asdefinedbytheuser.
6.12.1 Scenarios Ascenarioisadefinitionoftherunparametersofasimulation.
Scenariosdefinetheperiodofvesseltrafficsimulatedandhow
thesimulationisconducted.Scenariosarestoredbyname,
whichappearsintheNavigationPaneunder“Scenarios.Toset
upascenario,clickonthisfieldintheNavigationPane,as
showninFigure64.TheScenarioDefinitionDataEntryGrid,
showninFigure65,willdisplayalltheoptions,called“run
parameters”,thattheusermustspecifyforaspecificscenario.
AlthoughthescenarioinformationisdisplayedintheScenarios
dataentrygrid,itisalsopossibletoentertheinformationin
thescenarioeditorform.Aftercreatingascenariointhedata
entrygrid,selectthenewscenariointhenavigationpaneunder Figure 64: Scenarios Scenarios.ThiswilllaunchtheScenarioEditorform,shownin
Figure66.Definitionsandfurtherinformationconcerningthe
differentoptionsavailablecanbefoundinSections3.2.15and8.2.1.
Figure 65: Scenario Paramters Data Entry Grid
89 Section 6  Developing a HarborSym Study Figure 66: Scenario Editor 6.12.2 Launch a Simulation Afterthescenariohasbeendefined,thesimulationcanbelaunchedbyclickingontheLaunchButton
atthebottomoftheDataEntryPane.Ifthestudycontainsmultipleprojects,theusermustselectthe
projectstobesimulatedandclickLaunchinthenewdialogbox.Ifthe“StartFirstIterationinStep
Mode”optionwasnotselected,thesimulationwillproceeduntilcompletionofalliterationsand
visualizationwillnotbeavailable.
Iftheuserhaschosentostartthesimulationinthestepmode,theusershouldclickOKonthe
messagereceivedconcerningstartingthesimulationinstepmode.ClickingontheStepButtoninthe
VisualizationScreenwillbeginthesimulation.ClickingontheNextButtonwillprocessthenextinthe
simulation.SelectingtheContinuousButtonwillprocesseventscontinuouslyatasteadyspeedwith
animation,ortheresumebuttontoprocesswithoutanimation(whichrunssignificantlymore
rapidly).Whenthesimulationiscompletetheuserwillseeadialogboxwithaveragetimesanddelays
displayed.ClickingtheOKButtonwillclosethesimulation.Additionalinformationoncontrollingthe
within‐simulationanimationiscontainedinSection8.3.
6.12.3 Cancel a Simulation Asimulationcanbecancelledwhileinprocess.Simulationswithmultipleiterationsmaytakeseveral
hourstocompleteandtheusermaywanttocorrectdataentrybaseduponthevisualizationscreen.
Tocancelasimulation,theusershouldclickonHalt.Adialogboxwillappearwiththeoptionto
cancelthesimulation.Ifmultipleprojectswereselectedforsimulation,eachwillhavetobecanceled
individually.
90 Section 6  Developing a HarborSym Study 6.13 Cloning HarborSymStudymanagercontainsacloningfeaturethatallowstheusertocreateanewproject
withinastudythatcontainsallofthedataenteredfortheoriginalproject.Theusercanthenmodify
thevaluesthatwouldchangeiftheharborimprovementwasimplementedasthealternativeproject.
TocloneaprojecttheusershouldmovetotheStudyManagerbyselectingStudyManagerfromthe
Filemenu.
TheusershouldnowclicktheCloneProjectbuttonontheStudyManagerDialogBox,showninFigure
67andenteranameandstoragelocationforthisnewproject.Afterspecifyingthenameandlocation
ofthenewproject,clicktheOKbutton.ClicktheCloseButtontoclosetheStudyManagerandselect
StudyExplorerfromtheViewMenu.ThenewprojectwillappearintheNavigationPaneunderPort
belowtheoriginalproject.
Figure 67: Clone Project in Study Manager
91 Section 6  Developing a HarborSym Study Thispageintentionallyleftblank.
92 Section 7 Generating a Synthetic Call List Using Loading Modules HarborSymdoesananalysisofanindividualvesselcalllist,developingdetailedcostdataforthe
situationpresentedinthedata.Typically,theexistingconditionwillbebasedonhistoricalvesselcall
data,butprojectionsmustbedevelopedforfutureandwith‐projectsituations.SeparateHarborSym
runsaremadeforthewithout‐andwith‐projectconditions,forexistingconditionsandprojected
futuresforthedesiredplanninghorizon.
AcomplicationinusingHarborSymforUSACEplanningstudiesisthusthegenerationofvesselcall
liststhatrepresentfleetarrivalsandloadingsunderfuturewithout‐andwith‐projectconditions.That
is,awith‐projectvesselcalllistmustrepresentthefuturefleetandcommoditydemandsforimport
andexportattheportandtheassociatedcommoditytransfersandvesselloadingsmustbereflective
ofthepossibilitiesofferedbythedeepenedchannels.
Giventhedistinctnatureofnon‐containerizedandcontainerizedships,separatetoolsweredeveloped
toaddresstheirspecificvesselloadingbehavior.TheBulkLoadingTool(BLT)modulegeneratesa
syntheticfuturevesselcalllistbasedonuserprovidedinformationonthefleetandcommodity
demandsforallnon‐containershipvessels,suchasbreakbulk,bulkcarriers,barges,cruiseships,and
tankervessels.TheContainerLoadingTool(CLT)moduleproducesacontainership‐onlysynthetic
futurevesselcalllistbasedonuserinputsdescribingcommodityforecastsatdocksandtheavailable
fleet.GiventhenatureoftheHarborSymdatabasestructure,theBLTandCLT‐generatedvesselcall
listsmustbecombinedintoasinglevesselcalllistforcaseswherebothtypesoftrafficaretobe
modeled.TheCombinermodulewasdevelopedtoaddressthisneed.Thefollowingsectionsdescribe
thestepstocreatethesyntheticvesselcalldatabaseusingthesemodules.
WhilethegeneralfunctionoftheCLTissimilartotheBLT,therearemanydifferencesamongstthe
toolswhichshouldbeconsideredandfullyunderstood.Forexample,thespecificvesselloading
behaviorofcontainerizedvesselsisdifferentfromgeneralizedbulkvesselsandthusthevessel
loadingroutineinthetoolsisdifferent.TheBLTgeneratessyntheticvesselsusingstatisticalroutines
whiletheCLTgeneratesvesselsbyselectingfromstandardvesseldefinitionsinasub‐class.TheCLT
allowsforseasonalpatternsinshippingthroughouttheyearwhiletheBLTdoesnot.Differencesexist
amongsttheuserinterfacesaswell.TheBLTistreestructuredwhiletheCLTismenudriven.Theuser
isabletopopulatemuchoftheBLTdatarequirementsusingastatisticalroutinewhiletheuserofthe
CLTmustmanuallyentermuchoftherequireddata.DataeditedintheBLTtablesmustbesaved
beforeclosingthetablewhileeditstotheCLTviewabletablesareautomaticallysaved.These
differencesshouldbeunderstoodwhenusingboththeCLTandBLTtogenerateavesselcalldatabase.
7.1 Create Synthetic Bulk Call List Using Bulk Loading Tool TheBLTwasdevelopedtoassistusersingeneratingasyntheticfuturevesselcalllistfornon‐
containershipvessels.TheBLTislaunchedfromtheHarborSymToolsmenu,asshowninFigure68.
Detailsofthetheory,design,datainputs,anduserinterfaceoftheBLTcanbefoundinSection4.1.The
followingsectionsoutlinethestepstocreateasyntheticcalllistforgeneralizedbulkvesseltraffic
93 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules usingtheBLT.Theendresultoftheprocesswillbeafully
populatedVCDBthatcanbeuseddirectlybyHarborSym.The
BLT‐generatedVCDBmustbecombinedwiththeCLT‐
generatedVCDBusingtheCombinermoduleifcontainerized
trafficismodeledintheanalysis.
7.1.1 Set Working Files TheBLThasbeendesignedtoreducetheamountofdatainput Figure 68: Launch Bulk Loading Tool
requiredbytheuser.Ratherthanreassertthebasic
parametersofthestudy,suchasdocks,vesseltypes,
commodities,androutegroups,theusercandirecttheBLTtotheHarborSymIDBthatalready
containsthisinformation.NotethattheIDBshouldreflectthefutureconditions,includingany
commoditycategoriesforecastedtobeexchanged,routegroupparameters,and/orvesselclasses
anticipated.Forexample,ifanewvesselclassisforecastedtocalltheportthatdidnotcallhistorically
(suchaslargerbulkvessels),thenthisvesselclassmustbeinitiallysetupintheprojectthroughthe
HarborSymUI.Notethatalldataelementsmustbecompleteforthenewcommodity,routegroup,or
vesselclass.Becertainthatthe‘DefaultTPI’fieldintheVesselClassAttributestabiscompleteasthis
valuewillbeutilizedtogeneratesyntheticvesselcharacteristics.
Additionally,theBLTcanbedirectedtoahistoricalVCDBthatcontainspertinentvesselclass
informationthatisusedtocreatethesyntheticvesselsforthefuturecalllist(forvesselclasses
historicallycalltheportonly,newvesselclassinformationwilldrawfromtheIDBtogenerate
syntheticvessels).Thisfeatureofthemodulenotonlysavestheusertimebyeliminatingtheneedfor
duplicatedataentry,butitalsoensurestheaccuracyofthedataanditsconsistencywithaHarborSym
IDB.
TheusermustlinktheBLTmoduletotheappropriateIDB,VCDB,andFCDBdatabases(databasesare
explainedinTable1:DatabasesUsedInAnalysisonpage6).Tobegin,select“1.SetWorkingFiles”
fromtheNavigationPane,asshowninFigure69.Whenthisisselected,aformwillappearinthe
OptionsPanethatassiststheuserinspecifyingthedatabases.TheDataPanewillbeblankduringthis
step.Notethatuntilallthedatabaseshavebeenspecified,nootheroptionisavailabletotheuserin
theNavigationPane.
Figure 69: Attach Appropriate Databases to BLT
TheIDB,orinputdatabase,describesprojectlayout,includingthedocks,vesseltypes,vesselclasses,
andcommoditycategories.ItisimportanttoattachtheBLTmoduletothecorrectinputdatabase,as
94 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules thisdatabasedefinesthevesselandcommodityclassificationsthatprovidethebasisfora
syntheticallygeneratedcalllist.Also,thelinkedIDBmusthavealldatafieldscompleted,includingmin
andmaxparametersforvesselcharacteristics.
TheVCDB,orvesselcalldatabase,documentstheuniquevesselsthatcalltheport,andallthecallsand
commoditytransfersmadebythesevessels.Initially,apopulatedVCDB,possiblyhousingtheexisting
conditioncalllist,shouldbeattachedtotheBLT.Anexistingcondition(orotherpopulatedvesselcall
database)isusedtopopulatebasicinformationfortheBLTforecast,suchasthelogicalconstraints
andvesselclassstatistics.
ThefinaldatabasethatmustbeassignedistheFCDB,orforecastdatabase.Thisdatabaseisuniqueto
theBLTandstoresinformationaboutcommodityforecastsatdocks,constraintsonvesselclass
capabilitytocarrycommoditiesandserveindividualdocks,andthevesselfleet.Inaddition,the
statisticalinformationnecessarytogeneratesyntheticvesselsisstoredinthisdatabase.Initially,a
blankFCDBshouldbeattachedtotheBLT.Thiscanbedonebyselecting“CreatefromTemplate”from
thepulldownmenuunderFCDB.Followthepromptstoprovideafilenameandsavelocationforthe
newFCDB.
AftertheappropriateIDB,VCDB,andFCDBhavebeenlinked
totheBLT,theusershouldsavethedatabaseconfiguration,if
desired.Savingtheconfigurationwillpreservethelinksifthe
usershouldneedtoclosetheBLTandre‐opentocompletean
analysisatalatertime.Tosavethedatabaseconfiguration,
choose“File/SaveConfig”fromtheBLTmenuoptions,as
showninFigure70.
Figure 70: BLT‐‐Save Database Configuration 7.1.2 Populate Forecast AfterattachingtheBLTtothecorrectsupportingdatabases,theblankforecastdatabase(FCDB)must
bepopulated.Thisisaccomplishedthrougheithermanuallyinputtingtheinformationinthetablesor
byselectinganalreadypopulatedIDBandVCDBthatwillbeusedasthestartingpoint.The
informationthatisneededincludes:

Dock:Constraintsdescribingthedocksavailable.ThisgridispopulatedbasedontheIDBandis
noteditablebytheusertoensureconsistency.

FleetSpecification:foreachvesselclass,themaximumnumberofporttrips(vesselcalls)
availablefortheforecastyearandthevesselclassallocationpriority;theallocationpriority
determinestheorderinwhichvesselclassesarecalledupontosatisfycommodityforecasts
(allocationpriorityof1isloadedfirst).

CommodityForecastatDock:thetotalamountofeachcommoditytobeimportedandexported
ateachdock.

DockVesselClass:thevesselclassesthatareabletoserviceeachdock;ifavesselclass–dock
combinationisnotpresentinthistable,thevesselclasswillnotbeabletosatisfyanyofthe
commodityforecastatthedock.

VesselClassCommodityCategory:anidentificationofthecommoditycategoriesthatcanbe
loadedoneachvesselclass,aswellasadescriptionofcargoexchangebehaviorsincluding:
95 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules - Atriangulardistribution(minimum,mostlikely,maximumvalues)forloadingthevesselsby
importandexport,describingthepercentofthevesselcapacitythatwillbeloadedor
unloadedatthestudyport);
- Directionofcommoditymovements:exportonly,importonly,bothimportandexport,or
random(callsoftheclasscanbeeitherimportonlyorexportonlymovementsbutnotboth
onagivencall);
- Importpercentageforvesselclassesassignedas“random”loading.

VesselClassRouteGroup:theassignmentofroutegrouptoeachvesselclassandapercentageof
allcallsbytheclassthatsailontheroute.

VesselClassCapacityRegression:asmoothedCDFcapacityfunctionforeachvesselclass.

VesselClassRegression:foreachvesselclass,regressioninformationforderivinglengthoverall
(LOA),beamanddesigndraftfromcapacity.

VesselClassTPIRegression:foreachvesselclassinthehistoricalVCDB,anassignmentofthe
beam,draft,capacity,andLOAcoefficienttobeusedindevelopingthevesselTPI.
Figure 71: BLT Populate Forecast Options
Asthesedatarequirementsareextensive,anexistingVCDBcanbeusedtopopulatetheforecast
databaseusingstatisticalroutinesfromExtremeOptimization.Theuserhastheoptiontoselectwhich
tablesshouldbepopulatedwithdatafromtheexistingVCDBbydeselectinganyoptionstheydonot
wantpopulated,asshowninFigure71.Allselectedtableswillbefilledwithdatacorrespondingtothe
informationcontainedintheattachedVCDB.Forexample,ifthe“CommodityForecastatDock”option
isselected,thecommodityforecastsateachdockwillbepopulatedintheforecastdatabasewiththe
actualcommoditiestransferredatthedocksintheexistingvesselcalllistreferencedinthe“Set
WorkingFiles”step.UsinganexistingVCDBtopopulatetheFCDBisespeciallyusefulingenerating
thelogicalconstraints(e.g.,whichcommoditiesmovethrougheachdockandwhichvesselclassescall
eachdock)andpopulatingthestatisticaltables.TocompletetheFCDBpopulation,theusershould
selectthedesiredtablestobefilled,andthenselectthe‘PopulateSelected’buttonlocatedontheright
oftheform(showninFigure71).
96 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.1.3 Update Tables in Database Selectingthetablesshownunder“UpdateDatabase”willdisplaythetabledataforreviewafterthe
populationroutinehasbeenexecuted.UsinganexistingVCDBtopopulatetheFCDBreducesthedata
entryrequirements,butdoesnoteliminatetheneedtoreviewandmanuallyupdatethetableswith
appropriateforecastinformation.Alldatainthetablesmustbereviewedandadjusted,asnecessary,
toreflecttheforecastedconditions.Tobegin,selectatabletoreviewunder“Step3:UpdateDatabase”,
asshowninFigure72.Thekeyinformationthatshouldbereviewedand/oriseditablewithinthe
FCDBwilldisplayinthedatapane(highlightedinredonFigure72).
Figure 72: BLT Update Database ToaidtheuserinrecallingIDBdataspecifications,aqueryformisprovidedinthefarrightoftheBLT
datapane.ThequeryformallowstheusertoviewadditionaldetailsonDocks,VesselType,Vessel
Class,CommodityCategories,andRouteGroups.ThequeryformisshowninFigure73.Thedata
showninthequerytablesareonlyforviewingandcannotbeedited.
97 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Figure 73: BLT‐‐Review IDB Data Using Query Form
Iftheproject‐relatedIDBandanhistoricalVCDBwasusedtopopulatetheFCDB,theneachtablemust
bereviewedandeditedtoreflectthefuturesyntheticfleetandcommodityforecastforbulktraffic
only.IftheIDBandVDCBfortheHarborSymprojectusedtopopulatetheforecasthasacontainerized
vesseltypewithclassesandcontainerizedcargocommoditygroup,thenthetablesprovidedunder
‘UpdateDatabase’intheBLTshouldbeeditedtoremoveanyreferencetocontainerizedvesselsor
commoditiescarriedsolelyby
containerships.
Deleterowsbyfollowingthesteps
showninFigure74.Beginbyselecting
therecord(s)thatyouwouldliketo
delete.Youcansortbythefields(such
asVesselClassID)toarrangethedata
inawaythatmultiplerecordscanbe
deletedatatime.Next,clickthe
‘Remove’button.Apromptwillappear
askingifyouwouldliketodeletethe
selectedrow(s),asshowninStep3.
Click‘OK’.Youwillbepromptedagain
toconfirmthatyouwouldliketo
deletetherow,click‘Yes’.Foreach
rowthatisselectedtobedeleted,the
userwillhavetoconfirmthedeletion.
AsshowninStep5,theusermustclick
‘Save’inorderforthechangestobe
permanentintheFCDB.
Theusermustclicksaveafter
editingdatainanyofthetables.
98 Figure 74: Delete References to Container‐related Data in BLT Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Alltablesmustbeupdatedtoproperlyreflectthefuturefleetandcommodityforecastforgeneralized
bulktraffic.Datafieldswithineachtableshouldbecarefullyreviewedandunderstoodpriortomoving
tothenextstep.Forecastdataforanewcommodityexchangedatthedocksornewvesselclasscalling
theportmustbemanuallyenteredbyselectingfromthedropdownmenusprovidedandentering
requireddata.Datatablesweredesignedsothatdatacanbeeditedasappropriatebutsomegrids
haveeditingrestrictionstoensuredataconsistencybetweenthegeneratedVCDBandtheHarborSym
project.Thefollowingprovidesnotesforeachdatatable.

DockinformationmustbeenteredthroughtheHarborSymuserinterface.Theuserisnotableto
addanewdockthroughtheBLT,removeadock,orchangethedockdepth.Ifthefuturecondition
willhaveanewdockavailablethenthelinkedIDBshouldhavethedockaddedthroughthe
HarborSymUI.

TheFleetSpecificationtableisfullyeditablebytheuser.Thisdataispopulatedbasedonthe
VCDB.Thus,dataareareflectionoftheconditionspresentinthelinkedVCDB(morethanlikely
historicalconditions).Referencestocontainershipsshouldbedeleted.Allocationprioritiesand
maximumportvisitsshouldbeupdatedtoreflectfleetcharacteristicsfortheforecastyear.Ifthe
usercreatedanewvesselclassinthelinkedIDBthatdidnotcalltheportduringhistorical
conditions,theusercanselectthevesselclassfromthedropdownmenuandenteranallocation
priorityandthemaximumnumberofportvisits.

TheCommodityForecastatDocktableisfullyeditablebytheuser.Thisdataispopulatedbased
ontheVCDB.Thus,dataareareflectionoftheconditionspresentinthelinkedVCDB(morethan
likelyhistoricalconditions).Importandexportquantities(inmetrictons)shouldbeupdatedto
reflecttheforecastyear.Referencestoanycommoditythatisforcarriedsolelybycontainerships
shouldbedeleted.IftheusercreatedanewcommoditytypeinthelinkedIDBthatwasnot
exchangedattheportduringhistoricalconditions,theusercanselectthecommoditytypefrom
thedropdownmenu,selectadockthatitishandledat,andentertheimportandexportforecast.

TheDockVesselClasstableisfullyeditablebytheuser.Thisdataispopulatedbasedonthe
VCDB.Thus,dataareareflectionoftheconditionspresentinthelinkedVCDB(morethanlikely
historicalconditions).Thisgridshouldbeupdatedtoreflectconditionsexpectedduringthe
forecastyear.Referencestocontainershipsshouldbedeleted.Iftheusercreatedanewvessel
classinthelinkedIDBthatdidnotcalltheportduringhistoricalconditions,theusercanselect
thevesselclassfromthedropdownmenuandselecttheDockitisassumedtovisit.

TheVesselClassCommodityCategorytableisfullyeditablebytheuser.Thisdataispopulated
basedontheVCDB.Thus,dataareareflectionoftheconditionspresentinthelinkedVCDB(more
thanlikelyhistoricalconditions).Alldatarequirementsshouldbeupdatedtoreflecttheforecast
year.Referencestocontainershipsshouldbedeleted.Iftheusercreatedanewvesselclass
and/ornewcommodityinthelinkedIDB,theusercanselectthevesselclassfromthedropdown
menuandselectthedockitisassumedtovisit,andentertherequiredloadingdata.

ItisnecessarythatRouteGroupsbeconsistentbetweentheBLT‐generatedVCDBandthe
HarborSymprojectIDB.TheVesselClassRouteGrouptableisthereforenoteditablebytheuser.
AnyeditsrequiredtofutureroutegroupsbyvesselclassshouldbemadetothelinkedIDB
throughtheHarborSymUI.
99 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 
ThedataintheVesselClass/CapacityFunctiontableispopulatedfromastatisticalanalysis
routineonthelinkedhistoricalVCDB.FunctionnamesareautomaticallygeneratedbytheBLT.
Referencestocontainershipvesselclassesshouldbedeleted.TheXYfieldsareeditablebythe
userandshouldbeexpandedasnecessarytocapturelargervesselsunderthewith‐project
condition(fordeepeningstudiesonly).Theusercannotaddnewrowstothegridandshoulduse
therowsavailabletochangetheXYdata,ifneeded.Becausethefunctionsaredevelopedfrom
historicaldata,afunctionwillnotbepopulatedforanynewvesselclassaddedthroughtheIDB.
TheBLTwilldrawfromvesselclassattributesspecifiedthroughtheHarborSymUItoassigna
capacityforageneratedvessel.

ThedataintheVesselClassRegressiontableispopulatedfromastatisticalanalysisroutineon
thelinkedhistoricalVCDB.Referencestocontainershipvesselclassesshouldbedeleted.Datain
thisgridarenoteditablebytheuserandnewrowscannotbeaddedtothegrid.Becausethe
functionsaredevelopedfromhistoricaldata,afunctionwillnotbepopulatedforanynewvessel
classaddedthroughtheIDB.TheBLTwilldrawfromthevesselclassattributesspecifiedthrough
theHarborSymUItoassignvesselcharacteristicsforageneratedvessel.

ThedataintheVesselClassTPIRegressiontableispopulatedfromastatisticalanalysisroutine
onthelinkedhistoricalVCDB.Referencestocontainershipvesselclassesshouldbedeleted.Data
inthisgridarenoteditablebytheuserandnewrowscannotbeaddedtothegrid.Becausethe
functionsaredevelopedfromhistoricaldata,afunctionwillnotbepopulatedforanynewvessel
classaddedthroughtheIDB.TheBLTwilldrawfromthevesselclassattributesspecifiedthrough
theHarborSymUItoassignvesselcharacteristicsforageneratedvessel.
7.1.4 Generate Synthetic Bulk Vessel Call List Afterthevesselfleetavailability,commodityforecasts,andotherpertinentforecastinputsand
parametershavebeenestablished,theBLTcanbedirectedtocreateasyntheticvesselfleetandload
thecommodityforecastonthesevessels.Theprocessusedtogenerateandloadvesselsisdescribed
inSection4.1.3.
Ultimately,thegenerationprocesswillresultinafullypopulatedvesselcalldatabase(VCDB)capable
ofsupportingaHarborSymsimulation.Topreventoverwritingtheexistingvesselcalldatabase
currentlyattachedtotheBLT,thetoolmustbedirectedtoablankdatabase.Thisisdonebyclicking
onGenerateVesselCalls,selectingaVCDBforcreationasshowninFigure75.OncetheoutputVCDBis
linked,theusercansavethisconfigurationifdesiredbyselectingFile/SaveConfigfromthemain
menu.
Figure 75: BLT‐‐Create New VCDB from Template
100 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Agenerationscenariomustbecreatedtodefinethegenerationparametersandtracktheassociated
outputs.ThisisdonebyclickingSetupScenario,asdisplayedinFigure76.Thiswilllaunchanew
window,theForecastScenariotable,withthebelowfields:

ForecastScenarioName:thenameassignedtotheforecastscenario.Specialcareshouldbe
takentoprovidealogicalnameforthescenario,asthenamewillbeincludedinalloutputfiles
generatedbythescenario;withoutareasonablenamingschematheoutputswillbedifficultto
differentiate.

ForecastScenarioDescription:providesamoredetaileddescriptionoftheforecastscenariofor
assistanceindifferentiatingoutputsandgenerateddatabases.

ForecastYear:theyeartobeassignedtocallsinthegeneratedcalllist.

Iterations:thenumberofiterationstobeprocessed.NotethattheBLThasthecapabilityto
produceamultipleiterationvesselcalldatabase.Thisnumbermustcorrespondtothenumberof
iterationsdesiredfortheHarborSymsimulationandthusthenumberofiterationsranusingthe
CLT.

WritetoVesselCallDatabase:activatingthischeckboxwillpopulatetheattachedvesselcall
database(VCDB)withthegenerateddata.Theusermaydesiretorunanumberofsimulations
withoutwritingtotheVCDBtospeeduptheprocessoftestingthedata.Oncedatainputsare
finalized,theuserwillwanttoactivatethisboxinordertogenerateaVCDBthatcanbeutilized
byHarborSym.

Seed:usedtostarttheMonteCarlosimulation;thisvalueshouldbegreaterthan0.

GenerationPeriod:numberofdaystogenerateacalllistfor,typically365.
Figure 76: BLT—Setup Scenario Aftercreatingandsavingtheforecastscenario,thisscreencanbeclosed.Thenewlycreatedscenario
willappearinthepulldownmenuunder“ScenariotoGenerate”.Thescenariocanbelaunchby
selectingitfromthepulldownmenuandactivating“GenerateVCDB”.
7.1.5 View Results Thegenerationprocess,asdescribedinSection4.1.3,attemptstoloadtheforecastedcommoditieson
theavailablevesselfleetgeneratedbasedontheuserspecifications.Thesuccessfulloadingsare
formattedintoavesselcalldatabasefullycompatiblewithHarborSym.Itisanticipatedthatthe
processofcreatingandloadingasyntheticshipmentlistwillbeiterative.Thatis,reasonably
101 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules matchingtheestimatednumberofvesselcallsbyclasswiththeforecastedcommodityimportsand
exportsmayrequiremultiplerevisionstotheinputdata.Ifresultsarenotwithinareasonablerange,
theusershouldreviewalldatainputsandassumptionsforerrorsorinconsistencies.Reviewingthe
listofgeneratedvesselspayingspecialattentiontothephysicalcharacteristicsofthevesselsisagood
startingpoint.
TheBLTmoduleprovidesrobustoutputstoidentifyunsatisfieddemandsanddemonstrateproblems
withtheuserprovidedloadingpatternsandvesselstatistics.Severaloftheseoutputsareviewable
throughtheBLTuserinterfaceandcanbeexportedtoacsvorhtmlfileandsaved,including:

Allocations:adescription,bycommodityanddock,oftheimport/exportforecasts,quantityof
import/exportdemandsatisfied,quantityofimport/exportdemandunsatisfied,andnumberof
vesselcalls.

GeneratedVessels:alistingofalluniquevesselsgenerated,includingtheassignedphysical
characteristicsofLOA,beam,capacity,TPIfactor,anddesigndraft.

GeneratedCalls:thevesselcalllistgeneratedtosatisfytheforecastedcommoditydemands,
includingthevesselname,arrivaldateandtime,arrivaldraft,routegroupassignment,dock
visited,commoditiestransferred,andETTC(estimateoftotaltripcargo).Usersshouldbeaware
thatETTCispopulatedbytheBLTinamannerthatwillalwaysproduce100%allocationofat‐
seasailingcoststothesubjectport.Iftheuserhasinformationthatthevesselarrivesatthe
subjectportwithcargothatisdestinedforanotherport,theETTCfieldmustbemanually
adjustedupwardaccordingly.SeeSection3.3.1forcompletedetailsonhowtheETTCfieldisused
inHarborSym.
Additionaldetailedoutputsareproducedduringthegenerationandarestoredinthesamelocationas
theforecastdatabase(FCDB).TheusermayalsoviewthegeneratedVCDBusingMicrosoftAccessor
theHarborSymuserinterface(select‘PortTraffic’inthetreenodeoncetheVCDBhasbeenattachedto
aHarborSymproject).
7.2 Create Synthetic Containership Vessel Call List Using Container Loading Tool TheCLTwasdevelopedtoassistusersingeneratinga
syntheticfuturevesselcalllistforcontainershipvessels.The
CLTislaunchedfromtheHarborSymToolsmenu,asshown Figure 77: Launch Container Loading Tool inFigure77.Thefollowingsectionsoutlinethestepsto
createasyntheticcalllistforcontainerizedvesseltraffic
usingtheCLT.Theendresultoftheprocesswillbeafully
populatedVCDBthatcanbeuseddirectlybyHarborSym.
TheCLT‐generatedVCDBmustbecombinedwiththeBLT‐
generatedVCDBusingtheCombinermoduleifnon‐
containerizedtrafficismodeledintheanalysis.
Figure 78: Set CLT Template Directory
102 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.2.1 Set Template and Save Directories UponfirstusingtheCLT,orifanewinstallforHarborSymhasbeenprovided,theuserwillneedtoset
thetemplatedirectoryforcreatingblankCFCDBsandVCDBs.ThisisdonebyselectingOptions/Set
TemplateDirectoryfromthemainmenu,asshowninFigure78.Adialogwillopentospecificthe
locationoftheHarborSymtemplatesinstalledwiththesoftware.Thiswillbelocatedinthedirectory
wheretheprogramfileswereinstalled.SeeSection2.3forthelocationoftheTemplateDirectory.
ThroughtheOptionsmenu,theusercanalsospecifyadirectorywhereCSVexportsaresaved.Ifthis
directoryisnotspecified,theCSVfileexportsaresavedtoatemporarydirectory,asspecifiedin
Section2.3.
7.2.2 Set Working Files AsingleHarborSymstudyiscomposedof
severaldistinctMicrosoft®Accessdatabases.
Beforegeneratingsyntheticcalllists,usersmust
firstattachtheCLTmoduletotheappropriate
master,input,vesselcall,forecast,and
geographydatabases.Table1(page6)describes
thedifferentinformationcontainedineach
database.Figure79showstheCLTscreen
wheredatabasesarespecified.Established
databasescanbelinkedbyeitherselectingthe
boxnexttothedatabaseorthroughtheFile
menu.TheFilemenuhasadditionaloptionssuch Figure 79: Attach CLT Databases asCopyExistingandCreatefromTemplate.
TheMasterdatabaselinkstogetherallrelevant
informationneededforCLTgenerations.Thisdatabaselocationshouldbespecifiedfirstpriorto
specifyingtheadditionaldatabases.SeeSection2.3forthelocationoftheCLTreferencedatabases.
Thefileisnamed‘CLTGeneratorMaster.mdb’.IftheuserresetsthelinktotheMasterdatabase,linksto
theremainingdatabaseswillbebrokenandwillneedtobereestablished.
TheIDB,orinputdatabase,describesprojectlayout,includingthedocks,vesseltypes,vesselclasses,
commoditycategories,androutegroups.ItisimportanttoattachtheCLTmoduletothecorrectinput
databaseasthisdatabasedefinesthevesselandcommodityclassificationsthatprovidethebasisfora
syntheticallygeneratedcalllist.Typically,theIDBspecifiedherewillbetheHarborSymIDB
correspondingtothefutureprojectforwhichtheCLTisbeingusedtogenerateasyntheticVCDB.
TheVCDB,orvesselcalldatabase,documentstheuniquevesselsthatcalltheport,andallthecallsand
commoditytransfersmadebythesevessels.TheCLTvesselcalldatabasegenerationprocessvaries
fromtheBLTprocessinthattheuserwilldirecttheCLTtocreateaVCDBfromtemplateratherthan
startingwithanexistingconditionVCDB.Thatis,theVCDBspecifiedinthisstepistheVCDBthat
willbetheoutputoftheCLTgenerationprocess.Thetemplatedirectorymustbesetpriorto
creatingtheVCDBfromtemplate.ThiscanbeachievedthroughtheOptions/SetTemplateDirectory
menuasdescribedabove.
ThenextdatabasethatmustbespecifiedistheCFCDB,orcontainershipforecastdatabase.This
databasestoresinformationaboutcommodityforecastsatdocks,thecontainerfleetspecification,
103 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules parametersettings,seasons,dockparametersandvesselclassspecifications,services,regions,route
groups,arrivaldraftfunctions,andvesselsubclasses.Initially,ablankCFCDBshouldbeattachedto
theCLT.Thiscanbedonebyselecting“CreatefromTemplate”fromtheFilemenu.Followthe
promptstoprovideafilenameandsavelocationforthenewCFCDB.Again,thetemplatedirectory
mustbespecifiedpriortocreatingtheCFCDBfromtemplate.
Finally,theGeographydatabasemustbespecified.Thisdatabasestoresrelationalinformationabout
portsandregions.Thisdatabase,inandofitself,doesnotcontainanystudy‐specificcontent.See
Section2.3forthelocationoftheCLTreferencedatabases.
7.2.3 Review IDB and Geography Databases ToassurethatthecorrectIDBhasbeenselected,theusershouldreviewthedatatablesavailablein
theIDBthroughtheViewTables/IDBmenuoption,asshowninFigure81.
NoticethattheDockLimitingDepth
tablenameisinbold.Thisistodraw
attentiontothefactthatonlythistable
iseditablethroughtheCLTuser
interface.Note:Foranytable
launchedthroughtheViewTables
menu,fieldshighlightedinblueare
editable.InadditiontoDockdepth,
theusershouldreviewalldata
Figure 81: Review IDB Tables Through CLT Menu providedinthesetablestoensure
consistencyintheCFCDBandthus
CLT‐generatedVCDBandthe
HarborSymIDBthatwillbelaterbelinked
inHarborSymtorunaporttraffic
simulation.
Atthistimetheusershouldbecomeaware
oftheregionassumptionsinherentinthe
CLT’sGeographydatabase.Whilethe
Regiontableiscurrentlyeditablebythe
user,itisnotrecommendedthatRegions
withinthistablebeedited.TheRegions
listedinthistableareconsistentwiththe
regionsspecifiedintheA‐DAPPtool.
7.2.4 Populate CFCDB with Data TheCLTrequiresextensivedatato
generateacontainershipsyntheticfuture
vesselcalldatabase.Thetablesinthe
CFCDBshouldbecompletedinaspecific
order.Thefollowingsubsectionsprovide
anoverviewofthedatarequiredinthe
CFCDB.Ingeneral,thesestepsshouldbe
completedintheorderinwhichthe
104 Figure 80: Edit CFCDB Tables through CLT Menu Section 7  Generating a Synthetic Vessel Call List Using Loading Modules informationispresented.Astheuserbecomesfamiliarwiththetoolandthedatarequirements,the
stepstoenterdatashouldbecomemoreapparent.
ThegeneralorderforenteringdataintotheCFCDBis:Seasons,DockParameters,DockVessel
Class,Service,Region‐Service,RouteGroup‐Service,ArrivalDraftFunction,ArrivalDraftFunction
Detail,Service‐VesselClass,VesselSubclass,ContainerFleetSpecification,CommodityForecastat
Dock,andCLTParameterSettings.CFCDBdataareenteredthroughdatagridsaccessiblethroughthe
ViewTables/CFCDBmenuoption,asshowninFigure80.
NotethatalltablesintheCFCDBhaveafieldinthefirstcolumnpositionthatprovidesaunique
identifierfortheeachrecordinthetable.Anycolumnthatiscoloredwhiteisready‐only.Columns
coloredblueareeditablebytheuser.AlltablesaccessiblethroughtheViewTablesmenucanbe
exportedtoaCSVfilebyselectingthe‘CSV’buttonintheupper‐righthandofthetableinterface.Files
willbesavedtoeitheratemporarydirectoryortothedirectoryspecifiedthroughtheOptionsmenu,
seeSection7.2.1.
7.2.4.1 Seasons TheCLTallowstheusertodividecommodityforecastsandvesselavailabilityintoseasons.This
allowsthesyntheticvesselcalllisttoaccountforpotentialseasonaldemands,suchasincreasedtoy
shipmentsfromChinainpreparationfortheChristmasbuyingseason.Seasonsareuser‐definedand
mustcovertheentireyear.Theusercanspecifyasmanyseasonsasnecessarytocaptureunique
shippingpatternsinherentattheportofstudy.Eachseasonisspecifiedbyastartmonthanddayand
anendmonthandday,asshowninFigure82.
Figure 82: CLT CFCDB Seasons Table 7.2.4.2 Dock Parameters Throughthisdatagrid,theusercanspecifythetidalavailabilityforeachdockinfeet.TheCLTwilluse
thisdatatoconstrainhowdeeplydraftedthecontainershipcanarriveandleavetheportofstudy.
Notethatthereisnodurationassociatedwiththisvalue,itisassumedthattheadditionaltidalvalue
canbeusedbythevesselinreachingthedock.Thistablecanautomaticallybeexpandedbyselecting
Tools/ExpandDockParametersTablefromthemenuoptions.AlldockswithintheIDBwillbeadded
tothetablewith“0”specifiedastheavailabletide.Thisvalueshouldbeupdatedwiththeappropriate
tideavailable.
105 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.2.4.3 Dock Vessel Class Thistableidentifiesthevesselclassesthatcanuseaparticulardock,andthusareavailabletosatisfy
forecastsatthatdock.SelectaDockIDfromthedropdownmenuandthenspecifyaVesselClassthat
canservicethedock,asshowninFigure83.
Figure 83: CLT CFCDB Dock‐Vessel Class
7.2.4.4 Service TheconceptofaServiceplaysanimportantrolewithintheCLT.Aserviceisaregularvesseltransit
acrossasetofregions.ItisNOTdefinedattheportlevel.Withinthegeographichierarchyinthe
Geographydatabase,aportlieswithinacountry,andacountryfallswithinaregion.Servicesare
user‐definedwithintheCLT,andstoredintheCFCDB.ServiceinformationisavailablefromtheIWR‐
developedA‐DAPP.Servicesmustbegivenanameanddescription,asshowninFigure84.Thenames
anddescriptionsshownintheexamplewereprovideddirectlyfromtheA‐DAPP.TheA‐DAPPnames
servicesaccordingtotheregionsvisitedalongtheservice.EachletterintheServiceName
correspondstoaRegionfoundintheGeographydatabase.Maintainingthisnamingconventionwill
simplifydataentryinothertablesassociatedwithregions.
106 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Figure 84: CLT CFCDB Service
7.2.4.5 Region‐Service Theregion‐servicetableidentifiestheregionsthatarevisitedbyaparticularservice,asshownin
Figure85.Theorderinhowitisenteredintothetableisnotimportant.ThistableallowstheCLTto
identifyalloftheservicesthatcanbeusedtosatisfyaparticularforecastforagivenregion.Firstthe
userwillselectaServiceIDfromadropdownmenuandthenselectaRegionIDthatcorrespondsto
service.Allregionsvisitedwithinaserviceshouldbespecifiedinthematrix.Intheexampleprovided
inFigure85,theService‘ck’visitstworegions(notablefromthetwocharacterlengthofthename),
U.S.EastCoastandMediterranean.
Notethattheregioncontainingtheportofstudywillonlyneedtobespecifiedforaserviceifthat
regionhasanimport/exportforecastfromtheportofstudy.Forexample,iftheportofstudy
“ExampleHarbor”islocatedalongtheU.S.EastCoast,theU.S.EastCoastwillonlyneedtobespecified
asaregionvisitedbytheserviceifthereisanimportcomingfromorexportgoingtoadifferentport
alsolocatedwithintheU.S.EastCoastregion.
Figure 85: CLT CFCDB Region‐Service
107 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.2.4.6 Route Group‐Service TheGeographyhierarchyhasroutegroupsasasubsetofservices.Thatis,aservice,whichisdefined
attheregiontoregionlevel,canhavemanyroutegroups,whicharedefinedattheabstractportto
abstractportlevel.TheRouteGroup–Serviceassignmenttableassociatesroutegroupswithservices,
anddefinesanumericalvalueindicatinghowmanycallsassignedtotheserviceshouldbeassignedto
thespecificroutegroup,asshowninFigure86.Asanexample,25percentshouldbeenteredas“25”.
ThePercentageAssignmentfieldwillacceptdecimalvaluesbutnotethatthepercentageassignment
ofroutegroupsshouldaddupto100foreachservice.Thisisnotcurrentlycheckedbytheuser
interfaceGenerate/Checkfunctionsotheusershouldensurethesummation.Topopulatethetable,
theuserfirstselectstheServicefromthedrop‐downmenu,thenanassociatedRouteGroupfromthe
dropdownmenu,andfinallyspecifiesthepercentage.
Figure 86: CLT CFCDB Route Group ‐ Service
7.2.4.7 Arrival Draft Function WithintheCLTcontext,theusermayeitherspecifyaminimum/maximumarrivaldraftforavessel
classonagivenservice,inwhichcasethegenerationprocessselectsrandomlybetweenthetwo
valuestoassignarrivaldrafttoavessel,ortheusermayspecifyacumulativedistributionfunction
(CDF)ofarrivaldrafts,inwhichcasethegenerationprocessusestheCDFtorandomlyassignthe
arrivaldraft.IftheCDFoptionisdesired,theuserfirstspecifiestheCDFfunctionnamesthroughthe
ArrivalDraftFunctiontable,asshowninFigure87.TheusermayhaveasingleCDFfunctionsforall
containershipsorwishtospecifyCDFfunctionsforeachcontainershipclass.Ineithercase,theuser
mustalsospecifytheminimum/maximumarrivaldraftintheService‐VesselClassgrid.Thesevalues
areusedasadatacheckduringtheCDFdrawprocess.
Figure 87: CLT CFCDB Arrival Draft Function When Utilizing CDF Functions for Vessels 108 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Iftheuserwishestospecifytheminimum/maximumvaluesforarrivaldraftofthesyntheticvessel
fleet,thenaNULLfunctionshouldbecreatedintheArrivalDraftFunctiontable,asshowninFigure
88.NotethattheFunctionNamemustbeexactlyasshown,“NULL”.Afunctiondescriptioncanbe
providedifdesired.
Figure 88: CLT CFCDB Arrival Draft Function When Utilizing Min/Max Arrival Draft for Vessels 7.2.4.8 Arrival Draft Function Detail Throughthisdatagrid,asshowninFigure89,theuserspecifiestheCDFdatapoints(X,Y)forvessel
arrivaldrafts.TheXvaluerepresentsthearrivaldraftandtheYvaluerepresentsthecumulative
probabilityofvesselarrivingatthatdraft.Datacanbeenteredintothisgridintwoways.First,
Tools/ExpandFunctionTablecanbeselectedfromthemenuoptions.Whenthisisselected,theCLT
willautomaticallyprovide20X,YdataentriesforeachfunctiondescriptionprovidedintheArrival
DraftFunctiontable.EachXvaluewillautomaticallybesetat“0”andeachX,Ypairshouldbeupdated
bytheuser.Alternatively,theusercanmanuallyselectthefunctiondescriptionfromthedropdown
menuandinputeachX,Ypair.CDFdataoncontainershiparrivaldraftforagivenportareavailable
fromtheA‐DAPP.NotethattheCDFfunctionsshouldbeexpandedinthewith‐projectanalysisto
reflectthevesselsdraftingaccordingtothedeepenedchanneldepth.NoCDFfunctiondetails
needbeprovidediftheuserdesirestousetheminimum/maximumarrivaldraft.
Figure 89: CLT CFCDB Arrival Draft Function Detail When Utilizing CDF Functions for Vessels 7.2.4.9 Service‐Vessel Class Theconceptthatdifferentservicesandvesselclasseshavedifferentcontainerloadingcharacteristics
isbasictotheCLT,inparticulartheloadingfactoranalysis(LFA)anddeterminationofvesselarrival
drafts.ThisinformationiscapturedintheService‐VesselClasstable.Threebasictypesofinformation
109 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules arestored:1)informationforuseindeterminationofarrivaldraft;2)informationforuseinthe
loadinganalysis;and3)informationforuseindeterminingthefractionofthevesselloadonarrival
Figure 90: CLT CFCDB Service – Vessel Class thatisimported/exportedtothesubjectport.Thedatagridcanbeinitiallyexpandedtoprovidearow
foreachServiceIDandVesselClassIDbyselectingTools/ExpandServiceVesselClassTablefromthe
mainmenu.Otherwise,theusermaymanuallypopulatethedatagridbyselectingaServiceIDand
associatedVesselClassIDfromthedropdownmenusprovidedinthecellsofthesefields.Anexample
Service‐VesselClasstableisprovidedinFigure90.
AgreatdealofdatamustbeenteredintotheService‐VesselClasstable.Eachdatafieldrequirement
forvesselclassbyserviceisdescribedinTable5.AnalystshouldcontacttheDeepDraftNavigation
CenterofExpertise(DDNPCX)orIWRfordataregardingEmptyTEUAllotment,VacantSlotAllotment,
AllowanceforOps,andVariableBallast.
Table 5: CLT CFCDB Service ‐ Vessel Class Table Field Descriptions FIELD DESCRIPTION AverageLadingWeightPerLoadedTEU Average commodity weight per loaded TEU in metric tons; data available from W‐DAPP Average weight of the TEU container when empty in metric tons AverageContainerWeightPerTEU Number of empty TEUs allotted
EmptyTEUAllotment Number of vacant slots allotted
VacantSlotAllotment AllowanceForOperations VariableBallast MinimumArrivalDraft MaximumArrivalDraft 110 Allowance for operations typically varies by vessel size. Allowance for operations represents tonnage used for bunkerage (fuel) and ships stores. The unit is a user‐
specified percentage of the available dead weight tonnage at the vessel arrival draft (e.g., enter 15 percent as 15). Variable ballast is the substance placed in the hold of a ship to enhance stability. The unit is a user‐specified percentage of the available dead weight tonnage at the vessel arrival draft (e.g., enter 15 percent as 15). Represents the minimum draft of vessels when arriving at the port. If the CDF
function is utilized, then minimum arrival draft values should be the lower bound of the CDF values Represents the maximum draft of vessels when arriving at the port. If the CDF
function is utilized, then maximum arrival draft values should be the upper bound of the CDF values Section 7  Generating a Synthetic Vessel Call List Using Loading Modules FIELD DESCRIPTION FunctionDescriptionID ImportFractionDistributionParameterP1 Select the CDF function from the drop down list for the Service/Vessel Class combination; if only the minimum/maximum arrival draft values are utilized and no CDF function is available, then the CDF function “NULL” should be selected (NULL created through the Arrival Draft Function grid) Fraction of total imported tons to ship capacity, minimum value (example: 250/1000 (or 25%) as 0.25) ImportFractionDistributionParameterP2 Fraction of total imported tons to ship capacity, most likely value ((example: 250/1000 (or 25%) as 0.25) ImportFractionDistributionParameterP3 Fraction of total imported tons to ship capacity, maximum value (example: 250/1000 (or 25%) as 0.25) ExportFractionDistributionParameterP1 Fraction of total exported tons to ship capacity, minimum value (example: 250/1000 (or 25%) as 0.25) ExportFractionDistributionParameterP2 Fraction of total exported tons to ship capacity, most likely value (example: 250/1000 (or 25%) as 0.25) ExportFractionDistributionParameterP3 Fraction of total exported tons to ship capacity, maximum value (example: 250/1000 (or 25%) as 0.25) 7.2.4.10 Vessel Subclass WithintheCLTprocess,avesselcalliscreatedbasedonavesselclass.Specificvesselcharacteristics
aredeterminedbychoosingavesselfromthevesselsubclasstable.Thesubclasstableprovides
standardvesseldataforsetsofvesselswithinagivenvesselclass.Thisinformationhasbeendefined
byIWRforcontainerships,with45distinctsubclassesfor4vesselclasses(SubPanamax,Panamax,
PostPanamaxGen1,andPostPanamaxGen2),andshouldnotbechangedbytheuser.Theproportional
assignmentofvesselsubclassestoaclassisauser‐enteredparameter.Theonlyfieldthatshouldbe
editedbytheuseristhepercentageofsubclassassignmenttothevesselclass(enter25%as25).The
totalpercentagewithinaclassshouldsumto100.
Table 6: CLT Vessel Subclass Field Definitions HEADING DESCRIPTION VesselSubClassID Automatically generated unique identifier
VesselClassID Drop down menu options to select the Vessel Class that corresponds to the Vessel SubClass description VesselSubClassDesignator Automatically generated value
VesselSubClassDescription CLT‐provided vessel sub‐class description, standardized by IWR LOA Length overall in feet
LBP Length between perpendiculars in feet
Beam Beam in feet
MaximumSLLD Maximum summer loadline draught
Capacity Vessel capacity in DWT
AppliedDraftClass Draft range for subclass in feet
TEURating Twenty‐foot equivalent unit rating for vessel subclass
TPIFactor Tons per inch immersion factor for vessel subclass
BaselineUnderkeelClearance Underkeel clearance in feet
SinkageAdjustment Adjustment for sinkage in feet
PercentageOfClass User defined percentage of vessel subclass to vessel class
111 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.2.4.11 Container Fleet Specification Afleetspecificationisdefinedasamaximumnumberofportvisitswithinagivenseasonofavesselof
agivenclass,operatingonaparticularservice,asshowninFigure91.Aspecificationessentiallysays:
“Inthefirst6monthsoftheyear,thereare45availablecallsofPanamaxvesselsoperatingontheEast
CoastUS–MediterraneanPendulumservice”.Anallocationpriorityisassignedtoindividualfleet
specifications,andtheCLTobservesthesepriorities,attemptingtofillaforecastbyusingvesselsfrom
thefleetwiththehighestallocationprioritybeforeusingvesselsofalowerpriority.Notethatthe
highestallocationpriorityis1,thelargerthenumber,thelowerthepriority.
Figure 91: CLT Container Fleet Specification
7.2.4.12 Commodity Forecast at Dock Forecastsaredefinedatthecommodity,dock,season,andregionlevel,asimportandexport
quantitiesinmetrictonsasshowninFigure92.Aforecastnameshouldbeprovided(e.g.“FC1”)for
useinreferencingoutputtoaparticularforecast.Inadditiontotheexpectedimportandexport
quantity,standarddeviations(alsoinmetrictons)shouldbeprovidedforeachforecastunit
combination.Standarddeviationsfortheimport/exportforecastareusedbytheCLTtoselectan
import/exportquantityduringtheMonteCarlosimulation.
Figure 92: CLT Commodity Forecasts by Dock and Region
112 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules 7.2.4.13 CLT Parameter Settings Thistableisdesignedtostore,inatag‐valueformat,informationforthesimulation.Thetag‐value
formatiseasilyextendedasnewport‐widevaluesareincorporatedintheCLTalgorithms.Atpresent,
theonlyvalueinthistableisforaport‐widesealevelchangevalue.Sealevelchangeisapplied
uniformlytoalldockswithintheport.IftheuserwishestoutilizethesealevelparameterintheCLT,
pleasetakecarethattheRouteGrouppriorandnextportlimitingdepthreflectsthesealevelchange
aswell.
7.2.5 Specify and Set Scenario OncealldatahavebeenenteredintotheCFCDB,theusershouldspecifythescenarioparameters
throughtheScenarioForm,accessedthroughtheGenerate/ScenarioFormmenuoptionortheQuick
AccessBar.TheScenarioForm,showninFigure93,allowstheusertospecifyaname,theforecast
year,thenumberofiterationsdesired,andaseednumber.Theusershouldsetthe
“WriteToVesselCallDatabase”fieldtoTrueifaVCDBgenerationisdesired.Theusermaywanttotest
dataassumptionspriortogeneratingaVCDB.The“DebugFlag”fieldisforCLTdeveloperuseand
shouldbesettoFalseundernormalcircumstances.Notethatthenumberofiterationsmustbe
compatiblewiththenumberofiterationsranintheBLTandthenumberdesiredintheHarborSym
study.
Figure 93: CLT Scenario Form Oncethedesiredscenarioisspecified,theusershouldsetthescenarioforgenerationthroughthe
menuoptionGenerate/SetScenario/SetForecastScenario.BecertaintoclickSaveafterselectingthe
desiredscenario.
7.2.6 Data Check AsmallnumberofdatacheckshavebeenimplementedthroughtheCLTuserinterface.Thisoptionis
availablefromthemenuoptionGenerate/Check.Anyissuesidentifiedthroughthedatacheckshould
beresolvedpriortogeneratingaVCDB.
7.2.7 Generate VCDB OncealldatahavebeenenteredintotheCFCDB,thescenarioparametershavebeendefined,andthe
datacheckreturnsnoerrors,theusercangenerateacontainershipvesselcallforecast.Selectingthe
Generatebuttonfromtheuserinterfacewillbegintheprocess.Duringeachseason,thesatisfactionof
eachforecastandthefleetutilizationisshowngraphically.Eachindividualgraphcanbemanipulated
(zoom/pan)andtheimagesaved,byright‐clickingonthegraphtogetacontextmenu.Feedbackis
113 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules providedregardingwhatiterationandwhatstagewithintheiterationtheCLTiscurrentlyprocessing.
ThegraphicdisplaymaybeturnedoffthroughtheOption/SetOptionsmenu.
GenerationofacompleteandbalancedVCDBforcontainershipsmayrequiremultiplegenerationsand
dataadjustments.Resultsshouldbereviewedtotestforecastassumptionsandadjustmentsmadeas
needed.NotethattheCLTwillnotprocessaVCDBifanydataerrorsarepresentintheCFCDB.Ifthe
generatordoesnotprocess,returntotheCFCDBtablesandreviewalldata.
7.2.8 View Results OncetheCLThasfinishedprocessingtheloadingsimulation,anumberofoutputfilesareavailablefor
theuser.

PRNFile:Thisfileislightlypopulated.Itwilleventuallycontainsummaryinformationforthe
scenariorunonfleetspecificationusageandforecastsatisfaction.

ECHfile(echo):Thisfileisintendedtoprovidearecordofinputdatareadfromthedatabase.It
isonlypartiallypopulatedatthistime.

DBGfile(debug):Thedebugfileprovidesinformationforanalyzingthecontainerloading
process.Itisintendedprimarilyfordevelopers,notendusers.

GeneratedVCDB:ThefundamentalgoaloftheCLTistogenerateaVCDBthatreflectsthe
specifiedfleetavailability,forecasts,anddepthconstraints.ThegeneratedVCDBcanberun
throughaHarborSymsimulationtoestimatecongestioneffectsandcostallocationtothesubject
port.

OutputTablesintheCFCDB:TheCLTwritesthreetablesintotheCFCDB.Eachofthesetablescan
beviewedfromtheinterimUI,inthestandarddatagridformat:
- Allocationresultsgivingtheexportandimportdeficitsbyforecast,togetherwiththenumber
ofuniquevesselsusedtosatisfyeachforecast.
- Fleetusagespecificationresults,showingthemaximumprovidedportvisits,andthevisits
usedbytheallocationprocess.

PNGfileswiththeseasonalfleetusageandforecastsatisfactiongraphicsthatdisplayduring
VCDBgeneration.
Commoditytransferresults,providingimport/exportinformationforeachforecastspecifiedbyeach
vessel.Notetheshadedrowswhereasingle
vesselissatisfyingtwodifferentforecasts.
7.3 Combine VCDBs GiventhenatureoftheHarborSymdatabase
structure,theBLTandCLT‐generatedvessel
calllistsmustbecombinedintoasingle
vesselcalllistforcaseswherebothtypesof
trafficaretobemodeled.TheCombiner
modulewasdevelopedtoaddressthisneed.
Figure 94: Combine VCDBS
114 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules TheCombinerisquitesimpletouse.TheuserspecifiestheIDBthatcorrespondstotheVCDBsthatare
tobecombined.ThisshouldbetheHarborSymIDBforthegivenyearandwithorwithoutproject
status.TheuserthenspecifiestheBLT‐generatedVCDBandCLT‐generatedVCDBundereitherVCDB
1orVCDB2,showninFigure94.WhentheuserselectstheOutputVCDB,adialogboxwillappear
allowingtheusertospecifyadirectoryandnameforthecombinedVCDB.Oncealldatabasesareset,
theusercanperformadatacheckusingthemainmenuoption.Anynoteddiscrepanciesshouldbe
resolvedpriortocombiningtheVCDBs.TheusermergestheVCDBsintoasingledatabasebyselecting
themenuoptionCombine.
TheusermustbecertainthetwoVCDBsselectedhaveanequalnumberofiterations.Oncethe
generationiscomplete,thecombinedVCDBshouldbelinkedtotheproperHarborSymproject
throughtheFile/StudyManagermenuoption.SeeSection6.1.3,fordetailsonhowthisis
accomplished.
115 Section 7  Generating a Synthetic Vessel Call List Using Loading Modules Thispageintentionallyleftblank.
116 Section 8 Simulation Settings, Run Parameters, and Scenarios HarborSymestimatestransportationcostsbysimulatingvesselmovementsthroughtheharborbased
onuserspecifiedparameters.Theportconditionsarespecifiedbydefiningprojects.Thetimingand
conditionsofthesimulationsaredefinedbytheuserthroughtherunparameters.Runparametersare
storedwithinHarborSyminscenarios.
Harborimprovementprojectstypicallyareintendedtoimprovetransportationefficiencybylowering
vesseltransittimes.Harborimprovementscanalsoresultintransportationefficiencygainsby
allowingvesselstocarrymorecargointotheharbor.InHarborSym,anewprojectiscreatedto
representtheharborwithimprovements.Thenewprojectcanbeclonedfromtheoriginalproject
afterthenodenetworkfortheoriginalprojectiscompleted.Theoriginalprojectandallalternative
projectsarestoredwithinthesameHarborSymstudy.
Asimulationofvesseltrafficwithinaharborislaunchedusingascenario.Ascenarioisthetermused
todescribeaparticularcombinationofdatasetsandsimulationparametersselectedbythe
HarborSymuser.Ascenariodescribesthe“RunParameters”ofthesimulation.Duringasimulation,
thevesseltrafficisroutedthroughthenodenetworkbaseduponhistoricalorsyntheticallygenerated
vesseltrafficfortheperiodoftimedefinedinthescenario.InHarborSym,vesselsarriveattheharbor
knowingtheirintendeddocksandcommoditytransfers,butwithlimitedknowledgeoftheharbor
conditions.A“harborsupervisor”actingwithinthesimulationhascompleteknowledgeofall
scheduledmovementswithintheharborandapprovestravelthroughlegsbaseduponharbor
conditions,rules,andtraffic.Vesseltrafficisroutedthroughlegsbaseduponthefirstarrivalhaving
priority,withexceptionsforprotocolvessels.
8.1 Simulation Setting TheHarborSymuserhastheoptiontosetseveralparameterstorefinethesimulationprocessing,as
displayedinTable7.ThesefieldsareaccessedthroughtheConfigurationSettingswindowunderthe
Simulationtab(Section5.1.2providesinformationonwheretoaccesstheConfigurationSettings
window).
117 108 Table 7: Simulation Settings Fields Field Description Value Vessel Draft Limit_Tidal Time Interval The controlling depth for a leg is based on available depth in the reaches of the leg, as adjusted by tide, and is used in setting the outbound draft on dock departure. The period over which the tide availability is calculated is the period from the departure time to the departure time plus the tidal time interval. Vessels that cannot pass within this time frame are subject to deletion (See Section 3.2.14, Tide and Section 9.3, Deleted Vessels) Factor for determining the tide usage in a reach. When determining the controlling depth for a reach, this parameter is used to add the associated fraction of the available tide range for the reach to the minimum available tide for the reach. Number in hours (72 hours is default value)
Vessel Draft Limit_Tidal Range Parameter Vessel Leg Wait Limit_Count Number of leg entry retries before a vessel is removed from system; a low value may delete vessels prematurely while a high value may slow simulation processing (See Section 3.2.11 and Appendix B, Transit Rules and Section 9.3, Deleted Vessels). Output Window Iteration Begin HarborSym allows for the recording of detailed information on all iterations within the user defined range when the time step output is enabled. This allows for selective detailed examination of a portion of the simulation. This field sets the first iteration to begin detailed output reporting written to tblTimeStepOutput in the .SODA file. Output Window Iteration End This field sets the last iteration to begin detailed output reporting written to tblTimeStepOutput in the .SODA file. Output Window Duration Begin HarborSym allows for the recording of detailed information on all iterations within the user defined range when the time step output is enabled. This allows for selective detailed examination of a portion of the simulation. This field sets the time within an iteration to begin detailed output reporting written to tblTimeStepOutput in the .SODA file. Output Window Duration End This field sets time within a simulation to end detailed output reporting written to tblTimeStepOutput in the .SODA file. Feet Per Coordinate Unit This value is used for plotting of safety zone boundaries. Node coordinates may or may not be in feet. The within‐simulation visualization is plotted based on node coordinates. Safety zone distances are in feet, so, if node coordinates are not in feet, this conversion is required to allow for drawing of the safety zone boundary around a vessel. Time Waiting At Entry Cost Threshold value for determining if at sea or in port vessel operating costs should be applied based on Threshold vessel waiting time at entry point. (See Section 3.2.5) Time Waiting At Facility Node Cost Threshold Time Waiting At Dock Cost Threshold Hours Added to Protocol Simulation 118 0 use minimum value of tide for each reach
1.0 use maximum value of tide for each reach Intermediate value linearly interpolated between minimum and maximum (0.75 is default value) Default value is 50
Default value of (‐1) begins recording at the first iteration.
Default value of 10000000 Default value of (‐1) begins recording at the beginning of the simulation. Default value of 10000000
Default value is 1, indicating node coordinates are in feet.
If entry wait time < threshold value, apply sea costs
Otherwise, apply port costs (2 hours is default value) Threshold value for determining if at sea or in port vessel operating costs should be applied based on If anchorage wait time < threshold value, apply sea costs
vessel waiting time at anchorage. (See Section 3.2.5) Otherwise, apply port costs (2 hours is default value) Threshold value for determining vessel operating costs while vessels wait at the dock. If dock wait If dock wait time > threshold value, apply sea costs, with the port time > threshold, apply threshold time at sea cost, remainder at port cost, otherwise all sea cost. costs applied to the remaining time (See Section 3.2.5) Otherwise, apply all sea costs (1 hours is default value) Time, in hours, to extend the priority vessels run beyond the simulation duration to ensure all Number in hours (50 hours is default value)
priority vessels are maintained in the full call list simulation. (See Section 3.2.5) Section 8  Simulation Settings, Run Parameters, and Scenarios 8.2 Creating Simulation Scenarios Ascenarioisanamedcombinationofsimulationrunparameters.Vesseltrafficissimulatedina
harborusingnavigationconditionsdescribedbytheprojectandinthescenariodefinedbytheuser.
Oncethesimulationprocesshasbeenlaunched,theparametersspecifiedinthescenarioareretrieved
tosimulatetrafficbehaviorintheharbor.Completionofasimulationyieldsmanystatisticalresults
thatcanbecomparedtoothersimulations.
Asimulationconsistsofoneormoreiterations.Theusersetsastartdateandsimulationduration
thatwillapplytoalliterations.Foreachiteration,HarborSymtractsthevesseltrafficenteringand
exitingeachreachinaharborandmaintainsvesseltrafficstatistics.Thevesseltrafficstatisticsare
availableforeachiterationintheoutputfiles.Additionaliterationsofasimulationcanincreasethe
accuracyofoutput,butrequiremoreprocessingtime.Therefore,theHarborSymusermustbalance
accuracywithprocessingtimewhendeterminingthenumberofiterationsinascenario.The
processingtimeforsimulationsisalsoimpactedbythedurationoftheiterations,thesizeofthevessel
calllistfortheharbor,andtheamountofsystemcongestion.NotethatwhenusingtheBLTandCLTto
developafuturesyntheticvesselcalllist,thenumberofiterationsspecifiedinthesetoolsmust
correspondwiththeHarborSymscenario.
8.2.1 Creating Simulation Scenarios TheScenariosbranchintheNavigationPaneisusedtoobtaintheScenarioDefinitiondataentrygrid.
Anameanddescriptionforthescenariomustbeenteredwithinthedataentrygrid,e.g.,InitialTest,All
Data,andNoRules.YournamedscenariowillappearintheNavigationPaneandcanbeselectedto
accessaform‐viewofyourdefinedrunparameters.Apop‐upwindowwillappeartopopulatethe
nameofthefirstscenario.Thefollowinginputboxesallowtheusertodefineasimulationscenario.
Thescenarioisthecollectionofrunparametersofthesimulation,definedintheScenarioEditor,
showninFigure95.
Figure 95: Scenario Editor Window in the Data Entry Pane
119 Section 8  Simulation Settings, Run Parameters, and Scenarios ThefieldsintheScenarioEditorinclude:
ScenarioName
Eachscenarioshouldbenamed. Thescenariowillthenbeavailabletorecall
ontheNavigationPane.
Description
Thisblockallowsascenariodescriptionthatisincludedinoutputreports.
Iterations
Theuserdeterminesnumberofiterationsrunduringthesimulation.Note
thatthisnumbermustcorrespondwiththeCLTand/orBLTgenerated
vesselcalldatabase.
Duration
Thelengthofthesimulationperiodinhoursperiteration.
StepTime
Timeincrementusedtoreportvesselstatusduringsimulations(inhours)–
mustbegreaterthan0.01hours.
StartDate
Thedateonwhichthesimulationstarts.
SeedNumber
Thenumberusedtoinitializetherandomnumbergeneratorwhich
determinesthesequenceofrandomnumbersusedduringasimulation.
Thisseednumbershouldremainconsistentforallprojectsduetothefact
thatagivenseednumberwillproducethesamesequenceofrandom
numberseverytimeforagiveniteration.Thisallowscomparisonofa
specifiediterationbetweenmultipleprojects.
MODELOPTIONS:
StartinStepMode
StepModeprovidestheuserwithavisualizationofvesseltrafficinthe
nodenetworkduringthesimulation.
UseFacilityNodes
UseIntermediateFacilityNodesallowsvesselstowaitatspecifiedfacilities
beforeenteringareach.
RunProtocolVessels
First
RunProtocolVesselsFirstprovidesprotocolvesselsprioritywhenentering
reaches.Thispriorityimpactsvesseltrafficwhenreachruleshave
constraintsonvesselencounters.
UseTide
Allowstidetobeusedincalculatingvesseldraftclearances.Thisoption
mustbeusedtoactivaterulesthatusetide.
WaitTimesRetry
Thelengthoftimeavesselmustwaitbeforetryingtoenterareachaftera
ruleviolationforcesthevesseltowait.
Note:Onthefirstvisitofavesseltoafacilitynode,awaittimeof0.10hoursis
automaticallysetforthevesseltotrytodepart.Subsequentdeparture
attemptsareattheuserdefinedinterval.
OutputControls
Thelevelofoutputfilesproducedshowingtheresultsofthesimulation;see
Section8andAppendixCfordetails.
120 Section 8  Simulation Settings, Run Parameters, and Scenarios 8.2.2 Output Control Options in the Scenario Editor Form Therearemany.csvfilesthatuserscanrequestinHarborSymandviewafterasimulationinMicrosoft
Excel,including:
Commodity.csv
DraftAdjustment2.csv
DeletedVesselCall.csv Iteration.csv
DraftAdjustment.csv
NodeConstraint.csv
NodeScheduling.csv
RuleViolation.csv
TimeStep.csv UnitOfMeasure.csv
Usage.csv
VesselCall.csv
VesselCallProblem.csv VesselClassStatistics.csv
VesselsRemainingInSystem.csv Waitcause2.csv
WaitCause.csv RouteGroupStatistics.csv
TherearealsoeightASCIIfilesavailableasoutputfromasimulation;summary,vessel,event,debug,
reach,rules,detailedvesselmovement,andvesselpost‐processinganimationfiles.Theuserselects
thelevelofoutputforthesefilesfromthemenu.NotethatinorderfortheVesselTimegraph
(availableafterrunningthesimulationundertheOutputs/Graphsmenuoption)todisplaythecorrect
averagevesseltime,theusermustselecttheIteration.csvoutputoption.Furtherinformationabout
thesefilesisincludedinAppendixC.
8.2.3 Command Buttons in the Scenario Editor Add
Addsanewscenariowithmostofthescenarioparameters
Delete
Deletescurrentscenario.Deletingascenariodoesnotdeletetheresults
fromthatscenariorun,sincethesearestoredinadifferentdatatable.
Launch
LaunchwillbeginthesimulationandbringuptheChooseProjectScreen,if
morethanoneprojectisinthestudy.
8.2.4 Choose Projects Ifmorethanoneprojectexistswithinastudy,theChooseProjectScreenwillappearwhena
simulationislaunched,asshowninFigure96.Withthisscreen,theuserselectswhichprojectsto
simulatebycheckingtheboxnexttotheprojectname.Buttonsexisttoselectalloftheprojectslisted
forsimulation,ortoselectnoneoftheprojectsforsimulation.Aftertheprojectsareselected,the
launchbuttonmustbeclickedtostartthesimulation.TheRunSimultaneousProjectsoptionarefor
computerswithmultipleprocessors.Whenusingthisoption,projectswillrunsimultaneously,oneper
CPU.
121 Section 8  Simulation Settings, Run Parameters, and Scenarios Figure 96: Choose Projects
8.3 Viewing Simulations TheHarborSymusercanopttorunthesimulationinstepmode.Thisoptionrequiresmore
processingtimeforsimulations,butitallowstheusertovisualizevesselencountersduring
simulations.Thefollowingparagraphsoutlinethenecessarystepstolaunchthewithinsimulation
animationanddescribethetool’svariousfeatures.
IntheScenarioEditor,clickonthe“StartFirstIterationinStepMode”boxandclickon“Launch.”In
thedialogboxthatappears,selecttheprojectstosimulate.Clickon“Launch”again.Adialogboxwill
appearstating“StartinginStepModePressStepButtontoContinue,”withanOKbutton.Clickon
“OK.”Thedialogboxwillthendisappear.ThescreenwiththedialogboxisshowninFigure97.
Figure 97: Dialog Box Overlaying Step Mode Screen
122 Section 8  Simulation Settings, Run Parameters, and Scenarios ClickontheStepButtonintheStepModeScreentobegintheanimation.Tovisualizevessel
encountersinthenexttimeincrement,clickontheNextbutton.ClickonContinuousButtontowatch
thesimulationscontinueuntilalliterationsarecomplete.ClickontheHaltButtontostopthe
simulations.Figure98showstheStepModeScreenthatwillappear.
Figure 98: Step Mode Screen Showing Simulation
Thewithinsimulationanimation,showninFigure98,displaysarepresentationofthelink‐node
networkestablishedintheHarborSymgraphicspane.Eachnodetypeisrepresentedwithadifferent
coloredcircle.Vesselsarerepresentedbycoloredtriangles.Vesselsinadelayedstatus(waitingat
theentrancepoint,docks,etc.)arecoloredred.Iftideisimplemented,thegraphalongthetopofthe
simulationwillplotthetideheight.
TheStepNodeScreenallowstheusertomodifythesimulationvisualization.Keyfeaturesinclude:

TheNcheckboxandtheRCheckBoxontherightsideofthescreenallowtheusertoplacethe
namesofnodesandreachesonthescreen.
123 Section 8  Simulation Settings, Run Parameters, and Scenarios 
TheSZcheckboxallowstheusertovisuallyseethesafetyzonesaroundvesselsastheynavigate
throughtheport.

Ontheleftsideofthescreenradiobuttonsallowtheusertoselectbetweenmonitoringthestatus
ofcommodities,docks,anchoragesandturningbasins,vessels,orreachesduringthesimulation.
- Thecommoditiesselection(C)willshowthecumulativeamountofeachcommoditycategory
transferredaseachiterationprogresses.
- Thevesselselection(V)willshowthecurrentstatusofeachvessel,duringthesimulation.The
vesselsarelistedastransiting,atadock,orwaiting.
- Thedockselection(D)listsalldocks.Double‐clickingonanyoftheentrieswillprovide
informationonthedockstatus.
- Thereachselection(R)listsalldocks.Double‐clickingonanyoftheentrieswillprovide
informationonthereachstatus.
- Theoffselection(X)turnsthisfeatureoff.Thisspeedsuptherunningofthesimulation.
Duringthesimulationtheusercandeterminethestatusofanyvesselmovingthroughtheharbor,
afterclickingontheEventButtontohaltthesimulation.Iftheuserclicksonthevesselrepresentation
inthenodenetwork,thevesseldatasheet,includingthevesselnameandcharacteristics,willappear,
asdisplayedinFigure99.Additionally,userscanclickonthevesselnameintheStatusPaneto
highlightthevessellocationinthenode.Afterwards,clickingontheStepButtonortheContinuous
Buttonwillresumethesimulation.
Figure 99: Vessel Query 124 Section 8  Simulation Settings, Run Parameters, and Scenarios Thesimulationprocessingspeedcanbeacceleratedbyturningoffthewithinsimulationanimation.
Todoso,selectthe“Resume”optionandXfromtheradiobuttons.Thelink‐nodenetworkwill
disappearandHarborSymwillcontinuetoprocessthesimulationwithoutvisualization.Awindow
willappearinformingtheuserwhenthesimulationiscomplete.Thesimulationvisualizationcanbe
re‐startedbyagainhittingthe“Step”button.
8.4 Viewing Simulation Output Results Projectalternativesareanalyzedbycomparingtheoutputofsimulations.WithinHarborSymtheuser
canobtaintheoutputofsimulationsinreportsorgraphs.Additional,moredetailedexternalreports
arealsostoredseparatelyinthesamefolderastheprojectinputfile.Thesedetailedreportsare
describedindetailinAppendixCandshouldbereviewedforathoroughunderstandingofsystem
behavior.ThereportsavailablethroughtheHarborSymuserinterface,describedinthefollowing
subsections,providesummarystatisticsandpresentanoverviewofthesimulationresults.
TheoutputreportsavailablewithinHarborSymareaccessedthroughtheOutputPillaronthetoolbar.
TheoutputreportsavailablearetheProjectComparisonReport,theSingleScenarioReport,theReach
RuleViolationsReport,theTransitRulesReport,theVesselClassCharacteristicsReport,andthe
CommodityInfoReport.ThereportsareaccessedbyclickingonOutputandthenclickingonReports
onthemenuthatappears.Choosinganyofthereportsrevealsadialogueboxforselectionof
scenariosorprojects,dependinguponthereport.
8.4.1 Project Comparison Report TheProjectComparisonReportcomparestwoormoreprojectsusingthesamescenario.TheAverage
VesselTimeinSystem(Harbor)andAverageVesselCostarecompared.Theusermustchoosethe
BaseProject(e.g.,existingorwithout‐projectcondition)againstwhichallotherselectedprojectsare
compared.OncetheBaseProjectischosen,theusercanselectasmanyprojectsasareavailablefor
comparison.ToviewtheProjectComparisonReport,proceedasfollows:
1. Fromthemenu,clickonthe“Output”pillarandselect“ProjectComparison.”Adialoguebox
titled“ReportScenarioComparison”willappear.
2. Selectthescenarioandthebaseprojectfromthefirstpop‐upmenu.Selectthecomparison
projectbycheckingtheboxintheselectionbelow.AnexampleofaScenarioComparisonReport
isshowninFigure100.Itprovidesadatestampfortherunandthescenarioname.Simulation
resultsareshowninthebottomportionofthereport.
125 Section 8  Simulation Settings, Run Parameters, and Scenarios Figure 100: Example Scenario Comparison Report
8.4.2 Single Scenario Report TheSingleScenarioReportprovidesdetaileddataonasinglesimulationofasinglescenarioand
singleproject.Theresultsforalliterationsofthesimulationareaveraged,andtheminimum,
maximum,andstandarddeviationbetweentheresultsofiterationsarelisted.
1. Fromthemenu,clickonthe“Output”pillarandselect“SingleScenario.”Adialogboxtitled
“ReportBuilder”withamenuofscenarioswillappear.
2. Selecttheappropriatescenario.Eachscenario/projectsimulationrunislistedinchronological
order.AnexampleofaSingleScenarioReportisshowninFigure101.
126 Section 8  Simulation Settings, Run Parameters, and Scenarios Figure 101: Single Scenario Report 8.4.3 Reach Rule Violations Report TheReachRuleViolationsReportprovidesdetailedinformationonthevesseltrafficrulesthat
resultedinwaitandretriesduringasimulation.DuringHarborSymsimulations,therulesarenot
actuallyviolated.Insteadofviolatingarule,themovingvesselwaitsattheentrancetoaleguntilthe
conflictpasses.Afterthespecifiedtimeperiodthemovingvesselattemptstomoveagainina“retry.”
1. Fromthemenu,clickonthe“Output”pillarandselect“ReachRuleViolations.”Adialogbox
titled“ReportBuilder”withamenuofprojectswillappear.
2. Selecttheappropriatescenario/projectcombination.
3. Fromthemenu,clickonthe“Output”pillarandselect“ReachRuleViolations.”Adialogbox
titled“ReportBuilder”withamenuofprojectswillappear.
4. Selecttheappropriatescenario/projectcombination.
TheTransitRulesReportprovidesdetaileddataontherulesimplementedduringasimulation.A
reportisavailableforeachprojectsimulated.
127 Section 8  Simulation Settings, Run Parameters, and Scenarios Figure 102: Transit Rules Report 1. Fromthemenu,clickonthe“Output”pillarandselect“TransitRules.”Adialogboxtitled
“ChooseProjectforReport”withamenuofprojectswillappear.
2. Selecttheappropriateproject.AnexampleofaTransitRulesReportisshowninFigure102.
8.4.4 Vessel Class Characteristics Report TheVesselClassMovementThresholdsReportprovidesdetaileddataonthemeasurementthresholds
usedtodefinevesselclasses.
1. Fromthemenu,clickonthe“Output”pillarandselect“VesselClassMovementThresholds.”An
inputboxtitled“ChooseProjectsforReport”withamenuofprojectswillappear.
2. Selecttheappropriateproject.AnexampleofaVesselClassMovementThresholdReportis
showninFigure103.
128 Section 8  Simulation Settings, Run Parameters, and Scenarios Figure 103: Vessel Class Movement Threshold Report
8.4.5 Commodity Info Report TheCommodityInfoReportprovidesdetaileddataontheunitsofmeasureandtonsperunitof
commoditycategories.
1. Fromthemenu,clickonthe“Output”pillarandselect“CommodityInfo.”Aninputboxtitled
“ChooseProjectforReport”withamenuofprojectswillappear.
2. Selecttheappropriateproject.
8.4.6 Output Graphs HarborSymgeneratesseveraloutputsthatdisplay
thesimulationresultsingraphicalform.These
outputsareaccessedthroughtheGraphsoptionof
theOutputpillar,asshowninFigure104. Figure 104: Graphical Outputs 129 Section 8  Simulation Settings, Run Parameters, and Scenarios Sixgraphsareavailableincluding:
TimeinSystem
VesselTime
FullTimeStatistics
RuleCountbyType
TransportationCost‐Time
RuleCountbyReach
Forallgraphs,theuserhastheoptiontosaveorprinttheimage.TheVesselTimegraphisdisplayed
inFigure105.Thisgraphplotstheaveragevesseltimeinsystemforeachiterationaswellasalong
runmovingaverageoveralliterations.Thisinformationcanhelptheuserdetermineifsufficient
iterationshavebeenprocessedtoreachstabilityinoutputs.NotethatinorderfortheVesselTime
graphtodisplaythecorrectaveragevesseltime,theusermustselectthe‘Iteration.csv’outputoption
whenrunningthesimulation.
Figure 105: Vessel Time Graph 8.4.7 Output Files Extensivedataaboutsimulationsisavailableinoutputfiles.ThesefilesareobtainedinWindows®
Explorer.AppendixCcontainsdetaileddescriptionsoftheoutputfiles.
130 Section 9 Understanding HarborSym Output HarborSymestimatesvesseltransittimesbasedupontheharborconditionsdefinedbytheproject
andsimulationconditionsestablishedinthescenario.Simulationoutputincludestheaveragetime
pervesselcallandtotaltimeforallvesselcallsateachphaseofaharborvisit.Thetimespentby
vesselsinaharborconsistsofthetimetransitingreachesandturningbasins,thetimewaitingto
preventaruleviolation,andthetimeloadingandunloadingcommoditiesatdocks.Vesselscanwait
outsidetheharboratanentrance,inanchoragesandatdocks.Theaverageandtotaltimespent
waitingateachoftheselocationsbyvesselclassshouldbereviewedtodeterminehowtrafficis
flowingthroughtheharborinthemodel.
HarborSymsimulatesvesseltrafficbasedonindividualvesselmovementeventsanddetermines
whetheravesselcanproceedthroughalegbasedupontheuserdefinedvesseltrafficrules.Detailed
outputfilesareproducedtotabulatereachruletrigger.Theseinternalandexternalreportscanbe
usedtodeterminethereachesinwhichvesseltrafficisconstrainedandthevesseltrafficrulesthat
resultindelays.
ThefollowingsectionsoutlinethetypeofdataelementscapturedintheHarborSymoutputs.
AdditionaldetailsonspecificreportsareprovidedinAppendixC.
9.1 Vessel Time in System and Total Vessel Cost Vesseltimeinsystemisestimatedbaseduponsimulationsofvesseltrafficthroughtheharbor.Total
vesselcostisthecostofoperatingvesselsintheharbor,whichisestimatedbymultiplyingthevessel
operatingcostforeachvesselbythetimeinsystemforeachvessel.Thesumofvesseltimespent
transiting,turning,docking,loading,andwaitingequalsthetimeinsystem.Vesseltrafficrulesimpact
transittimesbecausepotentialruleviolationsresultinwaitingtime.
9.2 Reach Rule Violations VesseltrafficruleviolationsdonotoccurduringHarborSymsimulationsbecausevesselswaituntil
conflictsclearandtheycanproceed.InHarborSymreports,thesewaitingeventsarelistedasrule
violations.Eachunsuccessfulretryiscountedasanadditionalruleviolationortrigger.Byreviewing
reachruleviolationstheusercandeterminewheretransitrulesareresultinginvesselswaiting.
9.3 Vessels Exiting, Vessels Remaining, and Deleted Vessels Vesselsthatentertheharborduringasimulationwilleitherexittheharbor,remainintheharbor
whenthesimulationends,orbedeletedduringthesimulation.Thenumberofvesselsexitingthe
harbormaybelessthanthenumberofvesselsinthevesselcalllistbecausesomevesselswillbeat
docksortransitingreacheswhenthesimulationends.Variousoutputfilesdocumentthenumberof
vesselsremaininginthesystemattheendofthesimulationaswellasalldeletedvessels(output
reportsaredescribedindetailinAppendixC).Remainingvesselsmaynotindicateproblemswiththe
simulationordata,astheysimplyrepresentcallsthatdidnotcompleteprocessingwithinthe
allocatedsimulationduration.SpecialbehaviorisbuiltintoHarborSymtoensurepriorityvesselsthat
131 Section 9  Understanding HarborSym Output remaininthesystemattheconclusionofthesimulationarevisibletoallvesselsinthefullcalllistrun
(additionaldiscussionofthiscapabilityisavailableinSection3.2.5).
Theusershouldconsiderthatthenumberofvesselsexitingtheharbormaybereducedbecausesome
vesselcallsaredeletedwhenvesselsbecome“stuck”atanodeintheharbor.Thetimeinsystemfor
thesedeletedvesselcallsarenotincludedinoutputreports.Whenevaluatingandcomparing
projects,thenumberofdeletedvesselcallsshouldbeconsidered.Theusershouldtrytominimize
deletedvesselcallsbyincreasingthenumberofretriesallowedduringsimulationoradjustingvessel
callinformationtoaccuratelyreflectsystemconditions.Deletedvesselcallswillimpacttheamountof
commodityloadedandunloadedduringasimulationandmayresultinunderoroverestimatesof
with‐projectbenefits.
9.4 Vessel Time Waiting Vesseltimewaitingisthetimevesselsspendwaitingtopreventaruleviolation.Vesselscanwait
eitherattheentrance,atadock,oratananchorage.Vesseltimewaitingistheprimaryvariable
changedbyharborimprovements.
9.5 Vessel Cost Vesselcostistheproductofvesseltimeinsystemandvesseloperatingcost.HarborSymcalculates
vesseloperatingcost.Thetimespentinthesystemconsistsoftimespentatthedocksandthetime
spenttransitingtoandfromthedocks.”Inport”costsareusedforthetimevesselsareatadockand
“atsea”costsareusedforthetimeavesselspendstransitingthroughtheharbor.Adetailed
descriptionofinportandatseacostapplicationisincludedinSection3.2.5.Detailsonhowat‐sea
costsareappliedtothesubjectportareprovidedinSection3.3.1.
132 Section 10 HarborSym Animation Module (HSAM) Inrecentyears,theimportanceofmodeltransparencyandvalidationhasincreasedasstakeholders
anddecision‐makersrequiregreaterconfidenceinanalyticaltoolsandabetterunderstandingof
modelinputsandoutputs.Itmustbeclearwhatthemodelsdo,andpreciselyhowtheydoit.Tothis
end,graphicalvisualizationofmodeldataandbehaviorhasbeenintegratedasafundamentalaspect
ofmodeldesignandusage.Visualizationtechniqueshaveevolvedovertime,asnewinsightsinto
whatwouldbeworthwhilearelearnedbyusage,andasnewuserswithdifferentperspectivesand
desiresapplythevariousnavigationanalysistools.
TheHarborSymAnimationModule(HSAM)wasdevelopedtoconveyresultsofaHarborSym
simulation,includingtrafficpatterns.Theanimationpackageportraysinformationinafashionand
environmentfamiliartoanaudiencerangingfromsubjectmatterexpertswithdeepknowledgeofthe
processesinvolvedandthedetailsofnavigationissues,throughhigh‐levelofficialswithextreme
constraintsonavailabletimeandstrongneedsforinformationcondensation.HSAMisasimple,
elegant,versatile,andcosteffectivesolutionfortheanalysisandpresentationofvesseltraffic
movementdataforvariouspurposes.
AkeydesignfeatureofHSAMistheabilitytocontroltheappearanceandcontentoftheanimation
fromtheparentsimulationmodel,HarborSym,withouttheneedtorecompileanyportionofthe
systemortheneedforamulti‐mediaproductionengineer.HSAMisconfiguredfromwithin
HarborSym.Theuserfirstselectsagraphicrepresentingthegeographyoftheharborbeingsimulated.
Thiscanbeanavigation
chartoranartistic
rendering.Thiswillbe
thesurfaceonwhich
systemanimates
movementsofthevessels.
Intrinsictothe
developmentofthe
HarborSymsimulationis
thespecificationofthe
networkofwaypoints,
docks,reaches,and
turningbasins.The
networklayoutandvessel
calllistscreatedin
HarborSymareutilizedin
HSAMforvisualization.
Figure 106: HSAM Visualization
HSAMallowstheuserto
specifyavisually
distinctive3Dmodel,or
avatar,foreachclassofvessel.Thetextureappliedtotheavatarisalsouserselectable.Thoughtful
selectionofavatarsandtexturescanhaveastrongimpactonwhatisbeingdemonstratedbythe
133 Section 10  HarborSym Animation Module (HSAM) resultinganimation.Simplecolorationchangescanbringthemovementpatternsofselectclassesof
vesselssharplyintofocus.Thetexturesusedtoprovideboththeskyandhorizon,areuserselectable
forbothdaytimeandnighttime.HSAMallowsdistinctiveday/nightenvironmenttexturesto
emphasizealternateruleschemes.HSAMisdirectedtomakevesselmovementsandenvironmental
alterationsthroughatimesequencedqueueofeventcommands.Thiscommandqueueputsthe
simulatedvesselfleetintomotion.
TheHSAManimationframeworkconsistsofaseriesofrelatedobjectsworkinginconcerttorespond
toatimeorderedseriesofeventstoprovideananimateddepictionofthesimulationdatastreams.
ThefoundationalobjectsintheHSAMframeworkarevessel,navigationnode,andnavigationreaches.
Theseobjectsrepresentphysicallocations,theroutesbetweenthoselocations,andthevesselsthat
movealongthoseroutes.
10.1 Vessel Objects Thevesselobject,whichrepresentsthedistinctvesselsthatwillappearintheanimation,has
characteristicpropertiesincludingauniqueidentifier,nameofvessel,flagofregistry,draft,beam,
physicaldimensions,acargomanifest,position,orientation,status,visibility,anavatarwhichisthe
physicalrepresentationoftheobjectinthesimulatedenvironment,thevessel’sclassandsub‐class
identifiers,andatextureorsimplecolortobeappliedtothevesselavatar.Asamplingofvessel
avatarsdevelopedforHSAMisshowninFigure107.
Figure 107: Sample HSAM Vessel Avatars
Thevesselobjectretainsatimesequenceorderedqueueofcommandsthatpertaintoitselfandits
cargomanifest.Vesselcommandsaredirectivestoalteroneormoreofthevessel’spropertieseither
ataspecificpointintimeor,inthecaseofamovementcommand,overaspanoftime.Propertiesthat
canbealteredthroughavesselcommandeventareposition,status,visibility,orientation
(independentofdefaultmovementorientation),andavatartexture.Vesselscanalsobeissuedcargo
manifestalterationcommands.Thesecommandstaketheformofacommoditycode,aunitof
measure,andatransactionquantity.Attheindicatedtriggertime,thevessel’scargomanifestis
adjustedinaccordancewiththeparametersofthecommand.Finally,asanoptimizationpoint,there
isa“destruct”commandthatisissuedtoaninstanceofavesselwhenitisnolongersignificantinthe
simulation,i.e.,thecallingvesselleavestheharbor.Thedestructionofthevesselimmediatelyfrees
systemresourcesandisusedtoimproveaverageframeratecapabilitiesofHSAM.
10.2 Navigation Node and Navigation Reach Objects TheHSAManimationframeworkmaintainsahashtablecollectionofthoseobjectsformingthe
navigationnetwork–navigationnodesandnavigationreaches.Thenavigationnodeobject
encapsulatesalocationinthesimulatedworldthatvesselsmaydepartfrom,arriveat,orpass
134 Section 10  HarborSym Animation Module (HSAM) through.Thenavigationnodeobjecthaspropertiesencompassingauniqueidentifier,aname,status,
acargothroughputlist,position,orientation,anavatar,atexture,andacategoryortypeindicator
designatingthenodeobjectasdock,waypoint,entrybar,oraturningbasin.Thecategorytypesare
userdefinedduringanimationconfigurationasarethedefaultavatarsforeachdefinedcategoryas
wellasspecificnodeavatarandtextureoverrides.Thenavigationnodeobjectretainsacollectionof
commoditytransactionvolumescapableoftrackingsummaryutilizationintermsofcargothroughput.
Inadditiontoexecutingcommandstoallowthetextureofthenode,thestatus,andthevisibilityofthe
nodetobemodified,thenodeobjectprocessescommandstomaintainthesummarycargolists.These
commandsallowresettingorclearingofthelistandpass‐throughtransactionsindicatingthecargo
commoditytype,theunitofmeasureandthequantitypassingthroughthenode.Thepass‐through
transactionsalsoindicateifthecargowasloadedorunloadedandthelistsofloadedandunloaded
cargoaremaintainedseparatelysoastoallowtheanalysttovisualizetrendsorevenanomaliesin
commodityflow.
TheNavigationReachobjectisafarsimplerconstruct.Anavigationreachisdefinedasadirectedline
connectingexactlytwonavigationnodes.Thepropertiesforreachesincludeareachclassidentifier,a
specificreachinstanceavatar,atextureorsimplecolorforthatavatar,andastatus.Thecommands
thatcanbeissuedtoareachobjectallowthetextureofthereach,thestatus,andthevisibilityofthe
entirereachtobemodified.Muchlikethevesselobjects,boththenodeandreachobjectsmaintaina
timesequencedqueueofcommandspertainingtotheirspecificinstances.Thenatureofthe
commandsavailabletotheobjectsinthenavigationnetworkismorerestrictivethanthoseforthe
vesselsasthearrangementofthenetworkmustbefixedpriortotheappearanceofthefirstvesselin
theanimation.Oncetimehasbeguntopass,thebasicappearanceofthenetworkisnolonger
malleable.Thecommandsetandpropertiesofthenavigationnodeandnavigationreachobjectsform
thenavigationnetworkoverwhichvesselstransitintheanimationandiswellsuitedtothevisual
depictionofthechangingstatus,conditions,andcargomovementpatternsindeep‐draftharbors.
10.3 Download and Install HSAM HSAMisavailablefordownloadfromtheHarborSymwebsite,asshowninFigure108,
(http://www.pmcl.com/harborsym/).UsersmustdownloadandinstallHSAMseparatelyfrom
HarborSym.Todoso,navigatetothe“Download”pagefromthemenubarontheHarborSymhome
page.HSAMisavailablefordownloadinthe“AnimationModule”section.
Figure 108: HarborSym Website Download
10.3.1 Internet Download Installation 
Downloadtheinstallationfiletoatemporarydirectory(Example,C:\Temp).

ClickthestartbuttonontheTaskbar.
135 Section 10  HarborSym Animation Module (HSAM) 
ClickRun.

Typethepathtothedownloadedfile(Example,C:\Temp\Setup.exe).

Clickthe“OK”button.

Followinstructionstocompletesetup.
10.3.2 Uninstall 
ClicktheStartbuttonontheTaskbar.

ClickSettings.

ClickControlPanel.

Double‐clickSelectAdd/RemovePrograms.

Select“HSAM”.

ClicktheAdd/Removebutton.
10.4 HarborSym Output for HSAM Animation GeneratingHSAMvisualizationrequiressimulationoutputandconfigurationsettingsfrom
HarborSym.Avesselmovementfile(.vmf)mustbeproducedduringascenarioprocessingof
HarborSym.ThisfileiscreatedthroughtheOutputControlSettingswindow,whichislaunchedfrom
thescenarioeditorscreenbypressingthe“FileSettings”button,asshowninFigure109.(Section6.12
containsdetailsoncompletingthescenarioeditorformandprocessingasimulation.)Withinthe
OutputControlSettingswindow,theOutputtoDataFilesfortheVesselMovement(.vmf)selection
mustbeactivated,asshowninFigure110.
Figure 109: Launch File Settings Configuration
136 Section 10  HarborSym Animation Module (HSAM) Figure 110: File Settings Configuration
Afteractivatingthevesselmovementfileoption,HarborSymmustprocessacompletesimulation.
TherearenoadditionalparametersthatmustbesetspecialforaHSAMrun;processthesimulationas
desired.
10.5 HSAM Options Window Whenthesimulationcompletes,rightclickontheprojectnameintheNavigationPaneandselect
OutputHSAMInformation,asshowninFigure111.ThiswilllaunchtheHSAMOptionswindow.
HSAMincludesoptionsforselectingthesimulationrun,theiteration,thelocationoftheHSAM
installationanddisplayoptions.These
parametersareestablishedthroughthe
HSAMOptionswindow.
SelectasimulationtoreviewinHSAMfrom
theAvailableSimulationRunspulldown
menu.Thiswilllistallsimulationswith
usableVesselMovementfilesforHSAM
animation.
Throughthiswindowtheanimationdisplay
optionscanbeselected.Theseinclude
Figure 111: Output HSAM Information optionstoselectthegraphicandcolor
utilizedforeachvesseltype,thecolorand
graphicutilizedfornodesandthereachcolor.
137 Section 10  HarborSym Animation Module (HSAM) 10.6 HSAM Operating Controls OnceaHSAMsimulationhaslaunchedusingtheabovesteps,theusercancontrolthevisualization
appearanceusingthecontrolslistedinFigure112andTable8.
Pitch Up
Yaw Right
Yaw Left
Figure 112: HSAM Operations
Pitch Down Table 8: HSAM Operational Key Strokes
138 Key Action A Accelerate on the X axis (move right)
D Decelerate on the X axis (move left)
S Accelerate on the Z axis (move forward)
W Decelerate on the Z axis (move backward)
Left Arrow Yaw left (spin left)
Right Arrow Yaw right (spin right)
Up Arrow Pitch up (nose up)
Down Arrow Pitch down (nose down)
Page‐up Increase time speed
Page‐down Decrease time speed
Right Shift Decrease vessel size (all)
Left Shift Increase vessel size (all)
P Toggle interrogation mode (query database by picking vessel) Time is stopped when this mode is entered. Use the Page‐Up key to start time once you have exited this mode. Time cannot be adjusted while in Interrogate mode. ESC Exit animation Appendix A Importing Data into HarborSym TemplatescanbeusedtoimportdataintoHarborSymandreducetheamountofmanualdataentry
effortrequiredoftheuser.ThetemplatesuseMicrosoftExcelspreadsheetstoformatdataconsistently
solargeamountsofdatacanbecompiledandanalyzedusingExcel’sfeatures.Therearethreestepsto
usingtemplatesinHarborSym,creatingthespreadsheettemplatewithinthestudy,completingthe
spreadsheettemplate,andimportingthespreadsheet.Templatesarecreatedandthenimported
throughtheHarborSymImportmenu.
A.1 Importing the Vessel Call List PorttrafficisimportedthroughtheLookupSpreadsheet.Thespreadsheetisoneofsixworksheetsin
thePortTrafficImportTemplate,whichisanExcelworkbook.Theworkbookcontainsseparatetabs
titled,Field_Descriptions,Commodity,Dock,Vessels,Calls,andFlags,asdescribedbelow.Section6.6
providesdetailsontheprocessforcreatingalookupspreadsheetandimportingdataintoHarborSym.

The“Commodity”worksheetconvertscommoditycategorydescriptionstocommoditycategory
numbersandcanbepopulatedbyHarborSymduringthe“CreateLookupSpreadsheet”routine.

The“Dock”worksheetconvertsdockdescriptionstodocknumbersandcanbepopulatedby
HarborSymduringthe“CreateLookupSpreadsheet”routine.

The“Vessel_Types”worksheetconvertsvesseltypedescriptionstovesseltypenumbersandcan
bepopulatedbyHarborSymduringthe“CreateLookupSpreadsheet”routine.

The“Vessel_Classes”worksheetliststhevesselclassnamesandnumber.Thisworksheetcanbe
linkedtotheCallstabthroughtheVLOOKUPfunction.

The“RouteGroups”worksheetliststheroutegroupdescriptionandnumberspecifiedin
HarborSym.ThisinformationcanbeusedtopopulatetheRoute_Group_Nameand
Route_Group_NumberfieldsintheCallsworksheet.

The“Flags”worksheetliststhenationcodeforeachnation.Americanflaggedvesselsusethe
code“AMER”andhavedomesticoperatingcostsappliedtotheirtransittimes.Allotherflags,
includingthegeneric“Z_Foreign”,areassociatedwithforeignoperatingcosts.

The“Calls”worksheetcontainstheinformationthatisimportedintoHarborSymtopopulatethe
porttrafficdataentrygrids.ThisworksheetcanbelinkedtotheCommodity,Dock,andVessel
tabsthroughtheVLOOKUPfunction.Thisfunctionobtainsvesselclassnumbers,docknumbers
andcommoditycategorynumbers.Table9:ImportSpreadsheetFieldDefinitionsprovidesa
descriptionofeachfieldintheCallsworksheet.
TheField_Descriptionstabdefinesallthecolumnsinthe“Calls”worksheet.Thefielddefinitions
areoutlinedinTable9.
139 Appendix A  Importing Data into HarborSym Table 9: Import Spreadsheet Field Definitions Field Description Movement_Number This number must be unique for each vessel trip. The movement number should be repeated for trips with multiple dock visits, multiple commodity types, and import and export movements. Date the vessel arrives at the port entrance
Time the vessel arrives at the port entrance
Name of the vessel
Node in HarborSym network where the vessel will enter the port Node in HarborSym network where the vessel will exit the port Vessel draft upon arrival at the entrance point, expressed in feet Designation of whether the cargo listed is intended for import or export at the dock, indicated by either I or E. Multiple entries in the import spreadsheet, with the same movement number, are necessary for movements with both import and export cargo. Name of node in HarborSym (dock node) where the vessel will stop during this portion of the movement. If the vessel will visit more than one dock, multiple entries, with the same movement number, must be entered into the import spreadsheet. The HarborSym auto populated dock number corresponding to the dock name. The sequence of dock visit during the vessel trip. If only one dock is visited during the movement, enter 1. The name of the commodity moved on the vessel, corresponding to the entry in the Import/Export field. Movements carrying multiple commodities will require multiple entries in the import spreadsheet with the same movement number. The HarborSym auto populated commodity number corresponding to the commodity name. Quantity of commodity transferred during this portion of the movement. The entry should reflect only quantity exchanged in the direction indicated in the Import/Export field (i.e., only the amount either imported or exported) at the specific dock referenced in the Dock_Number field. The unit of measure (i.e., tons, containers, vehicles, passengers) must correspond with the unit of measure provided in the HarborSym interface for this type of commodity. The name of the vessel type classification for this vessel, corresponding to one vessel type entered into the HarborSym interface. The HarborSym auto populated vessel type number corresponding to the vessel type
name. Arrival_Date Arrival_Time Vessel_Name Entry_Point Exit_Point Arrival_Draft Import/Export Dock_Name Dock_Number Dock_Order Commodity_Name Commodity_Number Commodity_Units Vessel_Type_Name Vessel_Type_Number Unique_Vessel_Identifier A numerical value unique for each individual vessel in the call list. If a specific vessel has multiple calls in the call list, each should reflect the same Unique Vessel Identifier. NRT Net registered tons (optional)
GRT Gross registered tons (optional)
DWT Deadweight tons (optional)
Capacity Numeric value reflective of maximum capacity of the vessel; this should correspond with the commodity unit of measure carried on the vessel. LOA Length overall (in feet, consistent with the units used to define reaches in HarborSym)
Beam Width of the vessel (in feet, consistent with the units used to define reaches in HarborSym) Draft Maximum sailing draft of the vessel (in feet, consistent with the units used to define reaches in HarborSym) Flag Country of vessel flagging
140 Appendix A  Importing Data into HarborSym Field Description TPI_Factor Tons per inch immersion factor, used to calculate sailing draft after commodities are exchanged at the dock The name of the route group for the vessel call, leave blank if unknown The number of the route group corresponding with the route group name for the vessel call, leave blank if unknown The vessel class name, leave blank if unknown
The vessel class number corresponding with the vessel class name, leave blank if unknown Estimate of total trip cargo, defined as the cargo on board the ship at arrival plus the cargo on board the ship at departure in tons. Used to allocated all or a portion of the at‐sea costs to the subject port. See Section 3.3.1 for details. Route_Group_Name Route_Group_Number Vessel_Class_Name Vessel_Class_Number ETTC A.2 Importing Vessel Speed in Reach WhencreatingtheVesselSpeedinReachtemplate,HarborSymwillcreateanExcelworkbookwitha
singleworksheetcontainingamatrixofvesselclassesandreachesforaproject.Theusermust
completethematrixbyenteringthelightandloadedspeed(innauticalmilesperhour)ofagiven
vesselclassforeachreach.Oncecomplete,theworkbookcanbeimportedintoHarborSym.Afterthe
import,thedatagridfoundunder“Reaches”,tab“SpeedinReach”,willbecompleted.
A.3 Vessel Docking Time WhencreatingtheVesselDockingTimetemplate,HarborSymwillcreateanExcelworkbookwitha
singleworksheetcontainingamatrixofvesselclassesanddocksforaproject.Theusermustcomplete
thematrixbyprovidingtheminimumandmaximumdockingandundockingtimeforeachvessel
classificationateachdockinhours.Oncecomplete,theworkbookcanbeimportedintoHarborSym.
Aftertheimport,thedatagridfoundunder“Docks”,tab“VesselDockingTime”,willbecompleted.
A.4 Vessel Turning Time WhencreatingtheVesselTurningTimetemplate,HarborSymwillcreateanExcelworkbookwitha
singleworksheetcontainingamatrixofvesselclassesandturningbasinsforaproject.Theusermust
completethematrixbyprovidingtheminimum,mostlikely,andmaximumvesselturningtimefor
eachvesselclassateachturningarea.Oncecomplete,theworkbookcanbeimportedintoHarborSym.
Aftertheimport,thedatagridfoundunder“TurningBasin”,tab“VesselTurningBasinTime”,willbe
completed.
A.5 Commodity Transfer Rates WhencreatingtheCommodityTransferRatetemplate,HarborSymwillcreateanExcelworkbookwith
asingleworksheetcontainingamatrixofvesseltypes,commoditycategories,anddocksforaproject.
Theusermustcompletethematrixbyprovidingtheminimum,mostlikely,andmaximumloadingand
unloadingrateforeachcombination.Oncecomplete,theworkbookcanbeimportedintoHarborSym.
Aftertheimport,thedatagridfoundunder“Docks”,tab“CommodityTransferRate”,willbe
completed.
141 Appendix A  Importing Data into HarborSym A.6 Sample Import Error Log AsdescribedinSection6.6.4,animporterrorlogiscreatedtodocumentanyproblemsHarborSym
encounteredduringthevesselcalllistimport.Thefollowingimagesprovideanannotatedsample
importerrorlog.
A.7 Sample Data Validation Report AsdescribedinSection5.7.5,HarborSymincludesadatavalidationtooltoevaluatethecompleteness
andreasonablenessofuserprovideddata.Adatavalidationreportisgeneratedfollowingtheroutine
tooutlineanyidentifiedproblems.Thefollowingimagesprovideanannotatedsampledata
validationreport.
142 Appendix A  Importing Data into HarborSym 143 Appendix A  Importing Data into HarborSym This page intentionally left blank.
144 Appendix B HarborSym Vessel Traffic Rules B.1 Introduction AlargeselectionofvesseltrafficrulesareavailabletotheHarborSymusertoapplytotheentire
harborortoparticularreacheswithintheharbor.Multiplerulesmaybeselectedforanyreach.
Vesseltrafficrulesareforsinglevesselsorforvesselencounters,andarebasedonharborconditions
andvesselparameters.Differentrulesrequiredifferentdataentryparameters,whicharedefinedin
Table10.The“WaitCause”fieldinTable10reflectsthegeneralcausesfordelay,asdescribedin
Section3.2.9.TrafficrulesthatcanbeimplementedaredescribedinTable11.
Vesseltrafficrulesregulatingvesselencountersaredefinedbytheuser.Foreachreachduringeach
timesteptheHarborSymmodelanalyzesvesselencounters.Everyvesselencounterisbaseduponthe
movingvesselandtheothervessel.Theothervesselisdefinedasthevesselthathasalreadybeen
approvedtoproceedthroughareach.Thescheduledentryandexittimesofallsuchvesselsare
maintainedbythesimulationandknownforeachreach.Theapproachofthemovingvesseltothe
reachisevaluatedbytheHarborSymmodeltodetermineifanencounterbetweenthemovingvessel
andanyoftheothervesselsthatarescheduledtobeinthereachatthesametimeasthemoving
vesselwouldresultinaruleviolation.Ifavesseltrafficrulewouldbeviolatedbythemovingvessel
proceedingthroughthereachandencounteringtheothervessel,themodelrequiresthatthemoving
vesselwaitattheentrancetothelegforauser‐definedperiodoftime.Afterthattime,themoving
vesselagainattemptstoentertheleg,andtherulesarere‐testedwiththenewtimes.
ThecolumnsintheTransitRuleDataEntryGridaredescribedbelow,startingfromtheleftsideofthe
grid.Someoftheblockshavemenusselections.Theblocksforwhichdataentryismandatoryare
highlighted.
Desc:Checkingthisboxpromptsadescriptionoftherule
Reach:Thenameofthereachislisted
Active:Checkingthisboxactivatestheruleduringthenextsimulation,if“ApplyTransitRules”is
selectedinthescenariodefinition.
Type:Thiscolumnisusedtoselectarulefromthemenuofavailablerules.Thetitlesofthevessel
transitmaynotadequatelydescribetherules,butholdingthecursorovertheTypeboxintheData
EntryGridwillpromptadefinitionoftheruletoappearonthescreen.Thedescriptioncanalsobe
recalledbypressingthedescriptionsquare(
)attheleftoftherulerow.
ApplicationCondition:Thiscolumnallowsaselectionofalways/day/nightinwhichtheruleswill
apply.
VesselPassingType:Usedtoselectpassing/overtaking/oreitherencounterwithwhichtoapply
multiplevesselrules.

NoMeeting–nopassing/noovertaking.
145 Appendix B  HarborSym Vessel Traffic Rules 
NoOvertaking–cannotpasswhenbothvesselsaregoingthesamedirection.

NoPassing–vesselscannotpasseachothergoingoppositedirections.
RuleParameter1/Parameter2/Parameter3:Thesecolumnsareforthespecificdatainput
requiredforsomerules.Thetypeofdataentryvariesbetweenrulesandisdefinedbytherule
definitiontableasspecifiedinTable11.Ifdataentryinoneoftheseblockinrequired,theblockis
highlighted.
MovingVesselClass/LOA/Beam/Capacity/Draft:Thesecolumnsallowtheusertospecifythe
movingvesselstowhichthevesseltrafficruleapplies.Themovingvesselfittingthevaluesdefinedin
theseblockswillwaitbeforeenteringareachdependingupontheothervesselasspecifiedin
Table12.
OtherVesselClass/LOA/Beam/Capacity/Draft:Thesecolumnsallowtheusertospecifythe
characteristicsoftheothervesselstowhichthevesseltrafficruleapplies.Theothervesselmustfit
thevaluesdefinedintheseblocksfortheruletesttobecarriedout,dependinguponthedefinitionof
theruleandthemovingvesselasspecifiedinTable12.
Table 10: Vessel Traffic Rules – Number and Title Transit Rule Type No. Transit RuleType Short Description 0
1
2
3
4
5
7
8
10
11
13
14
16
17
18
19
20
21
22
24
25
26
27
28
29
30
31
No Rule
Vessel LOA or Beam or Capacity
Combined Beam Width
Combined Draft
Capacity1: Capacity Limit V1 AND (Draft Limit OR Capacity Limit V2)
Capacity2: Capacity Limit V1 AND (Draft Limit AND Capacity Limit V2)
Capacity3: (Capacity AND Draft Limit V1) OR (Capacity AND Draft Limit V2)
Critical Commodity Vessel
Maintain Safety Zone
Draft AND Combined Beam Width Limit
Draft Limit V1 Protocol Vessel V2
Any Vessel
Vessel Class V1 Protocol Vessel V2
Draft Plus Tide
Draft Limit
Draft Range LOA Limit Current Limit
Draft Limit Current Limit
LOA Limit Current Limit
Directional Draft Limit Current Limit
Directional Draft Limit LOA Limit
Draft Plus Tide To Max Draft
Beam Reach Width Limit
Draft Exceeds Depth Using Tide / Underkeel
Vessel Class Beam Limit
Vessel Class LOA Limit
Draft Limit V1 OR Draft Limit V2
Safe Distance
146 Wait Cause Not applicable
Vessel Size Constraint
Congestion
Congestion
Congestion
Congestion
Congestion
Critical Commodity
Buffer Zone
Congestion
Congestion
Congestion
Congestion
Tide
Vessel Size Constraint
Tide
Tide
Tide
Tide
Tide
Tide
Vessel Size Constraint
Tide
Vessel Size Constraint
Vessel Size Constraint
Vessel Size Constraint
Buffer Zone
Appendix B  HarborSym Vessel Traffic Rules Transit Rule Type No. 1
2
3
4
5
7
8
10
11
13
14
16
17
18
19
20
21
22
24
25
Transit Rule Type Description Vessel LOA or Beam or Capacity; Single Vessel Rule. This is an OR rule applying to moving
vessel only. A vessel cannot move if its LOA, Beam, or Capacity is greater than the value
specified in the corresponding rule (MovingVesselLOA, MovingVesselBeam,
MovingVesselCapacity).
Combined Beam Width; Two valid vessels are required. The rule is triggered if the combined
beam width of the vessels is greater than the reach width multiplied by the fractional value
specified in Parameter 1,
Combined Draft; Two valid vessels are required. The rule is triggered if the combined draft of
the vessels is greater than the value specified in Rule Parameter 1
Capacity1: Capacity Limit V1 AND (Draft Limit OR Capacity Limit V2); Two valid vessels are
required. The rule is triggered if a vessel above a certain capacity (MVCapacity) encounters
another vessel that is above EITHER a draft (OVDraft) OR capacity (OVCapacity) limit.
SYMMETRICAL
Capacity2: Capacity Limit V1 AND (Draft Limit AND Capacity Limit V2); Two valid vessels are
required. The rule is triggered if a vessel above a certain capacity (MVCapacity) encounters
another vessel that is above BOTH a draft (OVDraft) AND capacity (OVCapacity) limit.
SYMMETRICAL
Capacity3: (Capacity AND Draft Limit V1) OR (Capacity AND Draft Limit V2); Two valid vessels
are required. The rule is triggered if EITHER vessel is above respective limits for BOTH
capacity AND draft. Four values are supplied: MV Capacity, MV Draft, OVCapacity, and OV
Draft.
Critical Commodity Vessel; Two valid vessels are required. Rule violation for the moving vessel
if the vessel in reach (OV) is a critical commodity vessel (typically LNG, LPG, NH3, Passenger)
based on commodity category carried at any point in vessel call.
Two valid vessels are required. No movement if MV within safety zone distance of OV in the
same reach. A Safety Zone Distance (feet) & a Safety Zone type are specified in association
with commodity category. The rule determines if a safety zone applies.
Draft AND Combined Beam Width Limit; Two valid vessels are required. The moving vessel
draft must exceed MV Draft and combined beam width must be greater than Rule Parameter 1
Draft Limit V1 Protocol Vessel V2; Two valid vessels are required. The moving vessel cannot
encounter a protocol vessel in the reach if the MV draft exceeds the rule MV draft.
Any Vessel; Two valid vessels are required. The moving vessel cannot have the designated
encounter (pass, overtake, meet) if there is any vessel in the reach.
Vessel Class V1 Protocol Vessel V2; Two valid vessels are required. A moving vessel of
specified class (MV CLASS) cannot have the designated encounter with a protocol vessel in
the reach
Draft Plus Tide; Single Vessel Rule. No movement allowed if vessel draft is greater than (Rule
Parameter 2 + minimum tide during interval). Rule parameter 2 defines maximum allowable
sailing draft on 0 tide. 0.001' tolerance is used.
Draft Limit; Single Vessel Rule. No movement if draft > MV Draft
Draft Range LOA Limit Current Limit; Single Vessel Rule. No sailing if MV draft in range
between Rule MV Draft AND Rule P2 AND LOA > Rule MV LOA AND Current > P3
Draft Limit Current Limit; Single Vessel Rule. No sailing draft> MV Draft AND current>P3
LOA Limit Current Limit; Single Vessel Rule. No sailing if MV LOA > Rule MV LOA AND
Current > P3
Directional Draft Limit Current Limit; Single Vessel Rule. No movement allowed in P1 direction
if MV Draft > Rule MV Draft, Current >P3. P1 <0 inbound, P1 > =0 outbound
Directional Draft Limit LOA Limit; Single Vessel Rule. No movement allowed in P1 direction if
MV LOA > Rule MV LOA, Current >P3. P1 <0 inbound, P1 > =0 outbound
Draft Plus Tide To Max Draft; Single Vessel Rule. No movement allowed if vessel draft is
greater than (Rule Parameter 2 + minimum tide during interval).
Rule parameter 2 defines maximum allowable sailing draft on 0 tide. 0.001' tolerance is used.
MV Draft is max draft overall
147 Appendix B  HarborSym Vessel Traffic Rules Transit Rule Type No. 26
27
28
29
30
31
Transit Rule Type Description Beam Reach Width Limit; Single Vessel Rule. No movement if MV Beam plus Rule Parameter
1 > Reach Width
Draft Exceeds Depth Using Tide / Underkeel; Single Vessel Rule. No movement if MV Draft
plus underkeel > (depth plus minimum tide in period). Underkeel based on vessel class.
Vessel Class Beam Limit; Single Vessel Rule, no movement if class = rule vessel class and
moving vessel beam > rule beam - single vessel rule, enter values for beam, class in MV fields
Vessel Class LOA Limit; Single Vessel Rule, no movement if class = rule vessel class and
moving vessel LOA > rule LOA - single vessel rule, enter values for beam, class in MV fields
Draft Limit V1 OR Draft Limit V2; Two valid vessels are required. No movement if either MV
draft > Rule MV Draft OR OV draft > Rule OV Draft.
The rule is triggered if EITHER vessel is above respective limits for draft. Two valid values
required, MV Draft, OV Draft
Safe Distance; Two valid vessels are required. No movement if MV within critical distance of
OV. Critical distance specified either as P1 (fixed distance, feet) or P2 (MV LOA multiplier).
Critical distance is larger of these two values.
Table 11: Vessel Traffic Rules – Number and Parameter Usage Transit Rule Type No. Transit Rule Description P1 Usage Description P2 Usage Description P3 Usage Description No Rule
N/A
N/A
N/A
N/A
N/A
N/A
decimal fraction of channel width
(0 to 1.0)
N/A
N/A
Maximum Combined Draft
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Combined Beam Width
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Maximum Sailing Draft
Without Tide
N/A
18
Draft Plus Tide
Draft Limit
N/A
N/A
N/A
19
Draft Range
N/A
Max Draft
Max Current
0
Vessel LOA or
Beam or
Capacity
Combined
Beam Width
Combined
Draft
Capacity1
Capacity2
1
2
3
4
5
7
Capacity 3
Critical
Commodity
Vessel
Maintain
Safety Zone
Draft AND
Combined
Beam Width
Limit
Draft Limit V1
Protocol
Vessel V2
Any Vessel
Vessel Class
V1 Protocol
Vessel V2
8
10
11
13
14
16
17
148 Appendix B  HarborSym Vessel Traffic Rules Transit Rule Type No. 20
21
22
24
25
26
27
28
29
30
31
Transit Rule Description LOA Limit
Current Limit
Draft Limit
Current Limit
LOA Limit
Current Limit
Directional
Draft Limit
Current Limit
Directional Draft
Limit LOA Limit
Draft Plus Tide
To Max Draft
Beam Reach
Width Limit
Draft Exceeds
Depth Using
Tide /
Underkeel
Vessel Class
Beam Limit
Vessel Class
LOA Limit
Draft Limit V1
OR Draft Limit
V2
Safe Distance
P1 Usage Description P2 Usage Description P3 Usage Description N/A
N/A
Max Current
N/A
N/A
Max Current
<0 inbound
>=0 outbound
N/A
Max Current
<0 inbound
>=0 outbound
N/A
Max Current
N/A
Max Draft With Tide
N/A
Required Excess Width
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Safe distance, feet
MV LOA multiplier
N/A
149 Table 12: Traffic Rules – Number and Moving Vessel Characteristics Transit Rule Type No. Transit Rule Description Single Vessel Rule Tide Type Moving Vessel LOA Moving Vessel Beam Moving Vessel Capacity Moving Vessel Draft Moving Vessel Class ID Other Vessel LOA Other Vessel Beam Other Vessel Capacity Other Vessel
Draft YES
YES
YES
YES
YES
YES
NOTE: Entries are only required where “YES” is marked in the fields below
0
No Rule
5
Vessel LOA or
Beam or Capacity
Combined Beam
Width
Combined Draft
Capacity1
Capacity2
7
Capacity 3
8
Critical
Commodity Vessel
Safety Zone
Draft AND
Combined Beam
Width Limit
Draft Limit V1
Protocol Vessel
V2
Any Vessel
Vessel Class V1
Protocol Vessel
V2
Draft Plus Tide
Draft Limit
Draft Range LOA
Limit Current Limit
1
2
3
4
10
11
13
14
16
17
18
19
150 YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
Tide
YES
YES
YES
Current
YES
YES
Other Vessel ClassID Appendix B  HarborSym Vessel Traffic Rules Transit Rule Type No. Transit Rule Description Single Vessel Rule Tide Type Moving Vessel LOA Moving Vessel Beam Moving Vessel Capacity Moving Vessel Draft Moving Vessel Class ID Other Vessel LOA Other Vessel Beam Other Vessel Capacity Other Vessel
Draft NOTE: Entries are only required where “YES” is marked in the fields below
Draft Limit Current
Limit
LOA Limit Current
Limit
Directional Draft
Limit Current Limit
20
21
22
Directional Draft
Limit LOA Limit
24
Draft Plus Tide To
Max Draft
Beam Reach
Width Limit
Draft Exceeds
Depth Using Tide /
Underkeel
Vessel Class
Beam Limit
Vessel Class LOA
Limit
Draft Limit V1 OR
Draft Limit V2
25
26
27
28
29
30
YES
Current
YES
Current
YES
Current
YES YES
YES
YES
YES
Current
Tide
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
151 Other Vessel ClassID Appendix B  HarborSym Vessel Traffic Rules Thispageintentionallyleftblank.
152 Appendix C HarborSym Output Files C.1 Setting Output Controls Theoutputcontrolssettingsofthescenarioeditorscreen(Section8.1)allowstheusertodetermine
whichdetailsfromthescenariowillbestoredandreportedafterthesimulationiscomplete.Users
havetheoptionforthisinformationtobegeneratedastext/CSVfilesandalsotobestoredina
MicrosoftAccessdatabase.Pressing“FileSettings”onthescenarioeditorwilllaunchtheoutput
controlsettingswindow.Thistablecontainsadescriptionofthebelowlistedfiles,includingthefile
suffix.Theusercanselecttooutputdatatofiles(select“OutputControlFlag”,asshowninFigure113),
whichwillgeneratetextandCSVfiles,and/ortooutputdatatodatabase(select
“MDBOutputControlFlag”),whichwillgeneratethesameinformationinadatabase.
Figure 113: Output Control Settings Thisdatabasewillbecreatedinthedirectorywheretheprojectfilesarestored,andwillhavethefile
extension.SODA.ThedatabasecanbeopenedusingMicrosoftAccess.Foradditionalinformationon
theOutputControlSettingsseeTable13.
153 Appendix C  HarborSym Output Files Table 13: Output Control/Settings OutputControl
Tag ID Description FileSuffix Generation
1 Debug debug information .dbg Debug file Information ‐ not generally user‐friendly 0
0 99
2 Echo echo of input .ech One time, after 0
reading input data 0 99
3 VesselMovement vessel movement file for HSAM animation .vmf On each vessel 0
movement 0 99
4 Event sequential time series file .evn listing discreet events during the simulation Within 0
simulation on relevant events 0 99
5 Reach snapshot of the status of vessels in reaches .rea Within 0
Simulation, at the time that a vessel enters or leaves a reach 0 99
6 Vessel vessel detailed summary, .ves Within 0
simulation, generated when a vessel call departs the system 0 99
7 Rule not designed for use by end‐
users, used for checking of rule operation .rul Within 0
Simulation, when rule tests are made (vessel enters leg) 0 99
8 RuleViolation Detailed information on each _RuleViolation.cs Within 0
rule violation v Simulation, when rule tests are made (vessel enters leg) 0 99
9 DraftAdjustment Information on draft adjustments made at dock when needed 0 99
10 Commodity List of totals of commodity _Commodity.csv At end of each ‐1
imports/exports by iteration commodity type and iteration ‐1 99
11 TimeStep Report of system status _TimeStep.csv (number of vessels in system, total times for waiting, etc.) by time step within iteration 0 99
12 DeletedVesselCall Information on deleted vessel _DeletedVesselCa Within ‐1
calls ll.csv Simulation, when vessel call is deleted due to delay beyond limits ‐1 99
13 NodeConstraint reports on constraints when testing availability of docks, turning area, facility node 0 99
14 Usage reports actual usage of docks, _Usage.csv turning areas, facility nodes 0 99
15 NodeScheduling reports on the kernel 0 99
154 OutputControl MDBOutput
SortOrder Flag ControlFlag _DraftAdjustmen At dock 0
t.csv departure when outbound draft is calculated Within simulation, at uniform time step 0
_NodeConstraint. Within 0
csv simulation, at time of availability test Within 0
simulation, on turning basin, facility node, or dock departure _NodeScheduling Within 0
Appendix C  HarborSym Output Files OutputControl
Tag ID Description FileSuffix Generation
scheduling of docks, turning areas, facility nodes, .csv simulation, when scheduling of nodes takes place Iteration summary _Iteration.csv 1 row per iteration 16 Iteration 17 VesselClassStatistics End of simulation information _VesselClassStati End of on various average vessel stics.csv Simulation time statistics, by vessel class 18 VesselCall Information on each vessel call, at completion of vessel call 19 VesselCallProblem Information on rules/capacity _VesselCallProble within violations/draft adjustments m.csv simulation, for a vessel call when rule violation or constraint noted 20 OutputControl MDBOutput
SortOrder Flag ControlFlag
‐1
‐1 1
0
0 99
within 0
simulation, per vessel and iteration 0 99
0
0 99
UnitOfMeasure Commodity summary by unit _UnitOfMeasure. at end of each 0
of measure, iteration csv iteration 0 99
21 DraftAdjustment2 Detailed information on draft _DraftAdjustmen within adjustments / exceptions t2.csv simulation, at draft adjustment 0 99
22 VesselsRemainingInS Vessel call info on vessels _VesselsRemaini within ‐1
ystem remaining in system at end of ngInSystem.csv simulation, end iteration (separate for priority of each run and regular runs) (priority and total) for each iteration 0 99
23 WaitCause CheckLeg Wait Causes for each test _WaitCause.csv within 0
simulation, at each check leg for each iteration 0 99
24 WaitCause2 CheckLeg Wait Causes Summary _WaitCause2.csv within 0
simulation, at each check leg for each iteration 0 99
25 RouteGroupStatistic End of simulation information _RouteGroupStat End of s on various average route istics.csv simulation group statistics 0 99
_VesselCall.csv 0
0
155 Appendix C  HarborSym Output Files C.2 ASCII Output Files Therearemultiplefilesdesignedtoassisttheuserandtracktheoutputofsimulations.Thefilesare
thesummary(print)file,vesseloutputfile,theeventoutputfile,thedebugoutputfile,thereach
outputfile,thepost‐processinganimationfile,thedetailedvesselfile,andtherules/debugoutputfile.
Theoutputfilescontaintheportnameandthestudynameintheirheading.Althougheachhasa
uniquefilename,thesearealltextfilesandcanbeopenedwithanytexteditor.Followinga
simulation,theusercanlocatethesefilesinthesamelocationastheprojectdatabases.Eachtimea
simulationisrunwiththesamescenarioname,thefilesarerecreatedandpreviousfilesare
overwritten.Withtheexceptionofthesummaryfile,thesefilesareprimarilyusedfordetailed
investigationanddebugging,andarenotformattedforuserreporting.Notethat,forlongsimulations
withmanyvessels,thesefilescangrowverylarge,inparticularthedebug,event,rule,andreachfiles.
C.2.1 Summary File .prn Thesummaryfile,identifiedbythe.prnextension,providesusefuloverviewstatisticsofthe
simulation.Anannotated.prnfileisincludedinSectionC.5.
C.2.2 Vessel Output File .ves Thisfilecontainsalistingofthetransitsofeachvessel.TheLegofeachtransitbythevesselislisted.A
legisavesseltransitfromentrancetodestination,atransitbetweendestinationswithintheharbor,
oratransitfromdestinationtotheharborexit.
C.2.3 Event Output File .evn Thisfilelistseacheventsequentially.Thefirstcolumnistheiterationnumberandthesecondcolumn
isthetimeoftheevent,listedbythenumberofhourssincethestartofthesimulation.
C.2.4 Reach Output File .rea Thisfileliststheentrancetimeandexittimeofeachreachtransitbyeachvessel.
C.2.5 Debug Output File .dbg Thisfilelistseachcalculationduringthecourseofasimulation.Theincrementsofcommoditytransfer
andthetransittimecalculationsforeachvesselareshown.
C.2.6 Rule Violation .rul Thisfilelistsruleviolationsbylegtransitedbyeachvessel.
Check
Leg
AShip
Protocol
Run:
N
Leg
Entry
Time:
26.000
End
Check
Leg
Rule
Violations:
0
Segment
Start:
0
C.2.7 Echo of Input .ech Thisfilelistsanechooftheinputdata.
156 VCall:
V
Leg:
LegBlock:
Blocking
Number:
End:
Farthest
Segment:
Appendix C  HarborSym Output Files C.2.8 Vessel Movement .vmf ThisfileisthevesselmovementfileforHSAManimation.
C.2.9 Error File.err Thisfileprovidesanoverviewofthemodelinputsusedduringthesimulation,includingnumberof
reaches,nodes,docks,commoditycategories,commoditytransfers,etc.Thereportwillalsooutline
errorsandwarningsthatmayimpactthemodel’sfunctionality.Itshouldbenotedthatthisreport
doesnotprovideacomprehensivereviewofalldataissuesthatmaycauseproblemswiththe
simulation.TheDataValidator(Section5.7.5and6.11)providesapre‐processingdatareview.
C.3 .csv Files in Excel® and Access® Format ThesimulationrunsresultinseveraldetailedoutputfileswhichtheusercanreviewinMicrosoftExcel
orAccess.AsshowninFigure113,theusercanrequestthedetailedoutputtobegeneratedin.CSV
format,inanAccessdatabase,orboth.Thefilescontainthesameinformationinthe.csvformatorthe
Access.SODA;theselectionofoneformatoveranotherissimplyamatterofuserpreference.The
detailedinformationcontainedinthesefilesisbestusedforunderstandingbehaviorofspecific
vesselsortrafficpatterns.Assuch,manyofthesefilesarebestusedforsingleiterationtesting.
C.3.1 Iteration .csv Thisfilecontainsthesameinformationasinthesinglescenarioreport,brokenoutbyiteration.Note
thatinorderfortheVesselTimegraph(availableafterrunningthesimulationunderthe
Output/Graphsmenuoption)todisplaythecorrectaveragevesseltime,theusermustselectthe
‘Iteration.csv’outputoptionwhenrunningthesimulation.
HEADING
DESCRIPTION
Iteration
Numberofiteration,startingatoneforthefirstiteration
Calls
Numberofvesselscallingonharborduringiteration
Exiting
Number ofvesselsexitingharborduringiteration
Deleted
Numberofvesselsdeletedduringiteration
TotalTimeInSystem
Totaltimeallvesselsspentintheharbor
TotalTimeInReaches
Totaltimeallvesselsspentinharborreaches
TotalTimeDocking
Total timeallvesselsspentdocking
TotalTimeUndocking
Totaltimeallvesselsspentundocking
TotalTimeLoadingUnloading
Totaltimeallvesselstransferringcommodities
TotalTimeTurningBasin
Totaltimeallvesselsspentinturningbasins
TotalTimeWaitingAtEntrance
Totaltimeallvesselsspentwaitingtoenterharbor
TotalTimeWaitingAtDock
Totaltimeallvesselsspentwaitingtoleavedocks
157 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
TotalTimeWaitingAtTurningBasin
Totaltimeallvesselsspentwaitinginturningbasins
TotalTimeWaitingAtFacilityNodes
Totaltimeallvesselsspentwaitinginfacilitynodes
TotalVesselTimeWaitingAllSources Totaltimeallvesselsspentwaitinganywhere
TotalTime
Totaltimeallvesselsspentanywhere
TotalCommodityTonsExport
Totaltons forallcommoditiesexported
TotalCommodityTonsImport
Totaltonsforallcommoditiesimported
TotalCommodityTons
Totaltonsforallcommoditiesimportedandexported
TotalCommodityValueExport
Totalvalueforallcommoditiesexported
TotalCommodityValueImport
Totalvalue forallcommoditiesimported
TotalCommodityValue
Totalvalue forallcommoditiesimportedandexported
TotalCostPort
Totalcostforallvesselswhileinport
TotalCostAtSea
Totalcostforallvesselswhileatsea
TotalOverallCost
Totaloverallcostforallvesselswhileatseaandinport
AverageVesselTime
Averagetimeavesselspentintheharbor
MaxVesselTime
Maximumtimeanyvesselspentintheharbor
MinVesselTime
Minimumtimeanyvesselspentintheharbor
SDVesselTime
Standarddeviationoftimespentbyvesselsinharbor
TotalAllocatedCostToPort
Totalcostallocatedtosubjectport,expressedin1,000s
TotalVoyageCostAllocatedtoPort
Totalat‐seavoyagecostallocatedtosubjectport,expressedin
1000s
C.3.2 RuleViolation.csv TheRuleViolationfilelistsalldetailsofvesseltrafficruletriggersthatoccurredduringthesimulation.
Thescenarionameandprojectsimulatedareincludedintheoutputfilename.Theruleviolationdata
providedislistedbelowbycolumnheading.
HEADING
DESCRIPTION
Iteration
Numberoftheiteration,startingatoneforthefirstiteration
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun
158 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
(0ifnotpriorityrun,1ifpriorityrun)
CurrentTime
Timemeasurementinhoursoftimeintoiteration
Situation
Descriptionofvesselsituationwhenrulewastriggered(arrival,DD=
dockdelay,FD=facilitydelay)
Location
Specificnode where vesselwaslocatedwhenruletriggeroccurred
MVVesselCallID
VesselcallIDnumberofthemovingvessel
MVVesselNumber
Externalidentifiernumberofthemovingvessel
MVName
Nameofthemovingvessel
Reach
Reachnumberforthereach wheretheruleviolationoccurred
ReachDescription
Nameofreach wheretheruleviolationoccurred
RuleNumber
Numberofthevesseltransitruletriggered
PortRule
Y/Nflagtoindicateifaportlevelrulewastriggered
TransitRuleNumber
Rulenumberofruleimplementedforthereach
RuleDescription
Descriptionoftheruleviolated
ApplicableCondition
Theconditionforruleapplicationpreviouslyselectedbytheuser
MVLOA
LOAofthemovingvessel,infeet
MVBeam
Beamofthemovingvessel,infeet
MVCapacity
Capacityofthemovingvessel,unitsasexpressedinvesselcalllist
MVDraft
Draftofthemovingvessel,infeet
MVType
Vesseltypenameofthemovingvessel
MVClassID
VesselclassIDnumberofthemovingvessel
MVClass
Vesselclassofthemovingvessel
MVUnderkeel
Underkeelclearance allowedforthemovingvessel,infeet
OVVesselCallID
VesselcallIDnumberoftheothervessel (‐1default)
OVVesselNumber
IdentifierNumberoftheOtherVessel
OVName
NameoftheOtherVessel
159 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
OVLOA
LOAoftheOtherVessel,infeet
OVBeam
BeamoftheOtherVessel,infeet
OVCapacity
CapacityoftheOtherVessel,unitsasexpressedinvesselcalllist
OVDraft
DraftoftheOtherVessel,infeet
OVType
TypeoftheOtherVessel
OVClassID
IDnumberoftheVesselClass
OVClass
ClassoftheOtherVessel
Status
0indicatesnoconflict(noothervesselisinvolved)
1indicatespassing(2vesselsmovinginoppositedirections)
2indicatesovertaking(2vesselsmovinginthesamedirection)
3indicatesovertaken(2vesselsmovinginthesamedirection)
OVPriority
0fornon‐protocol,1forprotocolvessel
RuleParameter1,2,3
Parametersoftheruletriggered
MVReachEntryTime
SimulationTimeThatMovingVesselEntersReach
MVReachExitTime
SimulationTimeThatMovingVesselExitsReach
ReachWidth
WidthofReachWhereRuleViolationOccurred,infeet
ReachDepth
DepthofReachWhereRuleViolationOccurred,infeet
MinimumTide
Minimumdepthavailabilityduetotide,infeet
MaximumTide
Maximumdepthavailabilityduetotide,infeet
Message
Descriptionofruletriggerconditions
C.3.3 Draft Adjustment.csv ThisExcelspreadsheetliststhedetailsofdraftchangesinvesselsthatexceedtheminimumor
maximumdraftfortheirvesselclass.Thecolumnheadingsarelistedbelow.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Time
Hoursintosimulationstartingatone
160 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
VesselCallID
IDnumberofvesselcall,assignedbyHarborSym
VesselNumber
IDnumberofthevesselinthevesselcall
VesselClass
Vesselclassificationofthevesselinthevesselcall
VesselName
Nameofvesselinvesselcall
Dock
Nameofdock
DockVisit
DockvisitID,notusedatthistime
BarArrivalDraft
Draftwhenarrivingatbar,infeet
DockArrivalDraft
Draftwhenarrivingatdock,infeet
TonsCommodityTransfer
Tonsofcommodityimported/exported
TPI
Tonspersquareinchimmersionfactor
DraftChange
Changeindraft(feet)resultingfromcommoditytransfer
TentativeDraft
Tentativecalculateddraft,infeet
FinalDraft
Finaldraftafteradjustment,infeet
ClassMinimumDraft
MinimumDraftforVesselClassification,infeet
ClassMaximumDraft
MaximumDraftforVesselClassification,infeet
UnderkeelClearance
UnderkeelClearance forVesselClassification,infeet
NextLegCriticalValue
Draftfornextcriticalleg,infeet
MinControllingValueNext
Leg
Minimumvalueallowedatnextleg
Message
Detailedmessagearea
C.3.4 DeletedVesselCall.csv Thisfileprovidesalistofthevesselcallsdeletedbecausethevesselwasunabletomoveafterthe
specifiednumberofretries.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Time
Hoursintosimulation,infractions
161 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
PriorityRun
Indicateswhetherthecallispriorityrunvessel
VesselCallID
ThevesselcallIDNumber
VesselName
Nameofvesseldeletedinthevesselcall
Situation
Whatisoccurringtocausevesselcalltobedeleted
Location
Locationofvesselwhenvesselcalldeleted
InitialDraft
Initialdraftofvessel,infeet
CurrentDraft
Currentdraftof vessel,infeet
NextLegCriticalValue
Availablesailingdepthfornextcriticalleg,infeet
Route
Detailsonvesselroute
C.3.5 Commodity.csv Thisfileliststhetotalimportsandexportsofeachcommoditycategoryduringeachiteration.Thisfile
isusefulindeterminingthatallcommoditiesinthevesselcalllistareproperlyimportedandexported.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Commodity
Nameofcommoditycategory
ActualImportInIteration
Totaltonsofcommoditycategory importedduringiteration
TotalImportInVCDB
TotalTonsofCommodityImportedinVesselCallList
ActualExportInIteration
Totaltonsofcommoditycategory exportedduringiteration
TotalExportInVCDB
TotalTonsofCommodityExportedinVesselCallList
C.3.6 VesselClassStatistics.csv Thisfileliststheaverage,minimumandmaximumforeachstatisticforeachvesselclass.
HEADING
DESCRIPTION
Statistic
DescriptionofStatistic
Class
NameofVesselClass
ID1
Additionaldetailssuchascommodityunits
162 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
N
NumberofExitingVesselsofEachVesselClass
Average
AverageoftheStatistic
SD
StandardDeviationoftheStatistics
Maximum
MaximumoftheStatistic
Minimum
MinimumoftheStatistic
AvgCost
AverageCostfortheStatisticandVesselClass
SDCost
Standarddeviationof CostfortheStatisticandVesselClass
MaxCost
Maximum CostfortheStatisticandVesselClass
MinCost
Minimum CostfortheStatisticandVesselClass
C.3.7 VesselCall.csv Thisfilelistsdetailedinformationforeveryvesselcall.TheroutereportedintheVesselCall.csvfileis
nottheactualroutetakenbythevessel,butthecalculatedsetofkeynodes(entry,docks,turning
basins,exit)tobevisitedatthestartofthevesselcall.Anchoragesarenotincludedinthis,because
anchoragevisitsarecalculatedwithinthesimulation.Toviewthecompleterouteincluding
anchorages,pleaseseetheEventOutputfile(evn).
HEADING
DESCRIPTION
Iteration
NumberofIteration
PriorityRun
0ifnotpriorityrun,1ifpriorityrun
PriorityVessel
0ifnotpriorityvessel,1ifpriorityvessel
Name
NameofVessel
Class
ClassofVessel
Route
Routegroupforvesselcall
PriorPortDistance
Distanceofpriorport,innauticalmiles
NextPortDistance
Distanceofnextport,innauticalmiles
AdditionalSeaDistance
Additionalseadistance,innauticalmiles
VesselCounter
CountofVesselsWithinIteration
VesselCallID
VesselCallIDNumber
163 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
VesselID
VesselIDNumber
NumberofDockVisits
Numberofdifferentdocks visitedwithinavesselcall
ArrivalTime
SimulationTimethatVesselArrivesatHarbor
EntryTime
SimulationTimethatVesselBeginsTransitThroughtheFirstReach
ExitTime
SimulationTimethatVesselExitsHarbor
NetTime
DifferenceBetweenEntryTimeandExitTime,inhours
TotalTime
NotUsed
DelayCount
Countoftimesvesseldelayed
TimeWaitingDock
AmountofTimeSpentWaitingtoLeavetheDock,inhours
TimeAtDock
AmountofTimeSpentLoadingAndUnloading,inhours
TimeDocking
AmountofTimeSpentDocking,inhours
TimeUndocking
AmountofTimeSpentUndocking,inhours
TimeWaitatEntry
AmountofTimeBetweenArrivalandEntry,inhours
TimeAtTurningBasin
AmountofTimeSpentTurning,inhours
TimeWaitingFacility
Node
AmountofTimeSpentWaitingatAnchorages,inhours
TimeTotalInReaches
AmountofTimeSpentTransitingThroughReaches,inhours
TimeatSea
AmountofTimeSpentatSea,inhours
TotalSeaDistance
TotalSeaDistanceTraveled,innauticalmiles
SpeedatSea
AverageSpeedatSea,inknots
TimeCostatSea
TimeatSeaCostApplied,inhours
TimeCostinPort
TimeinPortCostApplied,inhours
TotalTimeCost
TotalTimeCostApplied,inhours
ExportTons
TotalTonsExported
ImportTons
TotalTonsImported
TotalTons
TotalCombinedTonsImportedandExported
164 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
RetainedTonnage
TonnageRetainedonVessel
ExportValue
ValueofExports
ImportValue
ValueofImports
TotalValue
TotalCombinedValueofExportsandImports
RetainedValue
ValueRetainedonVessel
ETTC
Estimate of totaltripcargo,definedasquantityonboardthevesselat
arrivalpluscargoonboardthevesselatdeparture
HourlyCostInPort
PerHourCosttoVesselWhileinPort
HourlyCostAtSea
PerHourCosttoVesselWhileatSea
ArrivalDraft
Draftof VesselWhenArrivingatPort,infeet
DepartureDraft
DraftofVesselWhenDepartingPort,infeet
TotalOutboundTonnage
TonnageofVesselWhenDepartingPort
ImportShareWeightBy
RouteGroup
PercentofImportsforRouteGroup
ImportCostAllocation
Share
FractionofImportCosts AssociatedwithAt‐SeaCoststobeAllocatedto
SubjectPort
ExportCostAllocation
Share
FractionofExportCostsAssociatedwithAt‐SeaCoststobeAllocatedto
SubjectPort
SeparableCost
CoststhatAreFullyAllocated toSubjectPort
AllocatedImportCosts
ImportCostsAllocatedtoSubjectPort(timecostatseatimesimportcost
allocationshare)
AllocatedExportCosts
ExportCostsAllocatedtoSubjectPort(timecostatseatimesexportcost
allocationshare)
VoyageCostsAllocatedto
SubjectPort
Weightedaveragevoyagecosts allocatedtosubjectport,averageof
allocatedimportcostsandallocatedexportcosts
AllocatedTotalCostTo
SubjectPort
TotalCosttoVesselAllocatedtoPortofStudy,sumofweighted voyage
costsandseparablecosts
TimeCostInReaches
CostsAssociatedwithWaitingTimeatReaches
TimeCostWaitingAt
Entry
CostsAssociatedwithWaitingTimeatEntry
165 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
TimeCostDocking
CostsAssociatedwithDockingTime
TimeCostUndocking
CostsAssociatedwithUndockingTime
TimeCostAtDock
CostsAssociatedwithTimeatDocks
TimeCostWaitingAtDock CostsAssociatedwithWaitingTimeatDocks
TimeCostWaitingAt
TurningBasin
CostsAssociatedwithWaitingTimeatTurningBasin
TimeCostAtTurning
Basin
CostsAssociatedwithTurningTime
TimeCostWaitingAt
FacilityNode
CostsAssociatedwithWaitingTimeatFacilityNodes
CostTotalPort
TotalCostWhileinPort,totalvoyage
CostTotalAtSea
TotalCostWhileatSea,totalvoyage
CostOverallTotal
TotalOverallCost forVoyage
Foreign
IndicatorofForeignVessel
VesselPath
PathTraversedbyVessel
C.3.8 NodeConstraint.csv Thisfilereportsonconstraintswhentestingavailabilityofdocks,turningareasandfacilitynodes.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Time
Hoursintosimulation,infractions
Protocol
0ifnotprotocolvessel,1ifprotocolvessel
Priority
NotUsed
VesselCallID
VesselCallIDNumber
Leg
Indicateswhethervesselislocatedinleg
Vessel
Nameofvesselcall
Class
NameofVesselClass
VSU
Numberofvesselsizeunits
166 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Loaded
Indicateswhethervesselisloaded
Draft
Current draftof vessel,infeet
TestDraft
Draft(feet)aftercommoditytransferbasedonTPIandexitingload
Underkeel
Indicatestheminimumclearanceavailablebetweenthedeepestpointon
thevesselandthebottominstillwater
Facility
Nameoffacility
Type
Typeoffacility
Depth
Depthofvesselinwater
MinTide
DepthAdjustment
Capacity
Capacityofvessel
Vessels
Numberofvessels
VSUCapacity
Capacityofvesselsizeunits
VSUCapacityUsed
Amount ofcapacityusedinvesselsizeunits
Code
Capacitycode
C.3.9 NodeScheduling.csv Thisfilereportsonthekernelschedulingofdocks,turningareas,andfacilitynodes.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Time
Hoursintosimulation,infractions
Protocol
0ifnotprotocolvessel,1ifprotocolvessel
Priority
NotUsed
VesselCallID
VesselCallIDNumber
Leg
Indicateswhethervesselislocatedinleg
Vessel
Nameofvesselcall
Class
NameofVesselClass
VSU
NumberofVesselSizeUnits
167 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Facility
Nameoffacility
Type
Typeoffacility
Capacity
Capacityofvessel
CapacityVSU
CapacityofVesselSizeUnits
VesselsInFacility
Numberofvesselsinfacility
VesselsWaitingInFacility
Numberofvesselswaitinginfacility
VSUUsed
VesselSizeUnitsused
EntryTime
SimulationTimethatVesselBeginsTransitThroughtheFirstReach
ExitTime
SimulationTimethatVesselExitsHarbor
C.3.10 TimeStep.csv Thisfilereportsonsystemstatus(numberofvesselsinsystem,totaltimewaiting,etc.)bytimestep.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Time
Hoursintosimulation,infractions
VesselInSystem
Numberofvesselsinsystem
EntryWait
AmountofTimeBetweenArrivalandEntry
InReach
Indicateswhetheravesselislocatedinareach
Dock
Indicateswhetheravesselislocatedatadock
DockWait
Indicateswhetheravesseliswaitingatadock
TurningBasin
Indicateswhetheravesselislocatedinaturningbasin
TurningBasinWait
Indicateswhetheravesseliswaitingataturningbasin
FacilityNode
Indicateswhetheravesselislocatedatafacilitynode
FacilityNodeWait
Indicateswhetheravesseliswaitingatafacilitynode
TotalVesselTime
Totaltimevesselspentatport
TotalTonsLoaded
Numberoftonsloadedontothevessel
168 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
TotalTonsOffLoaded
Numberoftonsoffloaded
TotalCommodity
Numberoftonsofcommodityoffloaded
CommodityPerTime
Amountofcommodityoffloadedpertime
C.3.11 Usage.csv Thisfilereportstheactualusageofdocks,turningareas,facilitynodes.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Protocol
0ifnotprotocolvessel,1ifprotocolvessel
Priority
NotUsed
VesselCallID
ThevesselcallIDNumber
Leg
Indicateswhethervesselislocatedinleg
Vessel
NameofVesselCall
Class
NameofVesselClass
VSU
VesselSizeUnits
Node
Nameofthenode
Type
Typeofportstructure
EntryTime
SimulationTimethatVesselBeginsTransitThroughtheFirstReach
ExitTime
SimulationTimethatVesselExitsHarbor
VesselTotal
Thetotalnumberofvessels
VSUTotal
Thetotalnumberofvesselsizeunits
CapacityCode
Capacitycode
C.3.12 VesselCallProblem.csv Thisfilereportsprovidesinformationonrules,capacityviolationsanddraftadjustmentsforavessel
call.
HEADING
DESCRIPTION
169 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Protocol
0ifnotprotocolvessel,1ifprotocolvessel
Time
Hoursintosimulation,infractions
VesselCallID
ThevesselcallIDNumber
VesselName
Nameofvessel
Class
NameofVesselClass
Beam
LengthofVesselBeam,infeet
LOA
OverallLengthofaVessel,infeet
Capacity
Capacityofthevessel,asexpressedinvesselcalllist
TPI
Thenumberoftonsthatcanbeplacedonavesseltocausethevesselto
sinkbodilyinthewaterbyoneinch
InitialDraft
Draftenteringharbor,infeet
CurrentDraft
TestDraftorMaximum/MinimumDraftforVesselClass,infeet
ProblemType
Thevesselcallproblemtype
Status
0indicatesnoconflict(noothervesselisinvolved)
1indicatespassing(2vesselsmovinginoppositedirections)
2indicatesovertaking(2vesselsmovinginthesamedirection)
3indicatesovertaken(2vesselsmovinginthesamedirection)
Detail
Detailsconcerningthevesselcallproblem
Message
Messageregardingthevesselcallissue
170 Appendix C  HarborSym Output Files C.3.13 VesselsRemainingInSystem.csv This file reports information on vessels remaining in system at end of iteration
.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
Protocol
0ifnotprotocolvessel, 1ifprotocolvessel
Priority
NotUsed
Name
NameofVessel
Class
NameofVesselClass
Count
CountofVesselsWithinIteration
CallID
VesselCallIDNumber
VesselID
VesselIDNumber
NumberOfDockVisits
Numberofdifferentdocks visitedwithinavesselcall
ArrivalTime
SimulationTimethatVesselArrivesatHarbor
EntryTime
SimulationTimethatVesselBeginsTransitThroughtheFirstReach
ExitTime
SimulationTimethatVesselExitsHarbor
NetTime
DifferenceBetweenEntryTimeandExitTime
TotalTime
NotUsed
WaitingDock
AmountofTimeSpentWaitingtoLeavetheDock
AtDock
AmountofTimeSpentLoadingAndUnloading
Docking
AmountofTimeSpentDocking
Undocking
AmountofTimeSpentUndocking
WaitAtEntry
AmountofTimeBetweenArrivalandEntry
AtTurningBasin
AmountofTimeSpentTurning
WaitingFacilityNodes
AmountofTimeSpentWaitingatFacilityNodes
TotalInReaches
AmountofTimeSpentTransitingThroughReaches
171 Appendix C  HarborSym Output Files C.3.14 WaitCause.csv Thisfiledocumentsvesseltime,location,andcauseofvesseldelays.Multipleentriesforthesame
vesselcallatidenticaltimestampsindicatemorethanonerulewastriggeredandcausedthedelay.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun(0
ifnotpriorityrun,1ifpriorityrun)
PriorityVessel
Flagtoindicateiftheindividualvesselisidentifiedasapriorityvessel(0if
notpriorityvessel,1ifpriorityvessel)
CurrentTime
Timestampofruleviolation/trigger
VesselCallID
VesselCallIDNumber
RuleTypeNumber
Ruletypethatcausesthedelay
ReachNumber
Reachwhererulewastriggered
RuleType
Generalruletype
WaitIncrement
Durationofdelay
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode in
network)
DelayCounter
Countofdiscretenumberoftimesthevesselisplaceinwaitstatus
C.3.15 WaitCause2.csv Thisfiledocumentsvesseltime,location,andcauseofvesseldelaysingreaterdetailthanthe
WaitCause.csvfile.Thenumberoftriggersisidentifiedbyspecificcause,asdefinedinTable2.
Thisfileisgeneratedduringthesimulationandisarecordofdelaysincurredbyallvesselsentering
thesystem–includingdeletedvesselcallsandvesselsremaininginthesystemattheendofthe
simulation.Assuch,theresultofsummingthe“WaitIncrement”fieldinthistablemaynotmatchthe
totaldelaysreportedinthe.prnorothersummaryfiles.Tomatchtheoutputs,removedelays
incurredbydeletedvesselcallsorvesselsremaininginthesimulation.Twoqueriesinthe.SODAfile
(SectionC.4)providefilteredversionsoftheWaitCause2file.
172 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun
(0ifnotpriorityrun,1ifpriorityrun)
PriorityVessel
Flagtoindicateiftheindividualvesselisidentifiedasapriorityvessel(0
ifnotpriorityvessel,1ifpriorityvessel)
CurrentTime
Timestampofruleviolation/trigger
VesselCallID
VesselCallIDNumber
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode in
network)
DelayCounter
Countofdiscretenumberoftimesthevesselisplaceinwaitstatus
WaitIncrement
Durationofdelay
TotalCauses
Numberofrule/reach combinationscontributingtothedelay
CombinedCode
Numericalrepresentationofcombineddelaycode
CombinedString
CombineddelaycodeusingtheabbreviationsinTable2
VSC,C,BZ,T,AVSU.AVN.AD, Generalruletype,asdefinedin Table2;numberentryrepresentsthe
numberofruletriggersofthattypecontributingtothedelay
TAVN,TAD,TAVSU,DVSU,
DVN
C.3.16 UnitOfMeasure.csv Ascommoditiesaretransferredateachdockvisitofeachvesselcall,HarborSymstorestheunits
transferred,tonstransferred,andvaluetransferredforeachcommoditytransfer.Unitsofmeasurefor
eachcommodity,valueperunit,andtonsperunitaredefinedbycommoditycategory.Acalculated
costisalsodeterminedforeachvesselcall,basedontimespentinthevariousphasesofactivityatthe
portandatsea,whenthevesselexitsthesystem.Attheendofeachiteration,informationis
presentedintheunitofmeasurefilethatrollsupthisinformationforeachdistinctunitandvessel
class,aswellasprovidingtotalsbyunit.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
UnitOfMeasure
Unitofmeasure(Tons,Passengers,Containers,etc)
173 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
VesselClass
Vesselclassificationofthevesselinthevesselcall
UnitsImported
Numberofcommodityunitsimported
UnitsExported
Numberofcommodityunitsexported
TotalUnits
Numberofcommodityunitsimportedplusexported
ValueImported
Dollarvalueofcommoditiesimported
ValueExported
Dollarvalueofcommoditiesexported
TotalValue
Dollarvalueofcommoditiesimported/exported
TonsImported
Totaltonsimported
TonsExported
Totaltonsexported
TotalTons
Totaltons,sumoftotaltonsimportedandtotaltonsexported
AllocatedCostByImportTons
Portionoftotalvoyagecostsallocatedtoimporttonnagetransferred
AllocatedCostByExportTons
Portionoftotalvoyagecostsallocatedtoimporttonnagetransferred
TotalCostByTonsCheckSum
Sumofallocatedcostsbytons(importandexport)
AllocatedCostByImportValue Portionoftotalvoyagecostsallocatedtoimportvaluetransferred
AllocatedCostByExportValue Portionoftotalvoyagecostsallocatedtoexportvaluetransferred
TotalCostByValueCheckSum
SumofAllocatedCostbyvalue(importandexport)
CostPerTonImport
AllocatedCostByImportTons/TonsImported
CostPerTonExport
AllocatedCostByExportTons/TonsExported
CostPerTonTotal
TotalCost/TotalTons
CostPerValueImport
AllocatedCostByImportValue/ValueImported
CostPerValueExport
AllocatedCostByExportValue/ValueExported
CostPerValueTotal
TotalValue/TotalTons
C.3.17 DraftAdjustment2.csv Thisoptionaloutputreportingfileprovidesdetailedinformationondraftadjustmentsmadewhen
commoditytransfersatadocktakeplace.Draftsareinternallyadjustedinthemodeltoprevent
vesselsfromgetting“stuck”atthedockduetobadorinconsistentinputdata.Thisallowsthemodel
toproceedwiththesimulation.
174 Appendix C  HarborSym Output Files Whenadraftadjustmentismadefollowingacommoditytransferatadock,thetentativedraft
(incomingdraftadjustedbycommoditytonnage‐associateddraftchange)ischeckedagainstthe
followinginturn,andacodeisappliedtoindicateifadraftadjustmentismadebasedonthe
particularconstraint.
Constraint on Tentative Draft
No Adjustment <= class‐based MaximumSailingDraft
<= Controlling Depth for next leg
<= unique vessel‐based Design Draft
>= class‐based MinimumSailingDraft
Adjustment Code
0
1
2
4
8
Thesequenceofadjustmentsisreportedinthe“ConstraintType”column.Theadjustmentcodeisa
binarycodeindicatingwhichcombinationofthe4possibleadjustmentsismade.Thecodes,andthe
orderinwhichtheadjustmentistested,areasfollows:
0=noadjustments,
1=adjusttomaxsailingdraft
2=adjusttonextlegcriticalvalue
4=adjusttodesigndraft
8=adjusttominimumsailingdraft
Thebinarycodeisthesumofeachadjustmentthatismade,thusittakesonapossiblerangefrom0to
15,butnotallcombinationsarelogical,assumingrationalvaluesfordesignandclassdrafts.
Thisfileisacompaniontothe_DraftAdjustment.csvfile,providingsomeadditionalinformationina
slightlydifferentformat,toallowforcheckingofthedraftadjustmentprocess.Outputcaneasilybe
filteredforasinglevesseltoshowthedraftchangesandadjustmentsthroughthevesselcall,from
arrivaltoeachdockvisit.
HEADING
DESCRIPTION
Iteration
IterationNumber
Time
CurrentTime(decimaldaysfromstartdate)
PriorityRun
1=priorityrun,0=non‐priorityrun
VesselCallID
VesselCallID
Dock
DockCode
DockOrder
OrderofDockVisitinvesselcall(‐1ifsituationisreportedatarrival
atthebar,0forfirstdock,1for2nddockvisited,etc.)
ArrivalDraft
Arrivaldraftinfeetatthelocation(bar,dock)
175 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
NetTonnageTransfer
Nettonnagetransferacrossallcommoditiestransferred(importto
theportispositive,exportfromportisnegative)
TPI
TPIfactorforvessel(tonsperinch)
PreConstraintCalculatedDraft CalculateddraftbasedoncommoditytransferandTPI,infeet
PostConstraintRevisedDraft
Draftafterapplyingconstraints,infeet
Situation
ArrivalorDock
ConstraintType
Textdescriptionofadjustment(s)made
AdjustmentCode
Binaryadjustmentcode
ImpliedTonnageAdjustment
Totalimpliedtonnagechangegiventhedraftadjustment,basedon
TPI(positiveimpliesadditionalcargoonboard,negativeimplies
reducedcargoonboard)
C.3.18 RouteGroupStatistics.csv Thisfileliststheaverage,minimumandmaximumforeachstatisticforeachroutegroup.
HEADING
DESCRIPTION
Statistic
DescriptionofStatistic
RouteGroup
NameofRouteGroup
ID1
Additionaldetailssuchascommodityunits
ID2
Additional details
Observation
Numberofobservationsusedtocreatestatistic
StatisticAverage
Averageofthe Statistic
SD
StandardDeviationoftheStatistics
StatisticMax
MaximumoftheStatistic
StatisticMin
MinimumoftheStatistic
C.4 .SODA Database TheAccessdatabasewiththe.SODAextensioncontainsscenario‐specificdetailedoutputfiles.The
datacontainedintheaforementioned.csvfiles(SectionsC.3.1throughC.3.17)canbeaccesseddirectly
throughthe.SODAdatabaseiftheuserselectsthe“MDBOutputControlFlag”intheOutputControl
176 Appendix C  HarborSym Output Files Settingswindow.Inadditiontothe.csvfiles,severalpre‐programmedqueriesareavailableinthe
.SODAforeasyanalysisofscenariodata.Thefollowingsubsectionsdescribethesequeries,whichcan
beviewedandmodifieddirectlyinMicrosoftAccess.
C.4.1 qryFacilityNodeUsageByPath TheFacilityNodeUsagebyPathqueryreportstheanchorageusagebyvesselcall.Thisqueryallows
theusertounderstandwhichvesselsweredirectedtoanchoragesandthedurationspentwaitingat
theanchorageforeachvesselcall.
ForthisquerytofunctiontheUsageandIndividualVesselCalloutputsmustbegeneratedduringthe
simulationusingtheMDBOutputControlflag.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun(0if
notpriorityrun,1ifpriorityrun)
PriorityVessel
Flagtoindicateiftheindividualvesselisidentifiedasapriorityvessel(0if
notpriorityvessel,1ifpriorityvessel)
Name
Vesselname
Class
Vesselclass
CallID
Uniquevesselcallidentificationnumber
VesselID
Uniquevesselidentificationnumber
NumberofDockVisits
Numberofdocksthevesselvisitsduringthisvesselcall
ArrivalTime
Timestampofvesselarrivaltothesystem
EntryTime
Timestamp ofvesselentryintothesystem
ExitTime
Timestampofvesselexitfromsystem
NetTime
Calculatedduration ofthevesselcallderivedfromthedifferencebetween
thestoredentryandstoredexittime.
TotalTime
Durationofthevesselcall
DelayCounter
Totalnumberofwaitsordelayeventsduringthevesselcall(hours)
WaitingDock
Timevesselspendswaitingatdocks(hours)
AtDock
Timevesselspendsatdocks(performingcargoexchangesorother
activitiesinnon‐delaystatus)(hours)
Docking
Timevesselspendsexecutingdockingmaneuvers(hours)
177 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Undocking
Timevesselspendsexecutingundockingmaneuvers(hours)
WaitingatEntry
Timevesselspendswaitingattheentrypoint(hours)
WaitingFacilityNode
Timevesselspendswaitingatanchorages(hours)
TotalinReaches
Totaltimevesselspendstransitingreaches(hours)
VesselPath
Thepathtakenbythevesselfromentrytoexitincludingdocksandturning
basins
Node
Nameofanchorage wherethevesselisdelayed
Type
Thetypeofnode wheredelayed(FNindicatesanchorage)
C.4.2 qryRuleViolationsWithPath TheRuleViolationswithPathqueryaddsthevesselpathtotheRuleViolationstable(SectionC.3.2).
Thisprovidesadditionaldetailsonthevessel’sintendedroutewhiledelayed.Suchinformationcanbe
usedtoascertainifvesselstransitingaparticularpatharemorepronetospecifictypesofdelays.
ForthisquerytofunctiontheIndividualVesselCalloutputsmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
HEADING
DESCRIPTION
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun(0if
notpriorityrun,1ifpriorityrun)
Class
Vesselclass
Iteration
Iterationnumber,startingatone
CurrentTime
Timestampofruleviolation/trigger
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dockdeparture,
anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode in
network)
MVCallID
CallIDofthemovingvessel
MVName
Nameofthemovingvessel
Reach
Reachwhererulewastriggered
ReachDescription
Descriptionoflocationofruleviolation
178 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
RuleDescription
Descriptionoftheruleviolated
PortRule
Y/Nflagidentifyingtheruleasaportlevelrule
TransitRuleNumber
Numberoftheruleviolated
ApplicableCondition
Day,Night,Always
MVLOA,Beam,Capacity,
Physicalparametersofthemovingvessel
Draft,Type,Class,Underkeel
Clearance
Physicalparametersoftheothervessel(applicableformultiplevessel
OVLOA,Beam,Capacity,
Draft,Type,Class,Underkeel rules)
Clearance
Status
0indicatesnoconflict(noothervesselisinvolved)
1indicatespassing(2vesselsmovinginoppositedirections)
2indicatesovertaking(2vesselsmovinginthesamedirection)
3indicatesovertaken(2vesselsmovinginthesamedirection)
OVPriority
0fornon‐protocol,1forprotocolvessel
RuleParameters
Parametersoftheruletriggered
MVReachEntry,Exit
Simulationtimethatmovingvesselenters,exitsreach
ReachWidth,Depth
Physicaldimensionsofreach whereruleviolationoccurred
Minimum,MaximumTide
Minimum/Maximumdepthavailabilityduetotide
Message
Descriptionofruletriggerconditions
VesselPath
Thepathtakenbythevesselfrom entrytoexitincludingdocksandturning
basins
C.4.3 qryWaitCause2WithoutDeletedVessels TheWaitCause2withoutDeletedVesselsqueryfilterstheWaitCause2(SectionC.3.15)tableto
removealldeletedvesselcalls.Vesselsremaininginthesystemafterthesimulationtimeendsarestill
includedinthistable.
ForthisquerytofunctiontheDeletedVesselCallandWaitCause2outputsmustbegeneratedduring
thesimulationusingtheMDBOutputControlflag.
HEADING
DESCRIPTION
179 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
CurrentTime
Timemeasurementinhoursoftimeintoiteration
VesselCallID
Uniquevesselcallidentificationnumber
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dockdeparture,
anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode in
network)
WaitIncrement
Durationofdelay
TotalCauses
Numberofrule/reach combinationscontributingtothedelay
CombinedCode
Numericalrepresentationofcombineddelaycode
CombinedString
CombineddelaycodeusingtheabbreviationsinTable2
VSC,C,BZ,T,AVSU.AVN.AD, Generalruletype,asdefinedinTable2;numberentryrepresentsthe
TAVN,TAD,TAVSU,DVSU,
numberofruletriggersofthattypecontributingtothedelay
DVN
C.4.4 qryWaitCause2WithoutDeletedOrRetained TheWaitCause2withoutDeletedVesselsorRetainedqueryfilterstheWaitCause2(SectionC.3.15)
tabletoremovealldeletedvesselcallsandallvesselsremaininginthesystemattheendofthe
simulation.ThefieldsinthistablematchthoseoutlinedinSectionC.4.3,
qryWaitCause2WithoutDeletedVessels.
ForthisquerytofunctiontheDeletedVesselCall,WaitCause2,andVesselsRemaininginSystem
outputsmustbegeneratedduringthesimulationusingtheMDBOutputControlflag.
C.4.5 qryWaitCauseWithoutDeletedVessels TheWaitCausewithoutDeletedVesselsqueryfilterstheWaitCause(SectionC.3.14)tabletoremove
alldeletedvesselcalls.
ForthisquerytofunctiontheDeletedVesselCallandWaitCauseoutputsmustbegeneratedduring
thesimulationusingtheMDBOutputControlflag.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvesselrun(0if
notpriorityrun,1ifpriorityrun)
PriorityVessel
Flagtoindicateiftheindividualvesselisidentifiedasapriorityvessel(0if
notpriorityvessel,1ifpriorityvessel)
180 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
CurrentTime
Timestampofruleviolation/trigger
VesselCallID
Uniquevesselcallidentificationnumber
RuleTypeNumber
Ruletypethatcausesthedelay
ReachNumber
Reachwhererulewastriggered
RuleType
Generalruletype
WaitIncrement
Durationofdelay
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dockdeparture,
anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode in
network)
CallID
IDnumberofvesselcall,assignedbyHarborSym
181 Appendix C  HarborSym Output Files C.4.6 qryWaitCauseWithoutDeletedOrRetained TheWaitCausewithoutDeletedorRetainedqueryfilterstheWaitCause(SectionC.3.14)tableto
removealldeletedvesselcallsandallvesselsremaininginthesystemattheendofthesimulation.
ThefieldsinthistablematchthoseoutlinedinSectionC.4.5,qryWaitCauseWithoutDeletedVessels.
ForthisquerytofunctiontheDeletedVesselCall,WaitCause,andVesselsRemaininginSystem
outputsmustbegeneratedduringthesimulationusingtheMDBOutputControlflag.
C.4.7 qsumFacilityNodeUsageByPathIteration TheFacilityNodeUsagebyPathIterationsummationqueryprovidesagroupingoftotalwaittimeat
eachanchoragebypathanditeration.
ForthisquerytofunctiontheIndividualVesselCallandUsageoutputsmustbegeneratedduringthe
simulationusingtheMDBOutputControlflag.
HEADING
DESCRIPTION
SumofWaitingFacilityNodes
Totaltimeallvesselsspendwaitingatananchorage
Node
Nameofanchorage wherethevesselisdelayed
Type
Thetypeofnode wheredelayed(FNindicatesanchorage)
Iteration
Iterationnumber,startingatone
CountofCallID
Numberofvesselcallsdirectedtotheanchorageduringtheiteration
FirstofVesselPath
Thepathtakenbythevesselfromentrytoexitincludingdocksand
turningbasins
C.4.8 qsumRuleVioloationsWithPath TheRuleViolationswithPathsummationqueryprovidesacountofthenumberofspecificrule/
reachtriggersincurredbyeachvesselcall.
ForthisquerytofunctiontheIndividualVesselCalloutputsmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
HEADING
DESCRIPTION
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvessel
run(0ifnotpriorityrun,1ifpriorityrun)
Class
Vesselclass
MVName
Nameofthemovingvessel
ReachDescription
Descriptionoflocationofruleviolation
182 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
RuleDescription
Descriptionoftheruleviolated
Iteration
Iterationnumber,startingatone
Path
Thepathtakenbythevesselfromentrytoexitincludingdocksand
turningbasins
CountofIteration
Numberoftriggersperiteration
C.4.9 qsumWaitBySituationClassNoDeletedOrRetained TheWaitbySituationClassNoDeletedorRetainedsummationqueryprovidesatotalwaittimeby
situationandvesselclass.
ForthisquerytofunctiontheIndividualVesselCall,DeletedVesselCall,WaitCause2,andVessels
RemaininginSystemoutputsmustbegeneratedduringthesimulationusingtheMDBOutputControl
flag.
HEADING
DESCRIPTION
Class
Vesselclass
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
TotalWait
Sumofdelayduration forallvesselsdelayedwithintheclass,
situation,anditeration
CountofCallID
Countofvesselcallscontributingtothetotaldelayduration
C.4.10 qsumWaitBySituationNoDeletedOrRetained TheWaitbySituationNoDeletedorRetainedsummationqueryprovidesatotalwaittimeby
situation.
ForthisquerytofunctionDeletedVesselCall,WaitCause2,andVesselsRemaininginSystemoutputs
mustbegeneratedduringthesimulationusingtheMDBOutputControlflag.
HEADING
DESCRIPTION
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
SumofWaitIncrement
Sumofdelayduration forallvesselsdelayedwithintheclass,
situation,anditeration
183 Appendix C  HarborSym Output Files C.4.11 qsumWaitCauseTotalTimeByCombinedCode TheWaitCauseTotalTimebyCombinedCodesummationqueryreportsthetotalwaitincrementby
code.Thisprovidesatotaldelaytimeforeachuniquecombineddelaycodeencounteredbyallvessels
inoneiterationcombination.ThequeryisbuiltuponqryWaitCause2(SectionC.4.3)andtherefore
willincludevesselsremaininginthesystemafterthesimulationiscompleteanddeletedvessels.
ForthisquerytofunctiontheWaitCause2outputmustbegeneratedduringthesimulationusingthe
MDBOutputControlflag.
HEADING
DESCRIPTION
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvessel
run(0ifnotpriorityrun,1ifpriorityrun)
CombinedString
CombineddelaycodeusingtheabbreviationsinTable2
SumofWaitIncrement
Sumofdelayduration forallvesselsdelayedwithintheclass,
situation,anditeration
C.4.12 qsumWaitCauseTotalTimeByCombinedCodeSituationLocation TheWaitCauseTotalTimebyCombinedCodeSituationLocationsummationqueryreportsthetotal
waitincrementbycodeforeachsituation/locationcombination.Thisprovidesatotaldelaytimefor
eachuniquecombineddelaycodeencounteredbyallvesselsinoneiterationcombination.Thequery
isbuiltuponqryWaitCause2(SectionC.4.3)andthereforewillincludevesselsremaininginthesystem
afterthesimulationiscompleteanddeletedvessels.
ForthisquerytofunctiontheWaitCause2outputmustbegeneratedduringthesimulationusingthe
MDBOutputControlflag.
HEADING
DESCRIPTION
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvessel
run(0ifnotpriorityrun,1ifpriorityrun)
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode
innetwork)
CombinedString
CombineddelaycodeusingtheabbreviationsinTable2
SumofWaitIncrement
Sumofdelayduration forallvesselsdelayedwithintheclass,
situation,anditeration
184 Appendix C  HarborSym Output Files C.4.13 qsumWaitIncrementBySituationandCode TheWaitIncrementbySituationandCodesummationqueryreportsthetotalwaitincrementbycode
foreachsituation.Thisprovidesatotaldelaytimeforeachuniquecombineddelaycodeencountered
byavesselinoneiteration.ThequeryisbuiltuponqryWaitCause2(SectionC.4.3)andthereforewill
includevesselsremaininginthesystemafterthesimulationiscompleteanddeletedvessels.
ForthisquerytofunctiontheWaitCause2outputmustbegeneratedduringthesimulationusingthe
MDBOutputControlflag.
HEADING
DESCRIPTION
Iteration
Iterationnumber,startingatone
PriorityRun
Flagtoindicateifthedatawasgeneratedduringthepriorityvessel
run(0ifnotpriorityrun,1ifpriorityrun)
VesselCallID
VesselCallIDNumber
Situation
Generallocationofvesselwhenrulewastriggered(arrival,dock
departure,anchoragedeparture)
Location
Specificlocationofvesselwhenruletriggeroccurred(namednode
innetwork)
CombinedString
CombineddelaycodeusingtheabbreviationsinTable2
SumofWaitIncrement
Sumofdelayduration forallvesselsdelayedwithintheclass,
situation,anditeration
C.4.14 qsumWaitTimeByPathIteration TheWaitTimebyPathIterationsummationqueryreportsthetotaltimespentundergoingvarious
activitiesinthesystembyvesselpathanditeration.Thisprovidesinsightintovesselsonwhichroutes
encounterthegreatestdelays,spendthemosttimeatdocksorinanchorages.
Forthisquerytofunction,theIndividualVesselCalloutputmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
HEADING
DESCRIPTION
VesselPath
Thepathtakenbythevesselfromentrytoexitincludingdocksand
turningbasins
SumofNetTime
Thetotaltimeinsystem(calculatedbasedonentryandexittimes)for
vesselcallstravelingthesubjectpath
SumofTotalTime
Thetotaltimeinsystemforvesselcallstravelingthesubjectpath
SumofWaitingDock
Thetotaltimewaitingatdocksforvesselsonthepath
185 Appendix C  HarborSym Output Files HEADING
DESCRIPTION
SumofatDock
Thetotaltimeatdocksforvesselsonthepath
SumofDocking
Thetotaltimedockingforvesselsonthepath
SumofUndocking
Thetotaltimeundockingforvesselsonthepath
SumofWaitingatEntry
Thetotaltimewaitingatentryforvesselsonthepath
SumofatTurningBasin
Thetotaltimeinturningbasinsforvesselsonthepath
SumofTotalinReaches
Thetotaltime transitingreachesbyvesselsonthepath
SumofWaitingFacilityNode
Thetotaltimewaitinginanchoragesforvesselsonthepath
Iteration
Iterationnumber,startingatone
CountofCallID
Numberofvesselcallstransitingthesubjectpath
C.4.15 qsumWaitTimeByPathIterationClass TheWaitTimebyPathIterationClasssummationqueryreportsthetotaltimespentundergoing
variousactivitiesinthesystembyvesselpath,iteration,andvesselclass.Thisqueryissimilartothe
qsumWaitTimeByPathIteration(SectionC.4.14)butfurtherrefinesthedatabysegregatingthe
informationbyvesselclass.
ForthisquerytofunctiontheIndividualVesselCalloutputmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
ThefieldsinthistablematchthoseofqsumWaitTimeByPathIteration(SectionC.4.14),withthe
additionof“Class”,whichidentifiesthevesselclass.
C.4.16 qsumWaitTimeByPathIterationProtocol TheWaitTimebyPathIterationProtocolsummationqueryreportsthetotaltimespentundergoing
variousactivitiesinthesystembyvesselpath,iteration,andpriorityrun.Thisqueryissimilartothe
qsumWaitTimeByPathIteration(SectionC.4.14)butfurtherrefinesthedatabyidentifyingonly
priorityvessels.
ForthisquerytofunctiontheIndividualVesselCalloutputmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
ThefieldsinthistablematchthoseofqsumWaitTimeByPathIteration(SectionC.4.14),withthe
additionof“PriorityRun”,whichidentifiesthepriorityvessels.
C.4.17 qsumWaitTimeByPathIterationProtocolClass TheWaitTimebyPathIterationProtocolClasssummationqueryreportsthetotaltimespent
undergoingvariousactivitiesinthesystembyvesselpath,iteration,vesselclass,andpriorityrun.
ThisqueryissimilartothequeryqsumWaitTimeByPathIterationClass(SectionC.4.15)butfurther
refinesthedatabysegregatingtheinformationbypriorityvessels.
186 Appendix C  HarborSym Output Files ForthisquerytofunctiontheIndividualVesselCalloutputmustbegeneratedduringthesimulation
usingtheMDBOutputControlflag.
ThefieldsinthistablematchthoseofqsumWaitTimeByPathIterationClass(SectionC.4.15),withthe
additionof“PriorityRun”,whichidentifiesthepriorityvessels.
187 Appendix D Sample PRN 188 Appendix D  Sample PRN 189 Appendix D  Sample PRN 190 Appendix D  Sample PRN Thispageleftintentionallyblank.
191 Appendix E Loading Tools Output Files TheoutputfilesgeneratedbytheCLTandBLTaredescribedinthisAppendix.
E.1 Container Loading Tool Output Files E.1.1 CommodityTransfer‐CLT.csv HEADING DESCRIPTION Iteration
Iterationnumber
Vessel
Namedofgeneratedvessel,namedaccordingtovesseltype
Commodity
Nameofcommodity
Forecast
User‐defineduniqueforecastidentification,from
CommodityForecastDescriptioninCommodityForecastatDocktable
ImportQuantity
Quantityimportedonvessel,inmetrictons
ExportQuantity
Quantityexportedonvessel,inmetrictons
E.1.2 Fleet‐CLT.csv HEADING DESCRIPTION Iteration
Iterationnumber
FleetSpecification
User‐definedfleetspecificationdescription,fromContainerFleet
SpecificationTable
Season
Seasondescription
Service
Servicename
VesselClass
Vesselclassdescription
AllocationPriority
AllocationpriorityspecifiedintheContainerFleetSpecificationTable
AvailableVisits
MaximumportvisitsspecifiedintheContainerFleetSpecificationTable
VisitsUsed
Numberofvisitsusedtosatisfytheforecast
192 Appendix E  Loading Modules Output Files E.1.3 FleetUsageStatistics‐CLTL.csv HEADING DESCRIPTION FleetSpecification
User‐definedfleetspecificationdescription,fromContainerFleet
SpecificationTable
Season
Seasondescription
Service
Servicename
Class
Vesselclassdescription
AllocationPriority
AllocationpriorityspecifiedintheContainerFleetSpecificationTable
MaxPortVisits
MaximumportvisitsspecifiedintheContainerFleetSpecification
Table
Average
Averagenumberofportvisitsusedbyiteration
SD
Standarddeviationofnumberofportvisitsusedbyiteration(ifonly
generatedasingleiteration,thenfieldwillbepopulatedwith"NaN")
Max
Maximumnumberofportvisitsusedbyiteration
Min
Minimumnumberofportvisitsusedbyiteration
E.1.4 Forecast‐CLT.csv HEADING DESCRIPTION Iteration
Iterationnumber
CommodityForecast
User‐defineduniqueforecastidentification,from
CommodityForecastDescriptioninCommodityForecastatDock
table
Season
Seasondescription
Dock
DockIDcode
Region
Regionname
Commodity
Nameofcommodity
ImportForecast
Quantityofcommodityforecastedtobeimported(randomlydrawn
valuebetweenImportQuantityandplusorminusone
ImportQuantitySD,definedbyuserinCommodityForecastbyDock
Table)
ImportAssigned
Quantityofimportsloadedonvessels,inmetrictons
ExportForecast
Quantityofcommodityforecastedtobeimported(randomlydrawn
valuebetweenExportQuantityandplusorminusone
ExportQuantitySD,definedbyuserinCommodityForecastbyDock
193 Appendix E  Loading Modules Output Files HEADING DESCRIPTION Table)
ExportAssigned
Quantityofexportsloadedonvessels,inmetrictons
VesselsUsed
Numberofvesselsusedtosatisfytheforecast
E.1.5 SatisfactionStatistics‐CLT.csv HEADING DESCRIPTION Forecast
User‐defineduniqueforecastidentification,from
CommodityForecastDescriptioninCommodityForecastatDocktable
Season
Seasondescription
Dock
DockIDcode
Region
Regionname
Commodity
Nameofcommodity
ExportAverage
Averagepercentofexportsallocatedtovessels,averagedbyiteration
ExportSD
Standarddeviationofpercentofexportsallocatedtovesselsby
iteration(note,fieldwillbepopulatedwith"NaN"ifonlyasingle
iterationisran)
ExportMax
Maximumpercentofexportsallocatedtovesselsoveriterations
ExportMin
Minimumpercentofexportsallocatedtovesselsoveriterations
ImportAverage
Averagepercentofimportsallocatedtovessels,averagedbyiteration
ImportSD
Standarddeviationofpercentofimportsallocatedtovesselsby
iteration(note,fieldwillbepopulatedwith"NaN"ifonlyasingle
iterationisran)
ImportMax
Maximumpercentofimportsallocatedtovesselsoveriterations
ImportMin
Minimumpercentofimportsallocatedtovesselsoveriterations
E.1.6 Vessels‐CLT.csv HEADING DESCRIPTION Iteration
Iterationnumber
VesselName
Namedof generatedvessel,namedaccordingtovesseltype
UniqueVesselID
UniquevesselID,asrequiredbyHarborSym
194 Appendix E  Loading Modules Output Files HEADING DESCRIPTION ClassName
VesselClassdescription
SubClassName
VesselSubclassname
AllocationPriority
Allocationpriorityassignedtouniquevessel,accordingtothat
specifiedintheContainerFleetSpecificationTableforvesselclasses
ArrivalDate
Timeanddatevesselarrivedatportofstudy
Dock
DockIDcodevisitedbyvessel
Service
Servicenameassociated withvessel
RouteGroup
RouteGroupnameassociated withvessel
Loading
TonnageonVesselatArrival
ImportTons
Metrictonsunloadedfromvesselforimport
ExportTons
Metrictonsloadedonvesselforexport
LOA
CLT‐generatedLengthOverallforvessel
Beam
CLT‐generatedbeamforvessel
Capacity
CLT‐generatedcapacityforvessel
ForecastCount
#ofdistinctforecaststhatthisvesselcallhassatisfiedinwholeor
part
ArrivalDraft
Draftofvesselwhenarrivingatport
Forecast
User‐defineduniqueforecastidentification,from
CommodityForecastDescriptioninCommodityForecastatDock
table
E.1.7 LoadingAnalysis‐CLT.csv HEADING DESCRIPTION Iteration
Iterationnumber
Vessel
Namedofgeneratedvessel,namedaccordingtovesseltype
SubClass
VesselSubclassname
TEURating
TEURatingforVesselSubclass(echoofuserinputindatabase)
DesignDraft
MaximumSummerLoadLineDraft(echoofuserinputindatabase)
DWTRatingMXSLLD
CapacityAtMaximumSummerLoadLineDraft(echoofuserinput
indatabase)
195 Appendix E  Loading Modules Output Files HEADING DESCRIPTION WorkingTPI
WorkingTonsPerInchDisplacement(echoofuserinputin
database)
TotalUKCRequirement
SumofBaselineUnderkeelClearanceandSinkageAdjustment
(fromuserinputindatabase)
TentativeArrivalDraft
Randomlydrawn(CDForuniformdistribution)arrivaldraft,before
applyingconstraints
MaxAllowableArrivalDraft
Maximumallowablearrivaldraftafterpriorportconstraintsand
tideandsealevelchangeadjustments
ArrivalDraft
Finalarrivaldraftusedincalculations
ArrivalDraftAdjusted
Haveadjustmentsbeenmadetoarrivaldraft(i.e.finalcalculationis
notequaltotentative)
TentativeDepartureDraft
Calculateddeparturedraft,basedonarrivaldraftandnettonnage
transferatport.Willbe0unlesssituationis"AfterLoadVessel"
MaxAllowableDepartureDraft
Maximumallowabledeparturedrafttakingintoaccountsubsequent
portconstraints,tideandsealevelchangeadjustments
DepartureDraft
MinimumoftentativedeparturedraftandMaxallowabledeparture
draft
DepartureDraftAdjusted
Haveadjustmentsbeenmadetodeparturedraft(i.e.finaldeparture
draftisnotequaltotentative)
LimitingDepthAtDock
Userinputmaximumdepthatdock(doesnotincludeunderkeel
clearancerequirementortide),fromdockinformationinIDB
TidalAvailability
Userinputtidalavailabilityatdock
PriorPortLimitingDepth
Limitingdepthoftheportpreviouslyvisitedbyvessel,obtained
fromRouteGroup
NextPortLimitingDepth
Limitingdepthofthenextporttobevisitedbyvessel,obtained
fromRouteGroup
AverageLadingWeightPerLoade
dTEU
AveragecommodityweightperloadedTEUinmetrictons,derived
byvesselclassandservicefromtableServiceVesselClass
AverageContainerWeightPerTE
U
AveragecontainerweightperTEUinmetrictons,derivedbyvessel
classandservicefromtableServiceVesselClass
PercentOfEmptyTEUs
%ofTEUsthatareempty‐ Userinput(service‐vesselclass)
PercentVacantSlots
%ofslotsthatarenotfilled‐ Userinput(service‐vesselclass)
PercentVariableBallast
User‐specifiedpercentagefractionoftheavailabledeadweight
tonnageatthevesselarrivaldrafttoaccountforvariableballast
(service‐vesselclass)
196 Appendix E  Loading Modules Output Files HEADING DESCRIPTION PercentAllowanceForOperation
s
User‐specifiedpercentagefractionoftheavailabledeadweight
tonnageatthevesselarrivaldrafttoaccountforoperations
(bunkerage+shipsstores)(service‐vesselclass)
TotalTonnagePerLadenTEU
WeightperladenTEU(cargoonly)+emptyboxweight(forcargo)
+allocatedfractionofemptyboxweight(forempties)
PercentForCargo
AverageLadingWeightPerLoadedTEU/TotalTonnagePerLaden
TEU(fractionofweightthatiscargo)
PercentForLadenBoxes
AverageContainerWeightPerTEU/TotalTonnageperLaden
TEU(fractionofweightthatisbox,forladenboxes)
PercentForEmptyBoxes
FractionofWeightthatisemptyboxes
CheckSum
Sumofprevious3columns,shouldalwaysbe1.0
MinVacantSlots
Fractionalnumberofvacantslots,basedoninputTEUratingfor
vesselandpercentageofvacantslots(userinput)
PotentiallyOccupiedContainerSl
ots
TEUrating‐ VacantSlots
MaxLoadedContainersDraftBas
ed
Maximumnumberofloadedcontainersbasedondraft
MaxLoadedContainersNominal
TEUBased
Maximumnumberofloadedcontainersbasedonavailableslots,
accountingforemptyslots
MaxLoadedContainers
SmallerofMaxLoadedContainersDraftBasedor
MaxLoadedContainersNominalTEUBased(draftvs.cube)
MinEmptyContainers
#ofemptycontainersbasedonmaxloadedcontainersandempty
containerfraction
VacantSlots
#ofvacantslotsbasedontotalteu,#ofloadedcontainersand#of
emptycontainers
CheckSum
Checksum,MaxLoadedContainers+MinEmptyContainers+
VacantSlots‐teuRating,shouldbe0
DeadWeightTonnageAvailableF
orVesselDraft
Tonnageavailableatvesseldraft,basedoncapacity,designdraft,
arrivaldraft,andTPI‐howmuchadditionaltonnagecanbeloaded
onvessel
ApproximateVariableBallast
Tonnagedevotedtovariableballast
AllowanceForOperationsInMetr
icTonnes
Tonnagedevotedtoallowanceforoperations
AvailableForCargoDraftBased
Tonnageavailableforcargo
(DeadWeightTonnageAvailableForVesselDraft)lesstonnagefor
ballastlesstonnageforoperations
197 Appendix E  Loading Modules Output Files HEADING DESCRIPTION AvailableForCargoVolumeBase
d
Tonnageavailableforcargobasedonvolume
AvailableForCargo
LesserofAvailableForCargoDraftBasedor
AvailableForCargoVolumeBased
MaxWeightForEmptyBoxes
Totalweightofemptycontainers
MaxWeightForCargo
Totalweightofcargo(exclusiveofboxweight)
MaxWeightForLadenBoxes
Totalweightofladencontainers(boxweightonly)
TotalWeightBoxPlusCargo
Totalweightofcargoplusboxes
MaxDraftCargoBased
Maximumdraftundermaximumcargo(volume)utilization
VolumeConstrained
Trueifvolumeconstrainedasopposedtodraftconstrained
InitialAvailableImportCapacity
Calculatedamountofarrivaltonnagethatisavailableforimport
InitialAvailableExportCapacity
Calculatedamountofarrivaltonnagethatisavailableforexport
FinalAvailableImportCapacity
Finalremainingcapacityonvesselforimport(tonnes)
FinalAvailableExportCapacity
Finalremainingcapacityonvesselforexport(tonnes)
TotalImportTonnage
Totaltonnageimportedtoport
TotalExportTonnage
Totaltonnageexportedfromport
IndividualForecastImport
Amountofindividualforecastsatisfactionforimport(meaningful
for"LoadVessel"situationonly
IndividualForecastExport
Amountofindividualforecastsatisfactionforexport(meaningful
for"LoadVessel"situationonly
Situation
Referstostatusofcalculation,3rowspervessel:1)setarrivaldraft
2)loadvessel3)afterloadingthevessel
E.1.8 ArrivalDraftDebug.csv Thisoutputfileisfordebuggingandmustbe“turnedon”throughtheoptionsmenuoftheCLT.
Type
Indicatesdrafttype
Function
IndicateswhetheraCDFisstoredorifthemin/maxshouldbe
used
Service
Servicedescription
Class
VesselClassdescription
198 Appendix E  Loading Modules Output Files Iteration
Iterationnumber
MinDraft
Minimumdraftfortheservice/vesselclassasdefinedinthe
Service‐VesselClasstable
MaxDraft
Maximumdraftfortheservice/vesselclassasdefinedinthe
Service‐VesselClasstable
Probability
Randomlydrawnvalue
TentativeValue
Tentativearrivaldraftthatfallsbetweenthemin/maxdraft
calculatedwithprobability
FinalValue
Tentativearrivaldraftischeckedagainstmaximumallowable
arrivaldraft(describedinSection4.2.3)
E.2 Bulk Loading Tool Output Files E.2.1 Allocation.csv HEADING DESCRIPTION Iteration
Iterationnumber
Forecast
Forecastidentificationnumber
CommodityCategory
Commoditycategoryname
DockCode
DockIDcode
ForecastQuantityImport
Importquantityspecifiedforforecastintons
ForecastQuantityExport
Exportquantityspecifiedforforecastintons
AllocatedImport
Importquantityallocatedtovesselsintons
AllocatedExport
Exportquantityallocatedtovesselsintons
NumberOfUniqueVessels
Countofuniquevesselsgeneratedtosatisfyforecast
NumberOfCalls
Countofvesselcallsgeneratedtosatisfyforecast
ImportDeficit
Importquantitynotallocatedtovessels,thereforedeficitintons
ExportDeficit
Exportquantitynotallocatedtovessels,thereforedeficitintons
199 Appendix E  Loading Modules Output Files E.2.2 ClassUsage.csv HEADING DESCRIPTION Iteration
Iterationnumber
VesselClass
Vesselclassname
ShortName
Vesselclassdescription
Vessels
Countofvesselsgeneratedtosatisfyimportandexportforecast
Calls
Countofvesselcallsgeneratedtosatisfyimportandexportforecast
AllocationPriority
Notesallocationpriorityofvessel class
E.2.3 Loading.csv HEADING DESCRIPTION VesselName
NameofSyntheticVessel
Dock
DockCode
Commodity
CommodityImportedorExported
Class
VesselClass
QUnitsToBeAllocImport
CommodityUnitsImported(basedondraftandcapacity
constraints)
QUnitsToBeAllocExport
CommodityUnitsExported(basedondraftandcapacity
constraints)
UnderkeelClearance
Vesselunderkeelclearance
LoadingFactorImport
FractionofvesselDWTthatcanbeusedforloadingonimport,
basedontriangulardistributionstoredinvesselclass‐commodity
categorytable(FCDB)
LoadingFactorExport
FractionofvesselDWTthatcanbeusedforloadingonexport,
basedontriangulardistributionstoredinvesselclass‐commodity
categorytable(FCDB)
DockLimitingDepth
Limitingdepthatprocessingdock
PriorPortLimitingDepth
Priorportlimitingdepth,basedonassignedroutegroup
NextPortLimitingDepth
Nextportlimitingdepth,basedonassignedroutegroup
LimitingDepthImport
Criticallimitingdepthforimportbasedonpriorportlimiting
depth,docklimitingdepth,ordesigndraft;‐1indicatednoimport
LimitingDepthExport
Criticallimitingdepthforexportbasedonnextportlimitingdepth,
200 Appendix E  Loading Modules Output Files HEADING DESCRIPTION docklimitingdepth,ordesigndraft;‐1indicatesnoexport
DWT
Vesselcapacity indeadweighttons(DWT)
TPIFactor
VesselTPI factor
AllowanceForOperationsFractio
n
ThelookedupfractionofDWTthatisassignedtoallowancefor
operationsfromtheAllowanceforOperationscurvefoundinthe
installedfile‘AllowanceForOperations.csv’
AllowanceForOperationsTons
TotaltonsforAllowanceforOperations,equaltoDWTtimes
AllowanceForOperationsFraction
AllowanceForOperationsAdditio
nalImmersion
DraftthatisallocabletoAllowanceForOperationsTons,basedon
TPIcalculations
TentativeLoadingImportTons
LoadingforImportwithorwithoutadjustmentforallowancefor
operations;withoutadjustment=DWT*LoadingFactorImport;
withadjustment=DWT–Tonsassociatedwithallowancefor
operations
AdditionalDraftImport
TentativeImportLoading/TPIFactor/12.0,infeet
TotalDraftImport
Pre‐AdjustmentImportDraft=EmptyVesselDraft+Underkeel
Clearance+TentativeAdditionalDraftImport(associatedwith
tentativeimportloading)+Draftassociatedwithallowancefor
operations
ExcessDraftImport
DraftBeyondLimits(eitherlimitingdepthordesigndraft)that
willneedtobereducedbyloweringtentativeimportquantity
TonsToReduceImport
ConversionofExcessDrafttoTonsviaTPIfactor
QuantityLoadedImportTons
TentativeImportQuantityLessTonsToReduceAdjustment
TentativeLoadingExportTons
LoadingforExportwithorwithoutadjustmentforallowancefor
operations;withoutadjustment=DWT*LoadingFactorImport;
withadjustment=DWT–Tonsassociatedwithallowancefor
operations
AdditionalDraftExport
TentativeExportLoading/TPIFactor/12.0,infeet
TotalDraftExport
Pre‐AdjustmentExportDraft=EmptyVesselDraft+Underkeel
Clearance+AdditionalDraftExport(associatedwithtentative
exportloading)+Draftassociatedwithallowanceforoperations
ExcessDraftExport
DraftBeyondLimits(eitherlimitingdepthordesigndraft)that
willneedtobereducedbyloweringtentativeexportquantity
TonsToReduceExport
ConversionofExcessDrafttoTonsviaTPIfactor
QuantityLoadedExportTons
TentativeExportQuantityLessTonsToReduceAdjustment
201 Appendix E  Loading Modules Output Files HEADING DESCRIPTION EmptyVesselDraft
Draftofthevesselifemptyofcargo,stores,fuel,etc.
DesignDraft
Class‐basedrandomizedvesseldesigndraft
MinimumClassSailingDraft
Class‐basedminimumsailingdraft(inputdata)
MaximumClassSailingDraft
Class‐basedmaximumsailingdraft(inputdata)
ArrivalDraft
Finalcalculatedsailingdraftofvessel uponarrivalattheport
QuantityImportedUnits
Finalquantityonvesselatimport(units)
QuantityExportedUnits
Finalquantityonvesselatexport(units)
TonsPerUnit
TonsPerUnitConversion(fromcommodityinformation,user
input)
QuantityLoadedImportTons
QuantityImportedUnitsConvertedToTonsViaConversionFactor
QuantityLoadedImportUnits
IdenticaltoQuantityImportedUnits(nolongerneeded)
QuantityLoadedExportTons
QuantityExportedUnitsConvertedToTonsViaConversionFactor
QuantityLoadedExportUnits
IdenticaltoQuantityExportedUnits(nolongerneeded)
E.2.4 Vessel.csv HEADING DESCRIPTION Iteration
Iterationnumber
VesselName
Uniquevesselname
ClassDescription
Vesselclassdescription
ClassID
VesselclassID
ClassNumber
Vesselclassnumber
Allocation
Allocationpriorityofvessel
Interarrival
Notcurrentlyused
InterarrivalSD
Notcurrentlyused
MinimumCapacity
Class‐basedminimumcapacity
MaximumCapacity
Class‐basedmaximumcapacity
LOA
Randomlyassignedlengthoverall,basedonvessel‐classlevelstatistics
Beam
Randomlyassignedlengthoverall,basedonvessel‐classlevelstatistics
202 Appendix E  Loading Modules Output Files Draft
Randomlyassignedlengthoverall,basedonvessel‐classlevelstatistics
DWT
Randomlyassignedlengthoverall,basedonvessel‐classlevelstatistics
TPIFactor
Randomlyassignedlengthoverall,basedonvessel‐classlevelstatistics
MinimumDraft
Minimumdraftbasedon designdraftandcapacity
NumberOfAvailableCalls
Always1
NumberOfAllocatedCalls
1ifvesselisassignedatripandisintheVCDB,0otherwise
MaximumNumberOfTrips
Always1
TotalTimeInTrips
Notcurrentlyused
LoadingFactorImport
FractionofvesselDWTthatcanbeusedforloadingonimport,based
ontriangulardistributionstoredinvesselclass‐commoditycategory
table(FCDB)
LoadingFactorExport
FractionofvesselDWTthatcanbeusedforloadingonexport,based
ontriangulardistributionstoredinvesselclass‐commoditycategory
table(FCDB)
AllowanceForOperations
Fractionofvesselcapacitythatistobeusedforoperationsandthus
notavailableforcargoloading.Derivedaccordingtothevessel’sDWT
andstandardsforallowanceforoperationsprovidedbyIWR.
203 Glossary GlossaryTerm
GlossaryDefinition
Allowancefor
Operations
Thefractionofavesselcapacitythatistobeusedforoperationsandthusnotavailablefor
cargoloading
Anchorages
Designatednodewherevesselswaitintermediatelyifprohibitedfromreachingits
destinationduetocongestionorconstraints
BulkLoadingTool ModuleintegratedwithinHarborSymdesignedtogeneratesyntheticnon‐containerized
(BLT)
vessels
Commodities
Cargothatisloadedandunloadedfromavesselattheharbordocks
Commodity
Transfer
Loadingorunloadingofonecommodityfromonevesselduringadockvisit
Commodity
TransferRate
Therateatwhichacommodity,orcargo,isloadedorunloadedfromavesselinunitsper
hour
Critical
Commodity
Commoditydesignationthatrestrictsmeeting(passingorovertaking)oftwovesselswithin
areachifeithervesseliscarryingacriticalcommodity;thecriticalcommodityrulemustbe
establishedwithinthereachforrestrictiontoapply
CurrentStation
Stationsfromwhichtheflowofcurrentismeasured
DockVisit
Singlevisitbyavesseltoadock
Duration
Scenarioparameterdefiningthehoursforasimulation
Entry/ExitPoint
Nodeswherevesselsenterorexittheharbor
ETTC
Estimateoftotaltripcargo;definedasthecargoonboardatarrivalplusthecargoonboard
atdeparture,intons
Iteration
Scenarioparameterdefiningthenumberofdurations
Leg
Contiguoussetofreachesbetweenstoppingpoints
Meeting
Referstobothpassingandovertaking
MultipleVessel
Rule
Vesseltransitrulethatinvolvesencountersbetweentwovessels;parametersmustbe
enteredforthemovingvesselandthe"other"vessel
Nodes
Docks,turningbasins,anchorages,entry/exitpoints,orothertopologicalpointsinthe
harborwherechannelconditionschange
Overtaking
Twovesselsmovinginthe samedirectioninachannelreach
204 Glossary  Passing
Bi‐directionalmovementoftwovesselswithinareach
Port
Synonymouswiththestudy harbor,representedinHarborSymasasystemofreaches
betweennodes
PriorityVessel
SpecialdesignationwithinHarborSym;allowedtotravelthroughthesystemunimpeded
Project
Definitionofaharbor,includingallthephysicalcharacteristicofthedocks,turningbasins,
anchorages,andreacheswithintheharbor;includesvesseltransitrules;projectswithina
studycanhavethesamevesselcalllist
Reach
Segmentofchannelbetweentwonodeswithuniformcharacteristics,includingwidth,depth,
transitrules,andoperatingspeeds
RouteGroup
Nameditineraryorportionthereofthatavesselmaytravelbeforeandaftervisitingtheport
ofstudy
SafetyZone
Distancefromtheship'sbowandsternthatisrestrictedsailingspace;safetyzonesareuser
definedcharacteristicsspecifiedaccordingtothecommoditycarriedonavessel
Scenario
Setofdefinedrunparametersthatspecifytheconditionsofasimulation
Service
Regularvesseltransitacrossasetofregions
SingleVessel
Rule
Vesseltransitrulethatinvolvesonlyasinglevessel;parametersareenteredforonlythe
movingvessel
Study
Thedesignationfortheoverallanalysisconductedwiththemodel;limitedtoonecontiguous
geographicarea;containsatleastoneproject
TidalStation
Stationsatwhichtidesaremeasured
TonsperSquare
Inch(TPI)
Thenumberoftonsrequiredtochangethedraftofavesselbyoneinchatagivendraft,
expressedininches
TurningBasin
Designatednode wherevesselscompleteturningmaneuvers
VesselCall
Singleportvisitbyvesselwheredockvisit(s)andcommoditytransfersoccur
VesselClass
Subsetofvesseltype;definedbyuserbaseduponphysicalparameters,commoditiescarried,
sailingdraft,sailingspeeds,operatingcosts,andoceansailingroutes
VesselCost
Theproductofvesseltimeinsystemandvesseloperatingcost
VesselCost
atSea
Costsassociatedwithvesselwhiletransitingreaches,performingturningmaneuvers,delays
beyondthresholdtimes,andwhiletraversingvesselrouteatsea
VesselCost
inPort
Costsassociatedwithvesselappliedduringdockvisits;includestimespenddockingand
undocking
VesselDocking
Theamountoftimeavesselspendsdockingorundockingdesignatedinhours
205 Glossary  Time
VesselOperating
Costs
Definedbyvesselstatus(atseaorinport)andalsobyvesselflag(foreignordomestic);
associatedwithvesselsailingspeed
VesselPath
Seriesoflegsavesseltravelsduringacalltotheport,includingintermediatenodes
VesselSizeUnit
(VSU)
Abstractconceptthatallowstheusertoprovideamulti‐dimensionalaccountingforvessel
dimensions;assignedatthevesselclasslevelandappliedasarestrictionatturningbasin
anddocks
VesselSpeed
Thespeed,inknotsperhour,thatavesselcantravel;associatedwithvesseloperatingcosts;
definedinportbyreachesandatseabyvesselclass
VesselTime
Waiting
Timevesselsspend waitingatportnodestopreventaruleviolation;vesselscanwaitat
entrance,dock,oranchorage,expressedinhours
VesselTransit
Rules
Userdesignatedrestrictionsonhowvesselareallowedtomovethroughthesystem
VesselTurning
Time
Theamountoftimeavesselspendsturninginaturningbasininhours
VesselType
Generalcategoryofvesselssuchastankers,generalcargovessels,orcontainervessels,as
definedbyuser
Vessels
Varioustypesofshipsthatvisittheharbor
206 Glossary  Thispageintentionallyleftblank.
207 Index A‐DAPP, 14, 40, 42, 43, 76, 77, 78, 107, 110, 113 input database, v, x, 6, 14, 31, 32, 34, 38, 39, 40, 41, anchorage, 15, 20, 22, 26 47, 48, 49, 96, 97, 98, 100, 101, 102, 103, 106, 107, anchorages, 9, 15, 63, 65, 69, 122, 138, 169, 179, 180, 183, 184, 185, 186, 188, 189, 190, 192, 193, 215 109, 118, 119, 205 intra‐harbor movements, 16 anchorages, 14, 17, 22 iterations, 16, 21 At Sea Distances, 17 leg, 14, 15, 16, 19, 22, 173 BLT lookup spreadsheet, 146 Bulk Loading Tool, iii, x, 1, 5, 6, 9, 21, 24, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 41, 47, 48, 49, 57, 73, 74, MDB master database, 6, 47, 183, 185, 186, 187, 189, 190, 192, 193, 194, 195 75, 76, 78, 79, 95, 96, 97, 98, 100, 101, 102, 103, 104, 105, 106, 117, 118, 119, 124, 125, 201, 213 Monte Carlo simulation, 1, 16, 21 CDF, x, xi, 41, 42, 43, 98, 112, 114, 205, 208 Navigation Pane, 24, 25, 27 CFCDB node container forecast database, v, x, xi, xii, 6, 39, 40, 41, nodes, 1, 7, 8, 10, 15, 20, 26, 27, 53, 63, 64, 65, 66, 84, 42, 47, 48, 107, 108, 110, 114, 117, 118 105, 121, 122, 125, 128, 129, 138, 140, 141, 147, CLT 161, 165, 175, 176, 179, 180, 184, 185, 186, 188, 189, 192, 193, 213, 214 Container Loading Tool, iv, vii, ix, x, xi, xii, 1, 5, 6, 9, 14, 21, 24, 30, 38, 39, 40, 41, 42, 43, 44, 46, 47, 48, 49, node network, 1, 7, 26, 63, 64, 66, 121, 125, 128, 129 57, 71, 72, 78, 95, 96, 104, 105, 106, 107, 108, 109, ODB 110, 112, 113, 114, 115, 116, 117, 118, 119, 124, 125, 201, 202, 203, 204, 208 output database, 6 operating costs, 16 Combiner, i, iv, 1, 9, 24, 30, 48, 57, 95, 96, 105, 118 Overtaking, 16 commodity category, 17, 80, 146, 154, 169 passing, 16, 17 commodity transfers, 12, 15, 21 Path, 15, 189 current, 20, 153, 154, 155, 156, 173 port, 7, 13, 14, 18, 19, 20, 22, 163, 166 Data Entry Pane, 24, 25, 27 Port Structures, 27 deepening, 1, 13, 23, 30, 76, 102 priority vessel Default TPI, 75, 96 dock, 5, 14, 16, 17, 22, 170, 172, 178 dock visits, 12, 16 priority vessels, 11, 12, 15, 122, 138, 194, 195 project, 2, 7, 14, 23, 25, 26, 27, 30, 31, 33, 38, 43, 47, 50, 56, 57, 58, 61, 63, 66, 67, 68, 76, 77, 79, 80, 82, 84, 85, docking time, 17 88, 90, 91, 94, 95, 96, 97, 100, 101, 102, 105, 106, 113, draft adjustments, 24 119, 121, 124, 126, 130, 131, 132, 133, 134, 137, 138, duration, 10, 12, 20, 21, 42, 51, 91, 109, 122, 124, 137, 183, 184, 190, 191, 192, 193 entry/exit, 26 144, 148, 160, 163, 165, 214 reach reaches, 7, 8, 9, 10, 11, 12, 15, 16, 17, 18, 20, 22, 34, entry/exit point, 26 37, 55, 56, 64, 69, 70, 71, 86, 87, 89, 90, 91, 122, FCDB 124, 125, 126, 129, 136, 137, 141, 144, 148, 152, forecast database, 6, 31, 32, 33, 97, 98, 99, 100, 101, 105 153, 154, 161, 163, 166, 175, 180, 186, 187, 189, 213, 214 Graphics Pane, 24, 25, 26 region, 38, 40, 41, 42, 76, 107, 110, 111, 116 Hourly Operating Costs, 75 route group, 13, 14 IDB rule violations, 20 208 Index  run parameters, 27 safety zone, 19, 69, 78, 87, 88, 89, 122, 154 VCDB vessel call database, v, x, 6, 21, 30, 31, 32, 39, 46, 47, safety zones, 19 48, 49, 57, 81, 96, 97, 98, 99, 100, 101, 102, 103, sailing draft, 156 104, 105, 106, 107, 117, 118, 119, 169 scenario, 21, 28 vessel call list, 14, 16, 21 season, 38, 40, 41, 108, 115, 116, 117 vessel class service, 31, 35, 37, 38, 40, 41, 42, 98, 109, 110, 111, 112, vessel classes, 6, 9, 10, 11, 13, 15, 16, 17, 23, 24, 31, 32, 33, 34, 35, 37, 38, 39, 41, 42, 43, 49, 56, 59, 71, 114, 115, 205, 206, 208 72, 74, 75, 76, 77, 78, 80, 81, 82, 83, 84, 87, 90, 96, SODA 97, 98, 99, 101, 102, 103, 107, 112, 114, 115, 137, scenario output database, vii, 6, 28, 122, 160, 164, 179, 183 146, 148, 155, 162, 167, 169, 180, 190, 194, 205, speed in reach, 15 study, 1, 2, 5, 6, 7, 8, 10, 13, 14, 15, 17, 18, 19, 20, 21, 24, 206, 208, 209, 210, 212, 215 vessel classes, 15 26, 30, 31, 38, 40, 43, 47, 50, 52, 56, 61, 62, 63, 71, 72, vessel path. See path 73, 75, 76, 77, 78, 80, 83, 85, 86, 88, 93, 94, 96, 98, vessel size unit 106, 108, 109, 110, 117, 121, 126, 146, 163, 204, 214 tide, 20, 27, 153, 156, 157 Tide Tool, 21 VSU, 173 vessel type vessel types, 9, 10, 13, 17, 55, 67, 68, 71, 72, 73, 74, 76, 79, 80, 81, 82, 88, 100, 144, 146, 147, 201, 203, topologic, 26 204, 214 transit rule, 15, 16, 18 transit rules, 5, 17, 18 transportation cost, 17 Turning Time, iv, vi, 16, 55, 91, 148, 172, 215 VSU vessel size unit, 11, 18, 68, 69, 75, 173, 174, 176, 215 widening, 1, 14, 18, 23, 30, 75, 76, 77 underkeel clearance, 9, 11, 24, 44, 75, 166, 205, 209 Underkeel Clearance, 11, 36, 75, 168, 185, 186, 205, 210 UTC Offset, 62 205