Fire Behavior SDK Reference Manual · 2018. 6. 21. · Fire Behavior SDK Reference Manual 1.0.0 Generated by Doxygen 1.4.6 Fri May 12 14:40:41 2006

Fire Behavior SDK Reference Manual1.0.0

Generated by Doxygen 1.4.6

Fri May 12 14:40:41 2006

Contents

1 Fire Behavior SDK Directory Hierarchy 1

1.1 Fire Behavior SDK Directories . . . . . . . . . . . . . . . . . . . . . 1

2 Fire Behavior SDK Namespace Index 3

2.1 Fire Behavior SDK Namespace List . . . . . . . . . . . . . . . . . . 3

3 Fire Behavior SDK Hierarchical Index 5

3.1 Fire Behavior SDK Class Hierarchy . . . . . . . . . . . . . . . . . . 5

4 Fire Behavior SDK Class Index 7

4.1 Fire Behavior SDK Class List . . . . . . . . . . . . . . . . . . . . . 7

5 Fire Behavior SDK File Index 11

5.1 Fire Behavior SDK File List . . . . . . . . . . . . . . . . . . . . . . 11

6 Fire Behavior SDK Page Index 15

6.1 Fire Behavior SDK Related Pages . . . . . . . . . . . . . . . . . . . 15

7 Fire Behavior SDK Directory Documentation 17

7.1 src/ Directory Reference . . . . . . . . . . . . . . . . . . . . . . . . 17

8 Fire Behavior SDK Namespace Documentation 25

8.1 Sem Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . 25

8.2 std Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . 61

9 Fire Behavior SDK Class Documentation 63

ii CONTENTS

9.1 _fofemSpecies Struct Reference . . . . . . . . . . . . . . . . . . . . 63

9.2 Sem::Compass Class Reference . . . . . . . . . . . . . . . . . . . . 65

9.3 Sem::CompassAlgorithm Class Reference . . . . . . . . . . . . . . . 75

9.4 Sem::Contain Class Reference . . . . . . . . . . . . . . . . . . . . . 77

9.5 Sem::ContainForce Class Reference . . . . . . . . . . . . . . . . . . 100

9.6 Sem::ContainResource Class Reference . . . . . . . . . . . . . . . . 110

9.7 Sem::ContainSim Class Reference . . . . . . . . . . . . . . . . . . . 116

9.8 Sem::CrownFireAlgorithm Class Reference . . . . . . . . . . . . . . 133

9.9 Sem::CrownFireSpread Class Reference . . . . . . . . . . . . . . . . 138

9.10 Sem::DeadFuelMoisture Class Reference . . . . . . . . . . . . . . . 159

9.11 Sem::FofemTreeSpecies Class Reference . . . . . . . . . . . . . . . 199

9.12 Sem::HandlerDemo Class Reference . . . . . . . . . . . . . . . . . . 208

9.13 Sem::IgnitionAlgorithm Class Reference . . . . . . . . . . . . . . . . 211

9.14 Sem::LoggerBase Class Reference . . . . . . . . . . . . . . . . . . . 216

9.15 Sem::SafetyAlgorithm Class Reference . . . . . . . . . . . . . . . . 219

9.16 Sem::SemTime Class Reference . . . . . . . . . . . . . . . . . . . . 221

9.17 Sem::Signal Class Reference . . . . . . . . . . . . . . . . . . . . . . 245

9.18 Sem::SpotAlgorithm Class Reference . . . . . . . . . . . . . . . . . 255

9.19 Sem::SpotBurningPile Class Reference . . . . . . . . . . . . . . . . 266

9.20 Sem::SpotSurfaceFire Class Reference . . . . . . . . . . . . . . . . . 282

9.21 Sem::SpotTorchingTrees Class Reference . . . . . . . . . . . . . . . 299

9.22 Sem::SurfaceFireFuel Class Reference . . . . . . . . . . . . . . . . . 322

9.23 Sem::SurfaceFireFuelAlgorithm Class Reference . . . . . . . . . . . 363

9.24 Sem::SurfaceFireFuelInterface Class Reference . . . . . . . . . . . . 389

9.25 Sem::SurfaceFireFuelModel Class Reference . . . . . . . . . . . . . 397

9.26 Sem::SurfaceFireMoistureInterface Class Reference . . . . . . . . . . 408

9.27 Sem::SurfaceFireMoistureTimeLag Class Reference . . . . . . . . . 415

9.28 Sem::SurfaceFireParticle Class Reference . . . . . . . . . . . . . . . 428

9.29 Sem::SurfaceFireParticleInterface Class Reference . . . . . . . . . . 458

9.30 Sem::SurfaceFireSpread Class Reference . . . . . . . . . . . . . . . 471

9.31 Sem::SurfaceFireSpreadAlgorithm Class Reference . . . . . . . . . . 509

Generated on Fri May 12 14:40:41 2006 for Fire Behavior SDK by Doxygen

CONTENTS iii

9.32 Sem::SurfaceFireTerrain Class Reference . . . . . . . . . . . . . . . 532

9.33 Sem::SurfaceFireTerrainInterface Class Reference . . . . . . . . . . . 543

9.34 Sem::SurfaceFireWind Class Reference . . . . . . . . . . . . . . . . 550

9.35 Sem::SurfaceFireWindInterface Class Reference . . . . . . . . . . . . 559

9.36 Sem::TreeMortality Class Reference . . . . . . . . . . . . . . . . . . 564

9.37 Sem::TreeMortalityAlgorithm Class Reference . . . . . . . . . . . . 579

9.38 Sem::WeatherAlgorithm Class Reference . . . . . . . . . . . . . . . 585

10 Fire Behavior SDK File Documentation 591

10.1 citations.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 591

10.2 Compass.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . 592

10.3 Compass.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 596

10.4 CompassAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . . 600

10.5 CompassAlgorithm.h File Reference . . . . . . . . . . . . . . . . . . 601

10.6 config.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 603

10.7 Contain.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 605

10.8 Contain.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 607

10.9 ContainForce.cpp File Reference . . . . . . . . . . . . . . . . . . . . 610

10.10ContainForce.h File Reference . . . . . . . . . . . . . . . . . . . . . 611

10.11ContainResource.cpp File Reference . . . . . . . . . . . . . . . . . . 612

10.12ContainResource.h File Reference . . . . . . . . . . . . . . . . . . . 613

10.13ContainSim.cpp File Reference . . . . . . . . . . . . . . . . . . . . . 615

10.14ContainSim.h File Reference . . . . . . . . . . . . . . . . . . . . . . 617

10.15CrownFireAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . 620

10.16CrownFireAlgorithm.h File Reference . . . . . . . . . . . . . . . . . 621

10.17CrownFireSpread.cpp File Reference . . . . . . . . . . . . . . . . . . 622

10.18CrownFireSpread.h File Reference . . . . . . . . . . . . . . . . . . . 624

10.19DeadFuelMoisture.cpp File Reference . . . . . . . . . . . . . . . . . 626

10.20DeadFuelMoisture.h File Reference . . . . . . . . . . . . . . . . . . 628

10.21fbsdk.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 630

10.22FofemTreeSpecies.cpp File Reference . . . . . . . . . . . . . . . . . 632


iv CONTENTS

10.23FofemTreeSpecies.h File Reference . . . . . . . . . . . . . . . . . . 634

10.24Handler.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 635

10.25Handler.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 636

10.26IgnitionAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . . 638

10.27IgnitionAlgorithm.h File Reference . . . . . . . . . . . . . . . . . . . 639

10.28Logger.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 640

10.29Logger.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 641

10.30SafetyAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . . . 644

10.31SafetyAlgorithm.h File Reference . . . . . . . . . . . . . . . . . . . 645

10.32SemTime.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . 646

10.33SemTime.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 647

10.34Signal.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . 649

10.35Signal.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 650

10.36SpotAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . . . . 653

10.37SpotAlgorithm.h File Reference . . . . . . . . . . . . . . . . . . . . 654

10.38SpotBurningPile.cpp File Reference . . . . . . . . . . . . . . . . . . 655

10.39SpotBurningPile.h File Reference . . . . . . . . . . . . . . . . . . . 656

10.40SpotSurfaceFire.cpp File Reference . . . . . . . . . . . . . . . . . . 658

10.41SpotSurfaceFire.h File Reference . . . . . . . . . . . . . . . . . . . . 659

10.42SpotTorchingTrees.cpp File Reference . . . . . . . . . . . . . . . . . 661

10.43SpotTorchingTrees.h File Reference . . . . . . . . . . . . . . . . . . 662

10.44SurfaceFireFuel.cpp File Reference . . . . . . . . . . . . . . . . . . 664

10.45SurfaceFireFuel.h File Reference . . . . . . . . . . . . . . . . . . . . 666

10.46SurfaceFireFuelAlgorithm.cpp File Reference . . . . . . . . . . . . . 668

10.47SurfaceFireFuelAlgorithm.h File Reference . . . . . . . . . . . . . . 669

10.48SurfaceFireFuelInterface.h File Reference . . . . . . . . . . . . . . . 671

10.49SurfaceFireFuelModel.cpp File Reference . . . . . . . . . . . . . . . 673

10.50SurfaceFireFuelModel.h File Reference . . . . . . . . . . . . . . . . 675

10.51SurfaceFireFuelModelFactory.cpp File Reference . . . . . . . . . . . 677

