abstract_vessel
AbstractVessel(params)
¶
Interface to define the abstract methods required for any vessel class to work within the VesselPerformanceModeller.
Initialise the vessel object with parameters from the config.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
dict
|
vessel parameters from the vessel config file |
required |
model_accessibility(cellbox)
abstractmethod
¶
Determine accessibility of the input cell for the given vessel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
cell in which accessibility is being determined |
required |
Returns:
| Name | Type | Description |
|---|---|---|
access_values |
dict
|
values for the accessibility and other related booleans |
model_performance(cellbox)
abstractmethod
¶
Calculate performance parameters for the given vessel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cellbox
|
AggregatedCellBox
|
cell in which performance is being modelled |
required |
Returns:
| Name | Type | Description |
|---|---|---|
performance_values |
dict
|
values for relevant performance parameters |