abstract_alr
AbstractALR(params)
¶
Bases: AbstractVessel
Abstract class to model the performance of the Autosub Long-Range (ALR)
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:
| Name | Type | Description |
|---|---|---|
ext_ice |
bool
|
boolean that is True if the cell is inaccessible due to ice |
land(cellbox)
¶
Method to determine if a cell is land based on sea level
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 ALR
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns: access_values (dict): boolean values for the modelled accessibility criteria
model_battery(cellbox)
abstractmethod
¶
Method to determine the battery consumption rate of the ALR 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 battery consumption values |
model_performance(cellbox)
¶
Method to determine the performance characteristics for the ALR
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
model_speed(cellbox)
abstractmethod
¶
Method to determine the maximum speed that the ALR 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 |
shallow(cellbox)
¶
Method to determine if the water in a cell is too shallow for an ALR based on configured minimum depth
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
input cell from environmental mesh |
required |
Returns: shallow (bool): boolean that is True if the cell is too shallow for an ALR