abstract_ship
AbstractShip(params)
¶
Bases: AbstractVessel
Abstract class to define the methods and attributes common to any vessel that is a ship
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
dict
|
vessel parameters from the vessel config file |
required |
extreme_ice(cellbox)
¶
Method to determine if a cell is inaccessible based on configured max ice concentration
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns: ext_ice (bool): boolean that is True if the cell is inaccessible due to ice
extreme_waves(cellbox)
¶
Method to determine if a cell is inaccessible based on configured max wave height. Args: cellbox (AggregatedCellBox): input cell from environmental mesh Returns: ext_wave (bool): boolean that is True if the cell is inaccessible due to waves
invert_resistance(cellbox)
abstractmethod
¶
Method to determine the speed that reduces the resistance force on the ship to an acceptable value
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns: speed (float): Safe vessel speed in km/h
land(cellbox)
¶
Method to determine if a cell is land based on configured minimum depth
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns: land (bool): boolean that is True if the cell is inaccessible due to land
model_accessibility(cellbox)
¶
Method to determine if a given cell is accessible to the ship
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns:
| Name | Type | Description |
|---|---|---|
access_values |
dict
|
boolean values for the modelled accessibility criteria |
model_fuel(cellbox)
abstractmethod
¶
Method to determine the fuel consumption rate of the ship in a given cell
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns:
| Name | Type | Description |
|---|---|---|
cellbox |
AggregatedCellBox
|
updated cell with fuel consumption values |
model_performance(cellbox)
¶
Method to determine the performance characteristics for the ship
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns:
| Name | Type | Description |
|---|---|---|
performance_values |
dict
|
the value of the modelled performance characteristics for the ship |
model_resistance(cellbox)
abstractmethod
¶
Method to determine the resistance force acting on the ship in a given cell
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns:
| Name | Type | Description |
|---|---|---|
cellbox |
AggregatedCellBox
|
updated cell with resistance values |
model_speed(cellbox)
abstractmethod
¶
Method to determine the maximum speed that the ship can traverse the given cell
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns:
| Name | Type | Description |
|---|---|---|
cellbox |
AggregatedCellBox
|
updated cell with speed values |