FireSTARR
Loading...
Searching...
No Matches
fs::Iteration Class Reference

Represents a full set of simulations using all available weather streams. More...

#include <Iteration.h>

Collaboration diagram for fs::Iteration:

Public Member Functions

 Iteration (vector< Scenario * > scenarios) noexcept
 Constructor.
 
 Iteration (const Iteration &rhs)=default
 
 Iteration (Iteration &&rhs)=default
 
Iteration & operator= (const Iteration &rhs)=default
 
Iteration & operator= (Iteration &&rhs)=default
 
Iteration * reset_with_new_start (const XYIdx &start_cell)
 Assign start Cell and create new thresholds for use in each Scenario.
 
Iteration * reset (mt19937_64 *mt_extinction, mt19937_64 *mt_spread)
 Create new thresholds for use in each Scenario.
 
const vector< Scenario * > & getScenarios () const noexcept
 List of Scenarios this Iteration contains.
 
void cancel (bool show_warning) noexcept
 
vector< DurationSize > savePoints () const
 Points in time that ProbabilityMaps get saved for.
 
DurationSize startTime () const
 Time that simulations start.
 
size_t size () const noexcept
 Number of Scenarios in this Iteration.
 
SafeVector finalSizes () const
 SafeVector of sizes that Scenarios have resulted in.
 

Private Attributes

vector< Scenario * > scenarios_
 List of Scenarios this Iteration contains.
 
SafeVector final_sizes_ {}
 SafeVector of sizes that Scenarios have resulted in.
 
bool cancelled_ = false
 Whether this has been cancelled and should stop computing.
 

Detailed Description

Represents a full set of simulations using all available weather streams.

Constructor & Destructor Documentation

◆ Iteration()

fs::Iteration::Iteration ( vector< Scenario * > scenarios)
explicitnoexcept

Constructor.

Parameters
scenariosList of Scenarios to wrap into Iteration

Member Function Documentation

◆ cancel()

void fs::Iteration::cancel ( bool show_warning)
noexcept

Mark as cancelled so it stops computing on next event.

Parameters
Whetherto log a warning about this being cancelled

◆ finalSizes()

SafeVector fs::Iteration::finalSizes ( ) const
nodiscard

SafeVector of sizes that Scenarios have resulted in.

Returns
SafeVector of sizes that Scenarios have resulted in

◆ getScenarios()

const vector< Scenario * > & fs::Iteration::getScenarios ( ) const
inlinenodiscardnoexcept

List of Scenarios this Iteration contains.

Returns
List of Scenarios this Iteration contains

◆ reset()

Iteration * fs::Iteration::reset ( mt19937_64 * mt_extinction,
mt19937_64 * mt_spread )

Create new thresholds for use in each Scenario.

Parameters
mt_extinctionExtinction thresholds
mt_spreadSpread thresholds
Returns
This

◆ reset_with_new_start()

Iteration * fs::Iteration::reset_with_new_start ( const XYIdx & start_cell)

Assign start Cell and create new thresholds for use in each Scenario.

Parameters
start_cellCell to start ignition in
Returns
This

◆ savePoints()

vector< DurationSize > fs::Iteration::savePoints ( ) const
nodiscard

Points in time that ProbabilityMaps get saved for.

Returns
Points in time that ProbabilityMaps get saved for

◆ size()

size_t fs::Iteration::size ( ) const
nodiscardnoexcept

Number of Scenarios in this Iteration.

Returns
Number of Scenarios in this Iteration

◆ startTime()

DurationSize fs::Iteration::startTime ( ) const
nodiscard

Time that simulations start.

Returns
Time that simulations start

The documentation for this class was generated from the following files: