abstract_plane

AbstractPlane(params)

Bases: AbstractVessel

Abstract class to model the performance of a plane

Parameters:

Name	Type	Description	Default
params	dict	vessel parameters from the vessel config file	required

elevation_max(cellbox)

Method to determine if the altitude in a cell is too high for a plane based on configured maximum elevation

Parameters:

Name	Type	Description	Default
cellbox	AggregatedCellBox	input cell from environmental mesh	required

Returns: elevation_max (bool): boolean that is True if the elevation in a cell is too high for a plane

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 plane

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_fuel(cellbox) abstractmethod

Method to determine the fuel consumption rate of the plane 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 a plane

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 plane 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