10.52SurfaceFireFuelModelFactory.h File Reference . . . . . . . . . . . . 685

10.53SurfaceFireMoistureInterface.h File Reference . . . . . . . . . . . . . 694


CONTENTS v

10.54SurfaceFireMoistureTimeLag.cpp File Reference . . . . . . . . . . . 696

10.55SurfaceFireMoistureTimeLag.h File Reference . . . . . . . . . . . . 698

10.56SurfaceFireParticle.cpp File Reference . . . . . . . . . . . . . . . . . 700

10.57SurfaceFireParticle.h File Reference . . . . . . . . . . . . . . . . . . 702

10.58SurfaceFireParticleInterface.h File Reference . . . . . . . . . . . . . 704

10.59SurfaceFireSpread.cpp File Reference . . . . . . . . . . . . . . . . . 706

10.60SurfaceFireSpread.h File Reference . . . . . . . . . . . . . . . . . . 708

10.61SurfaceFireSpreadAlgorithm.cpp File Reference . . . . . . . . . . . . 710

10.62SurfaceFireSpreadAlgorithm.h File Reference . . . . . . . . . . . . . 711

10.63SurfaceFireTerrain.cpp File Reference . . . . . . . . . . . . . . . . . 712

10.64SurfaceFireTerrain.h File Reference . . . . . . . . . . . . . . . . . . 714

10.65SurfaceFireTerrainInterface.h File Reference . . . . . . . . . . . . . . 716

10.66SurfaceFireWind.cpp File Reference . . . . . . . . . . . . . . . . . . 718

10.67SurfaceFireWind.h File Reference . . . . . . . . . . . . . . . . . . . 720

10.68SurfaceFireWindInterface.h File Reference . . . . . . . . . . . . . . 722

10.69TreeMortality.cpp File Reference . . . . . . . . . . . . . . . . . . . . 724

10.70TreeMortality.h File Reference . . . . . . . . . . . . . . . . . . . . . 725

10.71TreeMortalityAlgorithm.cpp File Reference . . . . . . . . . . . . . . 727

10.72TreeMortalityAlgorithm.h File Reference . . . . . . . . . . . . . . . 728

10.73WeatherAlgorithm.cpp File Reference . . . . . . . . . . . . . . . . . 729

10.74WeatherAlgorithm.h File Reference . . . . . . . . . . . . . . . . . . 730

11 Fire Behavior SDK Page Documentation 731

11.1 Cited Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731

11.2 Dead Fuel Moisture . . . . . . . . . . . . . . . . . . . . . . . . . . . 736

11.3 Deprecated List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739

11.4 Todo List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740

11.5 License Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741


Chapter 1

Fire Behavior SDK DirectoryHierarchy

1.1 Fire Behavior SDK Directories

This directory hierarchy is sorted roughly, but not completely, alphabetically:

src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2 Fire Behavior SDK Directory Hierarchy


Chapter 2

Fire Behavior SDK NamespaceIndex

2.1 Fire Behavior SDK Namespace List

Here is a list of all documented namespaces with brief descriptions:

Sem (The SEM common source C++ namespace identifier ) . . . . . . . . . . 25std . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4 Fire Behavior SDK Namespace Index


Chapter 3

Fire Behavior SDK HierarchicalIndex

3.1 Fire Behavior SDK Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

_fofemSpecies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63QObject

Sem::HandlerDemo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Sem::LoggerBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Sem::Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Sem::Compass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Sem::CrownFireSpread . . . . . . . . . . . . . . . . . . . . . . . . . 138Sem::SpotBurningPile . . . . . . . . . . . . . . . . . . . . . . . . . 266Sem::SpotSurfaceFire . . . . . . . . . . . . . . . . . . . . . . . . . . 282Sem::SpotTorchingTrees . . . . . . . . . . . . . . . . . . . . . . . . 299Sem::SurfaceFireFuelInterface . . . . . . . . . . . . . . . . . . . . . 389

Sem::SurfaceFireFuel . . . . . . . . . . . . . . . . . . . . . . . . 322Sem::SurfaceFireFuelModel . . . . . . . . . . . . . . . . . . 397

Sem::SurfaceFireMoistureInterface . . . . . . . . . . . . . . . . . . . 408Sem::SurfaceFireMoistureTimeLag . . . . . . . . . . . . . . . . . 415

Sem::SurfaceFireParticleInterface . . . . . . . . . . . . . . . . . . . 458Sem::SurfaceFireParticle . . . . . . . . . . . . . . . . . . . . . . 428

Sem::SurfaceFireSpread . . . . . . . . . . . . . . . . . . . . . . . . 471Sem::SurfaceFireTerrainInterface . . . . . . . . . . . . . . . . . . . . 543

Sem::SurfaceFireTerrain . . . . . . . . . . . . . . . . . . . . . . 532Sem::SurfaceFireWindInterface . . . . . . . . . . . . . . . . . . . . . 559

Sem::SurfaceFireWind . . . . . . . . . . . . . . . . . . . . . . . 550

6 Fire Behavior SDK Hierarchical Index

Sem::TreeMortality . . . . . . . . . . . . . . . . . . . . . . . . . . . 564Sem::CompassAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Sem::Contain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Sem::ContainForce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Sem::ContainResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Sem::ContainSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Sem::CrownFireAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Sem::DeadFuelMoisture . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Sem::FofemTreeSpecies . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Sem::IgnitionAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Sem::SafetyAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Sem::SemTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Sem::SpotAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Sem::SurfaceFireFuelAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . 363Sem::SurfaceFireSpreadAlgorithm . . . . . . . . . . . . . . . . . . . . . . . 509Sem::TreeMortalityAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . 579Sem::WeatherAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585


Chapter 4

Fire Behavior SDK Class Index

4.1 Fire Behavior SDK Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

