embrs.utilities.action#

Class of templated actions that can be performed on a BaseFireSim object.

Not required to be used to complete actions, but provide a nice compact way to define action sequences.

class embrs.utilities.action.Action(time: float, x: float, y: float)#

Base class which all other actions implement.

Parameters:

  • time (float) – time at which the action takes place. Note this is just for the user’s use, the actions will not be scheduled to be performed at this time.

  • x (float) – x location in meters where the action takes place.

  • y (float) – y location in meters where the action takes place.

class embrs.utilities.action.SetFuelMoisture(time: float, x: float, y: float, moisture: float)#

Class defining the action of setting the fuel moisture at a location.

Parameters:

  • time (float) – time at which the action takes place. Note this is just for the user’s use, the actions will not be scheduled to be performed at this time.

  • x (float) – x location in meters where the action takes place.

  • y (float) – y location in meters where the action takes place.

  • moisture (float) – Moisture value to set the fuel to at the location and time specified.

perform(fire: BaseFireSim)#

Function that carries out the SetFuelMoisture action defined by the object, it should noted that the action will take place at whatever sim time the fire instance is on when this function is called, NOT the time parameter of this object.

Parameters:

fire (BaseFireSim) – Fire instance to perform the action on.

class embrs.utilities.action.SetFuelContent(time: float, x: float, y: float, fuel_content: float)#

Class defining the action of setting the fuel content at a location.

Parameters:

  • time (float) – time at which the action takes place. Note this is just for the user’s use, the actions will not be scheduled to be performed at this time.

  • x (float) – x location in meters where the action takes place.

  • y (float) – y location in meters where the action takes place.

  • fuel_content (float) – Fuel content value to set the fuel to at the location and time specified.

perform(fire: BaseFireSim)#

Function that carries out the SetFuelContent action defined by the object, it should noted that the action will take place at whatever sim time the fire instance is on when this function is called, NOT the time parameter of this object.

Parameters:

fire (BaseFireSim) – Fire instance to perform the action on.

class embrs.utilities.action.SetIgnition(time: float, x: float, y: float, fire_type: FireTypes)#

Class defining the action of starting an ignition at a location.

Parameters:

  • time (float) – time at which the action takes place. Note this is just for the user’s use, the actions will not be scheduled to be performed at this time.

  • x (float) – x location in meters where the action takes place.

  • y (float) – y location in meters where the action takes place.

  • fire_type (FireTypes) – The type of fire to be ignited, either PRESCRIBED or WILD

perform(fire: BaseFireSim)#

Function that carries out the SetIgnition action defined by the object, it should noted that the action will take place at whatever sim time the fire instance is on when this function is called, NOT the time parameter of this object.

Parameters:

fire (BaseFireSim) – Fire instance to perform the action on.

Classes

Action(time, x, y)

Base class which all other actions implement.

SetFuelContent(time, x, y, fuel_content)

Class defining the action of setting the fuel content at a location.

SetFuelMoisture(time, x, y, moisture)

Class defining the action of setting the fuel moisture at a location.

SetIgnition(time, x, y, fire_type)

Class defining the action of starting an ignition at a location.