_fofemSpecies (Structure to hold FOFEM species names and equation in-dices ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Sem::Compass (Quantifies a global compass direction in terms of degreesclockwise from north ) . . . . . . . . . . . . . . . . . . . . . . . . 65

Sem::CompassAlgorithm (All compass algorithms are encapsulated in thisstatic class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 75

Sem::Contain (Fire flank (half-a-fire) containment object ) . . . . . . . . . . 77Sem::ContainForce (Collection of all ContainResources dispatched to the fire )100Sem::ContainResource (A single fire containment resource unit that can be

dispatched to a fire. Examples include an engine crew, line crew,bulldozer, helicopter, airtanker, etc ) . . . . . . . . . . . . . . . . . 110

Sem::ContainSim (Fire containment simulation object ) . . . . . . . . . . . . 116Sem::CrownFireAlgorithm (All fire safety zone algorithms are encapsulated

in this static class of pure functions ) . . . . . . . . . . . . . . . . . 133Sem::CrownFireSpread (Implements Rothermel, Richard C. 1991. crown

fire spread with additional support for transition to crown fire fromsurface fire ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Sem::DeadFuelMoisture (Determines moisture content of dead and downwoody fuels from ambient air temperature, relative humidity, in-solation, and rainfall ) . . . . . . . . . . . . . . . . . . . . . . . . . 159

Sem::FofemTreeSpecies (All fire ignition algorithms are encapsulated in thisstatic class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 199

Sem::HandlerDemo (Simple demo of an application-wide Singleton messagehandler that manages messages emitted by the Singleton Loggerinstance ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

8 Fire Behavior SDK Class Index

Sem::IgnitionAlgorithm (All fire ignition algorithms are encapsulated in thisstatic class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 211

Sem::LoggerBase (Application-wide Singleton destination for error mes-sages, which can be observed/subscribed to by client reporters ) . . 216

Sem::SafetyAlgorithm (All fire safety zone algorithms are encapsulated inthis static class of pure functions ) . . . . . . . . . . . . . . . . . . 219

Sem::SemTime (Date and time class ) . . . . . . . . . . . . . . . . . . . . . 221Sem::Signal (Base class for implementing SEM object signal/slot and meta

class communication ) . . . . . . . . . . . . . . . . . . . . . . . . 245Sem::SpotAlgorithm (All fire spotting distance fuel algorithms are encapsu-

lated in this static class of pure functions ) . . . . . . . . . . . . . . 255Sem::SpotBurningPile (An implementation of Albini’s Albini, Frank A.

1979. model for predicting maximum spotting distance from agroup of burning trees ) . . . . . . . . . . . . . . . . . . . . . . . . 266

Sem::SpotSurfaceFire (An implementation of Albini’s Albini, Frank A.1979. model for predicting maximum spotting distance from agroup of burning trees ) . . . . . . . . . . . . . . . . . . . . . . . . 282

Sem::SpotTorchingTrees (An implementation of Albini’s Albini, Frank A.1979. model for predicting maximum spotting distance from agroup of burning trees ) . . . . . . . . . . . . . . . . . . . . . . . . 299

Sem::SurfaceFireFuel (An implementation of the SurfaceFireFuelInterfaceapplying the classic Rothermel/Albini (BEHAVE/BehavePlus) al-gorithms ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Sem::SurfaceFireFuelAlgorithm (All surface fuel algorithms are encapsu-lated in this static class of pure functions ) . . . . . . . . . . . . . . 363

Sem::SurfaceFireFuelInterface (An abstract base class defining an interfaceto provide fuel bed information required by the classic Rother-mel/Albini (BEHAVE/BehavePlus) algorithms ) . . . . . . . . . . . 389

Sem::SurfaceFireFuelModel (A derivation of SurfaceFireFuel with addedsupport for model name, id, and description ) . . . . . . . . . . . . 397

Sem::SurfaceFireMoistureInterface (An abstract base class defining an inter-face to provide surface fire fuel particle moisture content informa-tion ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

Sem::SurfaceFireMoistureTimeLag (A simple implementation of theSurfaceFireMoistureInterface for accessing and updating fuel par-ticle moisture contents at a specific location and time ) . . . . . . . 415

Sem::SurfaceFireParticle (An implementation of the SurfaceFireParticle-Interface that follows the implementations of Rothermel, Albini,BEHAVE, BehavePlus, etc ) . . . . . . . . . . . . . . . . . . . . . 428

Sem::SurfaceFireParticleInterface (An abstract base class defining an inter-face to provide surface fire fuel particle information (size, load,moisture, etc.) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Sem::SurfaceFireSpread (Determines elliptical surface fire spread rateand fireline intensity from SurfaceFireFuelInterface, SurfaceFire-TerrainInterface, and SurfaceFireWindInterface instances ) . . . . . 471


4.1 Fire Behavior SDK Class List 9

Sem::SurfaceFireSpreadAlgorithm (All surface fire spread algorithms are en-capsulated in this static class of pure functions ) . . . . . . . . . . . 509

Sem::SurfaceFireTerrain (A simple implementation of the SurfaceFire-TerrainInterface for accessing and updating terrain aspect andsteepness information at a specific point ) . . . . . . . . . . . . . . 532

Sem::SurfaceFireTerrainInterface (An abstract base class defining an inter-face to provide terrain aspect and steepness information ) . . . . . . 543

Sem::SurfaceFireWind (A simple implementation of the SurfaceFireWind-Interface for accessing and updating surface fire midflame windspeed and direction at a specific location and time ) . . . . . . . . . 550

Sem::SurfaceFireWindInterface (An abstract base class defining an interfaceto provide wind speed and bearing information ) . . . . . . . . . . . 559

Sem::TreeMortality (An implementation of the FOFEM tree mortality model ) 564Sem::TreeMortalityAlgorithm (All fire ignition algorithms are encapsulated

in this static class of pure functions ) . . . . . . . . . . . . . . . . . 579Sem::WeatherAlgorithm (All weather algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 585


10 Fire Behavior SDK Class Index


Chapter 5

Fire Behavior SDK File Index

5.1 Fire Behavior SDK File List

Here is a list of all documented files with brief descriptions:

citations.h (Contains all citations referenced by the code and documentation ) 591Compass.cpp (Quantifies a global compass direction in terms of degrees

clockwise from north ) . . . . . . . . . . . . . . . . . . . . . . . . 592Compass.h (Quantifies a global compass direction in terms of degrees clock-

wise from north ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 596CompassAlgorithm.cpp (All compass algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 600CompassAlgorithm.h (All compass algorithms are encapsulated in this static

class of pure functions ) . . . . . . . . . . . . . . . . . . . . . . . . 601config.h (Various constants and defines used by multiple classes ) . . . . . . . 603Contain.cpp (An implementation of the Fried and Fried containemnt model ) . 605Contain.h (An implementation of Freid and Fried (Fried, Jeremy S; Fried,

Burton D. 1995.) wildfire containment model ) . . . . . . . . . . . 607ContainForce.cpp (Collection of all ContainResources dispatched to the fire ) 610ContainForce.h (Collection of all ContainResources dispatched to the fire ) . . 611ContainResource.cpp (A single fire containment resource unit that can be

dispatched to a fire. Examples include an engine crew, line crew,bulldozer, helicopter, airtanker, etc ) . . . . . . . . . . . . . . . . . 612

ContainResource.h (A single fire containment resource unit that can be dis-patched to a fire. Examples include an engine crew, line crew, bull-dozer, helicopter, airtanker, etc ) . . . . . . . . . . . . . . . . . . . 613

ContainSim.cpp (An implementation of the Fried and Fried containemntmodel ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615

ContainSim.h (An implementation of Freid and Fried (Fried, Jeremy S;Fried, Burton D. 1995.) wildfire containment model ) . . . . . . . . 617

12 Fire Behavior SDK File Index

CrownFireAlgorithm.cpp (All crown fire algorithms are encapsulated in thisstatic class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 620

CrownFireAlgorithm.h (All crown fire algorithms are encapsulated in thisstatic class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 621

CrownFireSpread.cpp (Implements Rothermel, Richard C. 1991. crown firespread with additional support for transition to crown fire from sur-face fire ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622

CrownFireSpread.h (Implements Rothermel, Richard C. 1991. crown firespread with additional support for transition to crown fire from sur-face fire ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624

DeadFuelMoisture.cpp (DeadFuelMoisture class definition and implementa-tion ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626

DeadFuelMoisture.h (DeadFuelMoisture class interface and declarations ) . . 628fbsdk.h (Master header file for FBSDK ) . . . . . . . . . . . . . . . . . . . . 630FofemTreeSpecies.cpp (Access to all tree species defined by FOFEM 5.0 ) . . 632FofemTreeSpecies.h (All fire ignition algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 634Handler.cpp (Simple demo of an application-wide Singleton message handler

that manages messages emitted by the Singleton Logger instance ) . 635Handler.h (Simple demo of an application-wide Singleton message handler

that manages messages emitted by the Singleton Logger instance ) . 636IgnitionAlgorithm.cpp (All fire ignition algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 638IgnitionAlgorithm.h (All fire ignition algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 639Logger.cpp (Application-wide Singleton destination for error messages,

which can be observed/subscribed to by client reporters ) . . . . . . 640Logger.h (Logger message class interface and declarations ) . . . . . . . . . . 641SafetyAlgorithm.cpp (All fire safety zone algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 644SafetyAlgorithm.h (All fire safety zone algorithms are encapsulated in this

static class of pure functions ) . . . . . . . . . . . . . . . . . . . . . 645SemTime.cpp (SemTime class implementation and definition ) . . . . . . . . 646SemTime.h (SemTime class interface and declarations ) . . . . . . . . . . . . 647Signal.cpp (Base class for implementing SEM object signal/slot and meta

class communication ) . . . . . . . . . . . . . . . . . . . . . . . . 649Signal.h (Base class for implementing SEM object signal/slot and meta class

communication ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 650SpotAlgorithm.cpp (All fire spot distance fuel algorithms are encapsulated in

this static class of pure functions ) . . . . . . . . . . . . . . . . . . 653SpotAlgorithm.h (All fire spotting distance fuel algorithms are encapsulated

in this static class of pure functions ) . . . . . . . . . . . . . . . . . 654SpotBurningPile.cpp (An implementation of Albini’s Albini, Frank A. 1979.

model for predicting maximum spotting distance from a group ofburning trees ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655


5.1 Fire Behavior SDK File List 13

SpotBurningPile.h (An implementation of Albini’s Albini, Frank A. 1979.model for predicting maximum spotting distance from a group ofburning trees ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656

SpotSurfaceFire.cpp (An implementation of Albini’s Albini, Frank A. 1979.model for predicting maximum spotting distance from a group ofburning trees ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658

SpotSurfaceFire.h (An implementation of Albini’s Albini, Frank A. 1979.model for predicting maximum spotting distance from a group ofburning trees ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659

SpotTorchingTrees.cpp (An implementation of Albini’s Albini, Frank A.1979. model for predicting maximum spotting distance from agroup of burning trees ) . . . . . . . . . . . . . . . . . . . . . . . . 661

SpotTorchingTrees.h (An implementation of Albini’s Albini, Frank A. 1979.model for predicting maximum spotting distance from a group ofburning trees ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662

SurfaceFireFuel.cpp (An implementation of the SurfaceFireFuelInterface ap-plying the classic Rothermel/Albini (BEHAVE/BehavePlus) algo-rithms ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664

SurfaceFireFuel.h (An implementation of the SurfaceFireFuelInterface ap-plying the classic Rothermel/Albini (BEHAVE/BehavePlus) algo-rithms ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666

SurfaceFireFuelAlgorithm.cpp (All surface fuel algorithms are encapsulatedin this static class of pure functions ) . . . . . . . . . . . . . . . . . 668

SurfaceFireFuelAlgorithm.h (All surface fuel algorithms are encapsulated inthis static class of pure functions ) . . . . . . . . . . . . . . . . . . 669

SurfaceFireFuelInterface.h (An abstract base class defining an interfaceto provide fuel bed information required by the classic Rother-mel/Albini (BEHAVE/BehavePlus) algorithms ) . . . . . . . . . . . 671

SurfaceFireFuelModel.cpp (A derivation of SurfaceFireFuel with added sup-port for model name, id, and description ) . . . . . . . . . . . . . . 673

SurfaceFireFuelModel.h (A derivation of SurfaceFireFuel with added sup-port for model name, id, and description ) . . . . . . . . . . . . . . 675

SurfaceFireFuelModelFactory.cpp (Factory for the 13 original standard firebehavior fuel models as defined by Albini (1976) and 40 extendedfuel models defined by Scott and Burgan (2005) ) . . . . . . . . . . 677

SurfaceFireFuelModelFactory.h (Factory for the 13 original standard fire be-havior fuel models as defined by Albini (1976) and 40 extendedfuel models defined by Scott and Burgan (2005) ) . . . . . . . . . . 685

SurfaceFireMoistureInterface.h (An abstract base class defining an interfaceto provide surface fire fuel particle moisture content information ) . 694

SurfaceFireMoistureTimeLag.cpp (A simple implementation of the Surface-FireMoistureInterface for accessing and updating fuel particlemoisture contents at a specific location and time ) . . . . . . . . . . 696

SurfaceFireMoistureTimeLag.h (A simple implementation of the Surface-FireMoistureInterface for accessing and updating fuel particlemoisture contents at a specific location and time ) . . . . . . . . . . 698


14 Fire Behavior SDK File Index

SurfaceFireParticle.cpp (An implementation of the SurfaceFireParticle-Interface that follows the implementations of Rothermel, Albini,BEHAVE, BehavePlus, etc ) . . . . . . . . . . . . . . . . . . . . . 700

SurfaceFireParticle.h (An implementation of the SurfaceFireParticleInterfacethat follows the implementations of Rothermel, Albini, BEHAVE,BehavePlus, etc ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 702

SurfaceFireParticleInterface.h (An abstract base class defining an interface toprovide surface fire fuel particle information (size, load, moisture,etc.) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704

SurfaceFireSpread.cpp (Quantifies a surface fire instance ) . . . . . . . . . . 706SurfaceFireSpread.h (Determines elliptical surface fire spread rate and fire-

line intensity from SurfaceFireFuelInterface, SurfaceFireTerrain-Interface, and SurfaceFireWindInterface instances ) . . . . . . . . . 708

SurfaceFireSpreadAlgorithm.cpp (All surface fire spread algorithms are en-capsulated in this static class of pure functions ) . . . . . . . . . . . 710

SurfaceFireSpreadAlgorithm.h (All surface fire spread algorithms are encap-sulated in this static class of pure functions ) . . . . . . . . . . . . . 711

SurfaceFireTerrain.cpp (A simple implementation of the SurfaceFireTerrain-Interface for accessing and updating terrain aspect and steepnessinformation at a specific point ) . . . . . . . . . . . . . . . . . . . . 712

SurfaceFireTerrain.h (A simple implementation of the SurfaceFireTerrain-Interface for accessing and updating terrain aspect and steepnessinformation at a specific point ) . . . . . . . . . . . . . . . . . . . . 714

SurfaceFireTerrainInterface.h (An abstract base class defining an interface toprovide terrain aspect and steepness information ) . . . . . . . . . . 716

SurfaceFireWind.cpp (A simple implementation of the SurfaceFireWind-Interface for accessing and updating surface fire midflame windspeed and direction at a specific location and time ) . . . . . . . . . 718

SurfaceFireWind.h (A simple implementation of the SurfaceFireWind-Interface for accessing and updating surface fire midflame windspeed and direction at a specific location and time ) . . . . . . . . . 720

SurfaceFireWindInterface.h (An abstract base class defining an interface toprovide wind speed and bearing information ) . . . . . . . . . . . . 722

TreeMortality.cpp (An implementation of the FOFEM tree mortality model ) . 724TreeMortality.h (An implementation of the FOFEM tree mortality model ) . . 725TreeMortalityAlgorithm.cpp (All fire ignition algorithms are encapsulated in

this static class of pure functions ) . . . . . . . . . . . . . . . . . . 727TreeMortalityAlgorithm.h (All fire ignition algorithms are encapsulated in

this static class of pure functions ) . . . . . . . . . . . . . . . . . . 728WeatherAlgorithm.cpp (All weather algorithms are encapsulated in this static

class of pure functions ) . . . . . . . . . . . . . . . . . . . . . . . . 729WeatherAlgorithm.h (All weather algorithms are encapsulated in this static

class of pure functions ) . . . . . . . . . . . . . . . . . . . . . . . . 730


Chapter 6

Fire Behavior SDK Page Index

6.1 Fire Behavior SDK Related Pages

Here is a list of all related documentation pages:

Cited Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731Dead Fuel Moisture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736Deprecated List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739Todo List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740License Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741

16 Fire Behavior SDK Page Index


Chapter 7

Fire Behavior SDK DirectoryDocumentation

7.1 src/ Directory Reference

src

Files

• file citations.h

Contains all citations referenced by the code and documentation.

• file Compass.cpp

Quantifies a global compass direction in terms of degrees clockwise from north.

• file Compass.h


• file CompassAlgorithm.cpp

All compass algorithms are encapsulated in this static class of pure functions.

• file CompassAlgorithm.h


18 Fire Behavior SDK Directory Documentation

• file config.h

Various constants and defines used by multiple classes.

• file Contain.cpp

An implementation of the Fried and Fried containemnt model.

• file Contain.h

An implementation of Freid and Fried (Fried, Jeremy S; Fried, Burton D. 1995.) wild-fire containment model.

• file ContainForce.cpp

Collection of all ContainResources dispatched to the fire.

• file ContainForce.h


• file ContainResource.cpp

A single fire containment resource unit that can be dispatched to a fire. Examplesinclude an engine crew, line crew, bulldozer, helicopter, airtanker, etc.

• file ContainResource.h


• file ContainSim.cpp

An implementation of the Fried and Fried containemnt model.

• file ContainSim.h

An implementation of Freid and Fried (Fried, Jeremy S; Fried, Burton D. 1995.) wild-fire containment model.

• file CrownFireAlgorithm.cpp

All crown fire algorithms are encapsulated in this static class of pure functions.

• file CrownFireAlgorithm.h

All crown fire algorithms are encapsulated in this static class of pure functions.

• file CrownFireSpread.cpp

Implements Rothermel, Richard C. 1991. crown fire spread with additional supportfor transition to crown fire from surface fire.

• file CrownFireSpread.h


7.1 src/ Directory Reference 19


• file DeadFuelMoisture.cpp

DeadFuelMoisture class definition and implementation.

• file DeadFuelMoisture.h

DeadFuelMoisture class interface and declarations.

• file fbsdk.h

Master header file for FBSDK.

• file FofemTreeSpecies.cpp

Access to all tree species defined by FOFEM 5.0.

• file FofemTreeSpecies.h

All fire ignition algorithms are encapsulated in this static class of pure functions.

• file Handler.cpp

Simple demo of an application-wide Singleton message handler that manages mes-sages emitted by the Singleton Logger instance.

• file Handler.h


• file IgnitionAlgorithm.cpp


• file IgnitionAlgorithm.h


• file Logger.cpp

Application-wide Singleton destination for error messages, which can be ob-served/subscribed to by client reporters.

• file Logger.h

Logger message class interface and declarations.

• file SafetyAlgorithm.cpp

All fire safety zone algorithms are encapsulated in this static class of pure functions.

• file SafetyAlgorithm.h




• file SemTime.cpp

SemTime class implementation and definition.

• file SemTime.h

SemTime class interface and declarations.

• file Signal.cpp

Base class for implementing SEM object signal/slot and meta class communication.

• file Signal.h


• file SpotAlgorithm.cpp

All fire spot distance fuel algorithms are encapsulated in this static class of purefunctions.

• file SpotAlgorithm.h

All fire spotting distance fuel algorithms are encapsulated in this static class of purefunctions.

• file SpotBurningPile.cpp

An implementation of Albini’s Albini, Frank A. 1979. model for predicting maximumspotting distance from a group of burning trees.

• file SpotBurningPile.h


• file SpotSurfaceFire.cpp


• file SpotSurfaceFire.h


• file SpotTorchingTrees.cpp


• file SpotTorchingTrees.h




• file SurfaceFireFuel.cppAn implementation of the SurfaceFireFuelInterface applying the classic Rother-mel/Albini (BEHAVE/BehavePlus) algorithms.

• file SurfaceFireFuel.hAn implementation of the SurfaceFireFuelInterface applying the classic Rother-mel/Albini (BEHAVE/BehavePlus) algorithms.

• file SurfaceFireFuelAlgorithm.cppAll surface fuel algorithms are encapsulated in this static class of pure functions.

• file SurfaceFireFuelAlgorithm.hAll surface fuel algorithms are encapsulated in this static class of pure functions.

• file SurfaceFireFuelInterface.hAn abstract base class defining an interface to provide fuel bed information requiredby the classic Rothermel/Albini (BEHAVE/BehavePlus) algorithms.

• file SurfaceFireFuelModel.cppA derivation of SurfaceFireFuel with added support for model name, id, and descrip-tion.

• file SurfaceFireFuelModel.hA derivation of SurfaceFireFuel with added support for model name, id, and descrip-tion.

• file SurfaceFireFuelModelFactory.cppFactory for the 13 original standard fire behavior fuel models as defined by Albini(1976) and 40 extended fuel models defined by Scott and Burgan (2005).

• file SurfaceFireFuelModelFactory.hFactory for the 13 original standard fire behavior fuel models as defined by Albini(1976) and 40 extended fuel models defined by Scott and Burgan (2005).

• file SurfaceFireMoistureInterface.hAn abstract base class defining an interface to provide surface fire fuel particle mois-ture content information.

• file SurfaceFireMoistureTimeLag.cppA simple implementation of the SurfaceFireMoistureInterface for accessing and up-dating fuel particle moisture contents at a specific location and time.



• file SurfaceFireMoistureTimeLag.hA simple implementation of the SurfaceFireMoistureInterface for accessing and up-dating fuel particle moisture contents at a specific location and time.

• file SurfaceFireParticle.cppAn implementation of the SurfaceFireParticleInterface that follows the implementa-tions of Rothermel, Albini, BEHAVE, BehavePlus, etc.

• file SurfaceFireParticle.hAn implementation of the SurfaceFireParticleInterface that follows the implementa-tions of Rothermel, Albini, BEHAVE, BehavePlus, etc.

• file SurfaceFireParticleInterface.hAn abstract base class defining an interface to provide surface fire fuel particle infor-mation (size, load, moisture, etc.).

• file SurfaceFireSpread.cppQuantifies a surface fire instance.

• file SurfaceFireSpread.hDetermines elliptical surface fire spread rate and fireline intensity from SurfaceFire-FuelInterface, SurfaceFireTerrainInterface, and SurfaceFireWindInterface instances.

• file SurfaceFireSpreadAlgorithm.cppAll surface fire spread algorithms are encapsulated in this static class of pure func-tions.

• file SurfaceFireSpreadAlgorithm.hAll surface fire spread algorithms are encapsulated in this static class of pure func-tions.

• file SurfaceFireTerrain.cppA simple implementation of the SurfaceFireTerrainInterface for accessing and updat-ing terrain aspect and steepness information at a specific point.

• file SurfaceFireTerrain.hA simple implementation of the SurfaceFireTerrainInterface for accessing and updat-ing terrain aspect and steepness information at a specific point.

• file SurfaceFireTerrainInterface.hAn abstract base class defining an interface to provide terrain aspect and steepnessinformation.



• file SurfaceFireWind.cppA simple implementation of the SurfaceFireWindInterface for accessing and updatingsurface fire midflame wind speed and direction at a specific location and time.

• file SurfaceFireWind.hA simple implementation of the SurfaceFireWindInterface for accessing and updatingsurface fire midflame wind speed and direction at a specific location and time.

• file SurfaceFireWindInterface.hAn abstract base class defining an interface to provide wind speed and bearing infor-mation.

• file TreeMortality.cppAn implementation of the FOFEM tree mortality model.

• file TreeMortality.hAn implementation of the FOFEM tree mortality model.

• file TreeMortalityAlgorithm.cppAll fire ignition algorithms are encapsulated in this static class of pure functions.

• file TreeMortalityAlgorithm.hAll fire ignition algorithms are encapsulated in this static class of pure functions.

• file WeatherAlgorithm.cppAll weather algorithms are encapsulated in this static class of pure functions.

• file WeatherAlgorithm.hAll weather algorithms are encapsulated in this static class of pure functions.


Chapter 8

Fire Behavior SDK NamespaceDocumentation

8.1 Sem Namespace Reference

8.1.1 Detailed Description

The SEM common source C++ namespace identifier.

The C++ namespace identifier used for all common and shared code developed underthe direction of Systems for Environmental Management.

Classes

• class Compass


• class CompassAlgorithm


• class Contain

Fire flank (half-a-fire) containment object.

• class ContainForce


• class ContainResource

26 Fire Behavior SDK Namespace Documentation


• class ContainSim

Fire containment simulation object.

• class CrownFireAlgorithm


• class CrownFireSpread


• class DeadFuelMoisture

Determines moisture content of dead and down woody fuels from ambient air temper-ature, relative humidity, insolation, and rainfall.

• class FofemTreeSpecies


• class HandlerDemo


• class IgnitionAlgorithm


• class LoggerBase

Application-wide Singleton destination for error messages, which can be ob-served/subscribed to by client reporters.

• class SafetyAlgorithm


• class SemTime

Date and time class.

• class Signal


• class SpotAlgorithm

All fire spotting distance fuel algorithms are encapsulated in this static class of purefunctions.


8.1 Sem Namespace Reference 27

• class SpotBurningPileAn implementation of Albini’s Albini, Frank A. 1979. model for predicting maximumspotting distance from a group of burning trees.

• class SpotSurfaceFireAn implementation of Albini’s Albini, Frank A. 1979. model for predicting maximumspotting distance from a group of burning trees.

• class SpotTorchingTreesAn implementation of Albini’s Albini, Frank A. 1979. model for predicting maximumspotting distance from a group of burning trees.

• class SurfaceFireFuelAn implementation of the SurfaceFireFuelInterface applying the classic Rother-mel/Albini (BEHAVE/BehavePlus) algorithms.

• class SurfaceFireFuelAlgorithmAll surface fuel algorithms are encapsulated in this static class of pure functions.

• class SurfaceFireFuelInterfaceAn abstract base class defining an interface to provide fuel bed information requiredby the classic Rothermel/Albini (BEHAVE/BehavePlus) algorithms.

• class SurfaceFireFuelModelA derivation of SurfaceFireFuel with added support for model name, id, and descrip-tion.

• class SurfaceFireMoistureInterfaceAn abstract base class defining an interface to provide surface fire fuel particle mois-ture content information.

• class SurfaceFireMoistureTimeLagA simple implementation of the SurfaceFireMoistureInterface for accessing and up-dating fuel particle moisture contents at a specific location and time.

• class SurfaceFireParticleAn implementation of the SurfaceFireParticleInterface that follows the implementa-tions of Rothermel, Albini, BEHAVE, BehavePlus, etc.

• class SurfaceFireParticleInterfaceAn abstract base class defining an interface to provide surface fire fuel particle infor-mation (size, load, moisture, etc.).



• class SurfaceFireSpreadDetermines elliptical surface fire spread rate and fireline intensity from SurfaceFire-FuelInterface, SurfaceFireTerrainInterface, and SurfaceFireWindInterface instances.

• class SurfaceFireSpreadAlgorithmAll surface fire spread algorithms are encapsulated in this static class of pure func-tions.

• class SurfaceFireTerrainA simple implementation of the SurfaceFireTerrainInterface for accessing and updat-ing terrain aspect and steepness information at a specific point.

• class SurfaceFireTerrainInterfaceAn abstract base class defining an interface to provide terrain aspect and steepnessinformation.

• class SurfaceFireWindA simple implementation of the SurfaceFireWindInterface for accessing and updatingsurface fire midflame wind speed and direction at a specific location and time.

• class SurfaceFireWindInterfaceAn abstract base class defining an interface to provide wind speed and bearing infor-mation.

• class TreeMortalityAn implementation of the FOFEM tree mortality model.

• class TreeMortalityAlgorithmAll fire ignition algorithms are encapsulated in this static class of pure functions.

• class WeatherAlgorithmAll weather algorithms are encapsulated in this static class of pure functions.

Typedefs

• typedef Loki::SingletonHolder< HandlerDemo, Loki::CreateUsingNew > Han-dler

The Handler class Singleton typedef and policies.

• typedef Loki::SingletonHolder< LoggerBase, Loki::CreateUsingNew > Logger

The Logger class Singleton typedef and policies.



• typedef QVector< SurfaceFireParticleInterface ∗ > SurfaceFireParticleVectorQVector container of QPointers to SurfaceFireParticleInterface objects.

Enumerations

• enum ContainFlank { LeftFlank = 0, RightFlank = 1, BothFlanks = 2, Neither-Flank = 3 }

Identifies the fire flank to which ContainResource objects are assigned.

Functions

• bool operator== (const Sem::Compass &lhs, const Sem::Compass &rhs)Non-member equality operator between two Compass objects.

• bool operator== (const Sem::Compass &lhs, double degreesClockwiseFrom-North)

Non-member equality operator between a Compass object and a double value.

• bool operator== (double degreesClockwiseFromNorth, const Sem::Compass&rhs)

Non-member equality operator between a double value and a Compass object.

• bool operator!= (const Sem::Compass &lhs, const Sem::Compass &rhs)Non-member inequality operator between two Compass objects.

• bool operator!= (const Sem::Compass &lhs, double degreesClockwiseFrom-North)

Inequality operator between a Compass object and a double value.

• bool operator!= (double degreesClockwiseFromNorth, const Sem::Compass&rhs)

Equality operator between a double value and a Compass object.

• bool operator> (const Sem::Compass &lhs, const Sem::Compass &rhs)Greater-than operator between two Compass objects.

• bool operator> (const Sem::Compass &lhs, double degreesClockwiseFrom-North)

Greater-than operator between a Compass object and a double value.



• bool operator> (double degreesClockwiseFromNorth, const Sem::Compass&rhs)

Greater-than operator between a double value and a Compass object.

• bool operator>= (const Sem::Compass &lhs, const Sem::Compass &rhs)

Greater-than-or-equal operator between two Compass objects.

• bool operator>= (const Sem::Compass &lhs, double degreesClockwiseFrom-North)

Greater-than-or-equal operator between a Compass object and a double value.

• bool operator>= (double degreesClockwiseFromNorth, const Sem::Compass&rhs)

Greater-than-or-equal operator between a double value and a Compass object.

• bool operator< (const Sem::Compass &lhs, const Sem::Compass &rhs)

Less-than operator between two Compass objects.

• bool operator< (const Sem::Compass &lhs, double degreesClockwiseFrom-North)

Less-than operator between a Compass object and a double value.

• bool operator< (double degreesClockwiseFromNorth, const Sem::Compass&rhs)

Less-than operator between a double value and a Compass object.

• bool operator


Binary stream output operator.

• std::istream & operator>> (std::istream &input, Sem::Compass &rhs)

Text stream input operator>>.

• QDataStream & operator>> (QDataStream &input, Sem::Compass &rhs)

Binary stream input operator>>.

• bool operator== (const Sem::CrownFireSpread &lhs, const Sem::CrownFire-Spread &rhs)

Non-member equality operator between two CrownFireSpread objects.

• bool operator!= (const Sem::CrownFireSpread &lhs, const Sem::CrownFire-Spread &rhs)

Non-member inequality operator between two CrownFireSpread objects.

• bool operator== (const Sem::Signal &lhs, const Sem::Signal &rhs)

Non-member equality operator between two Signal objects.

• bool operator!= (const Sem::Signal &lhs, const Sem::Signal &rhs)

Non-member inequality operator between two Signal objects.

• bool operator== (const Sem::SpotBurningPile &lhs, const Sem::SpotBurning-Pile &rhs)

Non-member equality operator between two SpotBurningPile objects.

• bool operator!= (const Sem::SpotBurningPile &lhs, const Sem::SpotBurningPile&rhs)

Non-member inequality operator between two SpotBurningPile objects.

• bool operator== (const Sem::SpotSurfaceFire &lhs, const Sem::SpotSurfaceFire&rhs)

Non-member equality operator between two SpotSurfaceFire objects.

• bool operator!= (const Sem::SpotSurfaceFire &lhs, const Sem::SpotSurfaceFire&rhs)

Non-member inequality operator between two SpotSurfaceFire objects.

• bool operator== (const Sem::SpotTorchingTrees &lhs, const Sem::Spot-TorchingTrees &rhs)

Non-member equality operator between two SpotTorchingTrees objects.



• bool operator!= (const Sem::SpotTorchingTrees &lhs, const Sem::SpotTorching-Trees &rhs)

Non-member inequality operator between two SpotTorchingTrees objects.

• bool operator== (const Sem::SurfaceFireFuel &lhs, const Sem::SurfaceFireFuel&rhs)

Non-member equality operator between two SurfaceFireFuel objects.

• bool operator!= (const Sem::SurfaceFireFuel &lhs, const Sem::SurfaceFireFuel&rhs)

Non-member inequality operator between two SurfaceFireFuel objects.

• bool operator== (const Sem::SurfaceFireFuelModel &lhs, const Sem::Surface-FireFuelModel &rhs)

Non-member equality operator between two SurfaceFireFuelModel objects.

• bool operator!= (const Sem::SurfaceFireFuelModel &lhs, const Sem::Surface-FireFuelModel &rhs)

Non-member inequality operator between two SurfaceFireFuelModel objects.

• Sem::SurfaceFireFuelModel ∗ createFuelModel (int id, SurfaceFireMoisture-Interface ∗moisture)

Creates a SurfaceFireFuelModel for the 13 original standard fire behavior fuel mod-els as defined by Albini (1976) and 40 extended fuel models defined by Scott andBurgan (2005).

• Sem::SurfaceFireFuelModel ∗ createFuelModel (const QString &standard-Name, SurfaceFireMoistureInterface ∗moisture)

Creates a SurfaceFireFuelModel for the 13 original standard fire behavior fuel mod-els as defined by Albini (1976) and 40 extended fuel models defined by Scott andBurgan (2005).

• Sem::SurfaceFireFuelModel ∗ createFuelModel001 (void)Creates the original standard fire behavior fuel model 1, short grass (1 ft), as definedby Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel002 (void)Creates the original standard fire behavior fuel model 2, timber (grass and under-story) as defined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel003 (void)Creates the original standard fire behavior fuel model 3, tall grass (2.5 ft) as definedby Albini (1976).



• Sem::SurfaceFireFuelModel ∗ createFuelModel004 (void)Creates the original standard fire behavior fuel model 4, chaparral (6 ft) as definedby Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel005 (void)Creates the original standard fire behavior fuel model 5, brush (2 ft) as defined byAlbini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel006 (void)Creates the original standard fire behavior fuel model 6, dormant brush, hardwoodslash as defined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel007 (void)Creates the original standard fire behavior fuel model 7, southern rough as definedby Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel008 (void)Creates the original standard fire behavior fuel model 8, closed timber litter as definedby Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel009 (void)Creates the original standard fire behavior fuel model 9, hardwood litter as definedby Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel010 (void)Creates the original standard fire behavior fuel model 10, timber (litter and under-story) as defined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel011 (void)Creates the original standard fire behavior fuel model 11, light logging slash as de-fined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel012 (void)Creates the original standard fire behavior fuel model 11, medium logging slash asdefined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel013 (void)Creates the original standard fire behavior fuel model 13, heavy logging slash asdefined by Albini (1976).

• Sem::SurfaceFireFuelModel ∗ createFuelModel101 (void)Creates the extended standard fire behavior fuel model 101 (gr1), short, sparse, dryclimate grass.



• Sem::SurfaceFireFuelModel ∗ createFuelModel102 (void)Creates the extended standard fire behavior fuel model 102 (gr2), low load, dry cli-mate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel103 (void)Creates the extended standard fire behavior fuel model 103 (gr3), low load, verycoarse, humid climate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel104 (void)Creates the extended standard fire behavior fuel model 104 (gr4), moderate load, dryclimate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel105 (void)Creates the extended standard fire behavior fuel model 105 (gr5), low load, humidclimate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel106 (void)Creates the extended standard fire behavior fuel model 106 (gr6), moderate load,humid climate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel107 (void)Creates the extended standard fire behavior fuel model 107 (gr7), high load, dry cli-mate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel108 (void)Creates the extended standard fire behavior fuel model 108 (gr8), high load, verycoarse, humid climate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel109 (void)Creates the extended standard fire behavior fuel model 109 (gr9), very high load,humid climate grass.

• Sem::SurfaceFireFuelModel ∗ createFuelModel121 (void)Creates the extended standard fire behavior fuel model 121 (gs1), low load, dry cli-mate grass-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel122 (void)Creates the extended standard fire behavior fuel model 122 (gs2), moderate load,humid climate grass-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel123 (void)Creates the extended standard fire behavior fuel model 123 (gs3), moderate load,humid climate grass-shrub.



• Sem::SurfaceFireFuelModel ∗ createFuelModel124 (void)Creates the extended standard fire behavior fuel model 124 (gs4), high load, humidclimate grass-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel141 (void)Creates the extended standard fire behavior fuel model 141 (sh1), low load, dry cli-mate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel142 (void)Creates the extended standard fire behavior fuel model 142 (sh2), moderate load, dryclimate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel143 (void)Creates the extended standard fire behavior fuel model 143 (sh3), moderate load,humid climate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel144 (void)Creates the extended standard fire behavior fuel model 144 (sh4), low load, humidclimate timber-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel145 (void)Creates the extended standard fire behavior fuel model 145 (sh5), high load, dry cli-mate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel146 (void)Creates the extended standard fire behavior fuel model 146 (sh6), low load, humidclimate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel147 (void)Creates the extended standard fire behavior fuel model 147 (sh7), very high load, dryclimate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel148 (void)Creates the extended standard fire behavior fuel model 148 (sh8), high load, humidclimate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel149 (void)Creates the extended standard fire behavior fuel model 149 (sh9), very high load,humid climate shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel161 (void)Creates the extended standard fire behavior fuel model 161 (tu1), light load, dry cli-mate timber-grass-shrub.



• Sem::SurfaceFireFuelModel ∗ createFuelModel162 (void)Creates the extended standard fire behavior fuel model 162 (tu2), moderate load,humid climate timber-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel163 (void)Creates the extended standard fire behavior fuel model 163 (tu3), moderate load,humid climate timber-grass-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel164 (void)Creates the extended standard fire behavior fuel model 164 (tu4), dwarf conifer withunderstory.

• Sem::SurfaceFireFuelModel ∗ createFuelModel165 (void)Creates the extended standard fire behavior fuel model 165 (tu5), very high load, dryclimate timber-shrub.

• Sem::SurfaceFireFuelModel ∗ createFuelModel181 (void)Creates the extended standard fire behavior fuel model 181 (tl1), low load compactconifer litter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel182 (void)Creates the extended standard fire behavior fuel model 182 (tl2), low load broadleaflitter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel183 (void)Creates the extended standard fire behavior fuel model 183 (tl3), moderate loadconifer litter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel184 (void)Creates the extended standard fire behavior fuel model 184 (tl4), small downed logs.

• Sem::SurfaceFireFuelModel ∗ createFuelModel185 (void)Creates the extended standard fire behavior fuel model 185 (tl5), high load coniferlitter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel186 (void)Creates the extended standard fire behavior fuel model 186 (tl6), moderate loadbroadleaf litter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel187 (void)Creates the extended standard fire behavior fuel model 187 (tl7), large downed logs.

• Sem::SurfaceFireFuelModel ∗ createFuelModel188 (void)Creates the extended standard fire behavior fuel model 188 (tl8), long-needle litter.



• Sem::SurfaceFireFuelModel ∗ createFuelModel189 (void)Creates the extended standard fire behavior fuel model 189 (tl9), very high loadbroadleaf litter.

• Sem::SurfaceFireFuelModel ∗ createFuelModel201 (void)Creates the extended standard fire behavior fuel model 201 (sb1), low load activityfuel.

• Sem::SurfaceFireFuelModel ∗ createFuelModel202 (void)Creates the extended standard fire behavior fuel model 202 (sb2), moderate load ac-tivity or low load blowdown.

• Sem::SurfaceFireFuelModel ∗ createFuelModel203 (void)Creates the extended standard fire behavior fuel model 203 (sb3), high load activityor moderate load blowdown.

• Sem::SurfaceFireFuelModel ∗ createFuelModel204 (void)Creates the extended standard fire behavior fuel model 204 (sb4), high load blow-down.

• Sem::SurfaceFireFuelModel ∗ createSurfaceFireFuelModel (int id, constQString &name, const QString &desc, double mextDead)

Factory convenience method to create and test the SurfaceFireFuelModel portion ofthe fuel model.

• bool operator== (const Sem::SurfaceFireMoistureTimeLag &lhs, constSem::SurfaceFireMoistureTimeLag &rhs)

Non-member equality operator between two SurfaceFireMoistureTimeLag objects.

• bool operator!= (const Sem::SurfaceFireMoistureTimeLag &lhs, constSem::SurfaceFireMoistureTimeLag &rhs)

Non-member inequality operator between two SurfaceFireMoistureTimeLag objects.

• bool operator== (const Sem::SurfaceFireParticle &lhs, const Sem::SurfaceFire-Particle &rhs)

Non-member equality operator between two SurfaceFireParticle objects.

• bool operator!= (const Sem::SurfaceFireParticle &lhs, const Sem::SurfaceFire-Particle &rhs)

Non-member inequality operator between two SurfaceFireParticle objects.

• bool operator== (const Sem::SurfaceFireSpread &lhs, const Sem::SurfaceFire-Spread &rhs)



Non-member equality operator between two SurfaceFireSpread objects.

• bool operator!= (const Sem::SurfaceFireSpread &lhs, const Sem::SurfaceFire-Spread &rhs)

Non-member inequality operator between two SurfaceFireSpread objects.

• bool operator== (const Sem::SurfaceFireTerrain &lhs, const Sem::SurfaceFire-Terrain &rhs)

Non-member equality operator between two SurfaceFireTerrain objects.

• bool operator!= (const Sem::SurfaceFireTerrain &lhs, const Sem::SurfaceFire-Terrain &rhs)

Non-member inequality operator between two SurfaceFireTerrain objects.

• bool operator== (const Sem::SurfaceFireWind &lhs, const Sem::SurfaceFire-Wind &rhs)

Non-member equality operator between two SurfaceFireWind objects.

• bool operator!= (const Sem::SurfaceFireWind &lhs, const Sem::SurfaceFire-Wind &rhs)

Non-member inequality operator between two SurfaceFireWind objects.

• bool operator== (const Sem::TreeMortality &lhs, const Sem::TreeMortality&rhs)

Non-member equality operator between two TreeMortality objects.

• bool operator!= (const Sem::TreeMortality &lhs, const Sem::TreeMortality&rhs)

Non-member inequality operator between two TreeMortality objects.

Variables

• static const double Smidgen = 0.0000001

Anything less than this is treated as zero.

8.1.2 Enumeration Type Documentation

8.1.2.1 enum Sem::ContainFlank

Identifies the fire flank to which ContainResource objects are assigned.



Enumerator:LeftFlank Attack left (upper) flank only (full production).

RightFlank Attack right (lower) flank only (full production).

BothFlanks Attack both flanks (half of production per flank).

NeitherFlank Attack neither flank (inactive).

Definition at line 27 of file ContainResource.h.

8.1.3 Function Documentation

8.1.3.1 Sem::SurfaceFireFuelModel ∗ Sem::createFuelModel (const QString &standardName, SurfaceFireMoistureInterface ∗ moisture = 0)

Creates a SurfaceFireFuelModel for the 13 original standard fire behavior fuel modelsas defined by Albini (1976) and 40 extended fuel models defined by Scott and Burgan(2005).

Parameters:← standardName One of the standard fire behavior fuel model names:



I d Name Description1 1 Short grass (2 ft)2 2 Timber (grass and

understory)3 3 Tall grass (2.5 ft)4 4 Chaparral (6 ft)5 5 Brush (2 ft)6 6 Dormant brush,

hardwood slash7 7 Southern rough8 8 Closed timber litter9 9 Hardwood litter10 10 Timber (litter and

understory)11 11 Light logging slash12 12 Medium logging slash13 13 Heavy logging slash101 gr1 Short, sparse, dry

climate grass102 gr2 Low load, dry climate

grass103 gr3 Low load, very

coarse, dry climategrass

104 gr4 Moderate load, dryclimate grass

105 gr5 Low load, humidclimate grass

106 gr6 Moderate load, humidclimate grass

107 gr7 High load, dryclimate grass

108 gr8 High load, verycoarse, humid climategrass

108 gr9 Very high load, humidclimate grass

121 gs1 Low load, dry climategrass-shrub

122 gs2 Moderate load, dryclimate grass-shrub

123 gs3 Moderate load, humidclimate grass-shrub

124 gs4 High load, humidclimate grass-shrub

141 sh1 Low load, dry climateshrub

142 sh2 Moderate load, dryclimate shrub

143 sh3 Moderate load, humidclimate shrub

144 sh4 Low load, humidclimate timber-shrub

145 sh5 High load, dryclimate shrub

146 sh6 Low load, humidclimate shrub

147 sh7 Very high load, dryclimate shrub

148 sh8 High load, humidclimate shrub

149 sh9 Very high load, humidclimate shrub

161 tu1 Low load, dry climatetimber-grass-shrub

162 tu2 Moderate load, humidclimate timber-shrub

163 tu3 Moderate load, humidclimatetimber-grass-shrub

164 tu4 Dwarf conifer withunderstory

165 tu5 Very high load, dryclimate timber-shrub

181 tl1 Low load compactconifer litter

182 tl2 Low load broadleaflitter

183 tl3 Moderate load coniferlitter

184 tl4 Small downed logs185 tl5 High load conifer

litter186 tl6 Moderate load

broadleaf litter187 tl7 Large downed logs188 tl8 Long-needle litter189 tl9 Very high load

broadleaf litter201 sb1 Low activity fuel202 sb2 Moderate load

activity or low loadblowdown

203 sb3 High load activity ormoderate loadblowdown

204 sb4 High load blowndown



← moisture Pointer to a SurfaceFireMoistureInterface-derived instance that pro-vides fuel moisture contents for the fuel model.

Returns:Pointer to the newly created instance of the requested standard fie behavior fuelmodel, or 0 if id is invalid.

Definition at line 224 of file SurfaceFireFuelModelFactory.cpp.

References Sem::SurfaceFireFuel::connectMoisture(), createFuelModel001(),createFuelModel002(), createFuelModel003(), createFuelModel004(), createFuel-Model005(), createFuelModel006(), createFuelModel007(), createFuelModel008(),createFuelModel009(), createFuelModel010(), createFuelModel011(), createFuel-Model012(), createFuelModel013(), createFuelModel101(), createFuelModel102(),createFuelModel103(), createFuelModel104(), createFuelModel105(), createFuel-Model106(), createFuelModel107(), createFuelModel108(), createFuelModel109(),createFuelModel121(), createFuelModel122(), createFuelModel123(), createFuel-Model124(), createFuelModel141(), createFuelModel142(), createFuelModel143(),createFuelModel144(), createFuelModel145(), createFuelModel146(), createFuel-Model147(), createFuelModel148(), createFuelModel149(), createFuelModel161(),createFuelModel162(), createFuelModel163(), createFuelModel164(), createFuel-Model165(), createFuelModel181(), createFuelModel182(), createFuelModel183(),createFuelModel184(), createFuelModel185(), createFuelModel186(), createFuel-Model187(), createFuelModel188(), createFuelModel189(), createFuelModel201(),createFuelModel202(), createFuelModel203(), and createFuelModel204().

8.1.3.2 Sem::SurfaceFireFuelModel ∗ Sem::createFuelModel (int id,SurfaceFireMoistureInterface ∗ moisture = 0)

Creates a SurfaceFireFuelModel for the 13 original standard fire behavior fuel modelsas defined by Albini (1976) and 40 extended fuel models defined by Scott and Burgan(2005).

Parameters:← id One of the standard fire behavior fuel model numbers:



I d Name Description1 1 Short grass (2 ft)2 2 Timber (grass and

understory)3 3 Tall grass (2.5 ft)4 4 Chaparral (6 ft)5 5 Brush (2 ft)6 6 Dormant brush,

hardwood slash7 7 Southern rough8 8 Closed timber litter9 9 Hardwood litter10 10 Timber (litter and

understory)11 11 Light logging slash12 12 Medium logging slash13 13 Heavy logging slash101 gr1 Short, sparse, dry

climate grass102 gr2 Low load, dry climate

grass103 gr3 Low load, very

coarse, dry climategrass

104 gr4 Moderate load, dryclimate grass

105 gr5 Low load, humidclimate grass

106 gr6 Moderate load, humidclimate grass

107 gr7 High load, dryclimate grass

108 gr8 High load, verycoarse, humid climategrass

108 gr9 Very high load, humidclimate grass

121 gs1 Low load, dry climategrass-shrub

122 gs2 Moderate load, dryclimate grass-shrub

123 gs3 Moderate load, humidclimate grass-shrub

124 gs4 High load, humidclimate grass-shrub

141 sh1 Low load, dry climateshrub

142 sh2 Moderate load, dryclimate shrub

143 sh3 Moderate load, humidclimate shrub

144 sh4 Low load, humidclimate timber-shrub

145 sh5 High load, dryclimate shrub

146 sh6 Low load, humidclimate shrub

147 sh7 Very high load, dryclimate shrub

148 sh8 High load, humidclimate shrub

149 sh9 Very high load, humidclimate shrub

161 tu1 Low load, dry climatetimber-grass-shrub

162 tu2 Moderate load, humidclimate timber-shrub

163 tu3 Moderate load, humidclimatetimber-grass-shrub

164 tu4 Dwarf conifer withunderstory

165 tu5 Very high load, dryclimate timber-shrub

181 tl1 Low load compactconifer litter

182 tl2 Low load broadleaflitter

183 tl3 Moderate load coniferlitter

184 tl4 Small downed logs185 tl5 High load conifer

litter186 tl6 Moderate load

broadleaf litter187 tl7 Large downed logs188 tl8 Long-needle litter189 tl9 Very high load

broadleaf litter201 sb1 Low activity fuel202 sb2 Moderate load

activity or low loadblowdown

203 sb3 High load activity ormoderate loadblowdown

204 sb4 High load blowndown



← moisture Pointer to a SurfaceFireMoistureInterface-derived instance that pro-vides fuel moisture contents for the fuel model.

Returns:Pointer to the newly created instance of the requested standard fie behavior fuelmodel, or 0 if id is invalid.


References Sem::SurfaceFireFuel::connectMoisture(), createFuelModel001(),createFuelModel002(), createFuelModel003(), createFuelModel004(), createFuel-Model005(), createFuelModel006(), createFuelModel007(), createFuelModel008(),createFuelModel009(), createFuelModel010(), createFuelModel011(), createFuel-Model012(), createFuelModel013(), createFuelModel101(), createFuelModel102(),createFuelModel103(), createFuelModel104(), createFuelModel105(), createFuel-Model106(), createFuelModel107(), createFuelModel108(), createFuelModel109(),createFuelModel121(), createFuelModel122(), createFuelModel123(), createFuel-Model124(), createFuelModel141(), createFuelModel142(), createFuelModel143(),createFuelModel144(), createFuelModel145(), createFuelModel146(), createFuel-Model147(), createFuelModel148(), createFuelModel149(), createFuelModel161(),createFuelModel162(), createFuelModel163(), createFuelModel164(), createFuel-Model165(), createFuelModel181(), createFuelModel182(), createFuelModel183(),createFuelModel184(), createFuelModel185(), createFuelModel186(), createFuel-Model187(), createFuelModel188(), createFuelModel189(), createFuelModel201(),createFuelModel202(), createFuelModel203(), and createFuelModel204().

Referenced by Sem::CrownFireAlgorithm::crownFireSpreadRate().

8.1.3.3 Sem::SurfaceFireFuelModel ∗ Sem::createFuelModel007 (void)

Creates the original standard fire behavior fuel model 7, southern rough as defined byAlbini (1976).

Note:While Albini specified a live fuel surface area-to-volume ratio of 1550 ft2/ft3, theoriginal BEHAVE (mistakenly?) used 1500. This ’bug’ was purposefully perpet-uated in BehavePlus in the interest of consistency, and we therefore also do sohere.


References Sem::SurfaceFireFuelModel::addParticleNew(), createSurfaceFireFuel-Model(), and Sem::SurfaceFireFuelAlgorithm::CureNone.

Referenced by createFuelModel().



8.1.3.4 Sem::SurfaceFireFuelModel ∗ Sem::createSurfaceFireFuelModel (intid, const QString & name, const QString & desc, double mextDead)

Factory convenience method to create and test the SurfaceFireFuelModel portion of thefuel model.

Parameters:← id Surface fire fuel model id.← name Surface fire fuel model name.← desc Surface fire fuel model description← mextDead Surface fuel dead fuel extinction moisture content.

Returns:Pointer to the newly created SurfaceFireFuelModel.


Referenced by createFuelModel001(), createFuelModel002(), createFuelModel003(),createFuelModel004(), createFuelModel005(), createFuelModel006(), createFuel-Model007(), createFuelModel008(), createFuelModel009(), createFuelModel010(),createFuelModel011(), createFuelModel012(), createFuelModel013(), createFuel-Model101(), createFuelModel102(), createFuelModel103(), createFuelModel104(),createFuelModel105(), createFuelModel106(), createFuelModel107(), createFuel-Model108(), createFuelModel109(), createFuelModel121(), createFuelModel122(),createFuelModel123(), createFuelModel124(), createFuelModel141(), createFuel-Model142(), createFuelModel143(), createFuelModel144(), createFuelModel145(),createFuelModel146(), createFuelModel147(), createFuelModel148(), createFuel-Model149(), createFuelModel161(), createFuelModel162(), createFuelModel163(),createFuelModel164(), createFuelModel165(), createFuelModel181(), createFuel-Model182(), createFuelModel183(), createFuelModel184(), createFuelModel185(),createFuelModel186(), createFuelModel187(), createFuelModel188(), createFuel-Model189(), createFuelModel201(), createFuelModel202(), createFuelModel203(),and createFuelModel204().

8.1.3.5 bool Sem::operator!= (const Sem::TreeMortality & lhs, constSem::TreeMortality & rhs)

Non-member inequality operator between two TreeMortality objects.

Parameters:← lhs Left-hand-side TreeMortality object.← rhs Right-hand-side TreeMortality object.

Definition at line 430 of file TreeMortality.cpp.



8.1.3.6 bool Sem::operator!= (const Sem::SurfaceFireWind & lhs, constSem::SurfaceFireWind & rhs)

Non-member inequality operator between two SurfaceFireWind objects.

Parameters:← lhs Left-hand-side SurfaceFireWind object.← rhs Right-hand-side SurfaceFireWind object.

Definition at line 279 of file SurfaceFireWind.cpp.

8.1.3.7 bool Sem::operator!= (const Sem::SurfaceFireTerrain & lhs, constSem::SurfaceFireTerrain & rhs)

Non-member inequality operator between two SurfaceFireTerrain objects.

Parameters:← lhs Left-hand-side SurfaceFireTerrain object.← rhs Right-hand-side SurfaceFireTerrain object.

Definition at line 331 of file SurfaceFireTerrain.cpp.

8.1.3.8 bool Sem::operator!= (const Sem::SurfaceFireSpread & lhs, constSem::SurfaceFireSpread & rhs)

Non-member inequality operator between two SurfaceFireSpread objects.

Parameters:← lhs Left-hand-side SurfaceFireSpread object.← rhs Right-hand-side SurfaceFireSpread object.

Returns:TRUE if not equal, FALSE if equal.

Definition at line 1302 of file SurfaceFireSpread.cpp.

8.1.3.9 bool Sem::operator!= (const Sem::SurfaceFireParticle & lhs, constSem::SurfaceFireParticle & rhs)

Non-member inequality operator between two SurfaceFireParticle objects.



Parameters:← lhs Left-hand-side SurfaceFireParticle object.← rhs Right-hand-side SurfaceFireParticle object.


Definition at line 833 of file SurfaceFireParticle.cpp.

8.1.3.10 bool Sem::operator!= (const Sem::SurfaceFireMoistureTimeLag &lhs, const Sem::SurfaceFireMoistureTimeLag & rhs)

Non-member inequality operator between two SurfaceFireMoistureTimeLag objects.

Parameters:← lhs Left-hand-side SurfaceFireMoistureTimeLag object.← rhs Right-hand-side SurfaceFireMoistureTimeLag object.

Definition at line 425 of file SurfaceFireMoistureTimeLag.cpp.

8.1.3.11 bool Sem::operator!= (const Sem::SurfaceFireFuelModel & lhs, constSem::SurfaceFireFuelModel & rhs)

Non-member inequality operator between two SurfaceFireFuelModel objects.

Parameters:← lhs Left-hand-side SurfaceFireFuelModel object.← rhs Right-hand-side SurfaceFireFuelModel object.


Definition at line 276 of file SurfaceFireFuelModel.cpp.

8.1.3.12 bool Sem::operator!= (const Sem::SurfaceFireFuel & lhs, constSem::SurfaceFireFuel & rhs)

Non-member inequality operator between two SurfaceFireFuel objects.

Parameters:← lhs Left-hand-side SurfaceFireFuel object.



← rhs Right-hand-side SurfaceFireFuel object.


Definition at line 1406 of file SurfaceFireFuel.cpp.

8.1.3.13 bool Sem::operator!= (const Sem::SpotTorchingTrees & lhs, constSem::SpotTorchingTrees & rhs)

Non-member inequality operator between two SpotTorchingTrees objects.

Parameters:← lhs Left-hand-side SpotTorchingTrees object.← rhs Right-hand-side SpotTorchingTrees object.

Definition at line 640 of file SpotTorchingTrees.cpp.

8.1.3.14 bool Sem::operator!= (const Sem::SpotSurfaceFire & lhs, constSem::SpotSurfaceFire & rhs)

Non-member inequality operator between two SpotSurfaceFire objects.

Parameters:← lhs Left-hand-side SpotSurfaceFire object.← rhs Right-hand-side SpotSurfaceFire object.

Definition at line 458 of file SpotSurfaceFire.cpp.

8.1.3.15 bool Sem::operator!= (const Sem::SpotBurningPile & lhs, constSem::SpotBurningPile & rhs)

Non-member inequality operator between two SpotBurningPile objects.

Parameters:← lhs Left-hand-side SpotBurningPile object.← rhs Right-hand-side SpotBurningPile object.

Definition at line 458 of file SpotBurningPile.cpp.



8.1.3.16 bool Sem::operator!= (const Sem::Signal & lhs, const Sem::Signal