Behave (Algorithms 1.0.7 API)

java.lang.Object
- wf.rothermel.Behave

public class Behave
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`A`
`double`	`al`
`double`	`alDeg`
`double`	`alRad`
`double`	`asp`
`double`	`asp_r`
`double`	`B`
`double`	`beta`
`double`	`beta_opt`
`double`	`beta_ratio`
`double`	`C`
`boolean`	`canDerive`
`double`	`cos_asp`
`double`	`cos_splitRad`
`double`	`cos_wdr`
`double`	`dead`
`double`	`depth`
`double`	`E`
`double`	`ecc`
`double`	`efw`
`double`	`eps_d1`
`double`	`eps_d2`
`double`	`eps_d3`
`double`	`eps_lh`
`double`	`eps_lw`
`double`	`eta_M`
`double`	`eta_Md`
`double`	`eta_Ml`
`double`	`eta_s`
`double`	`fli`
`double`	`fln`
`int`	`fuelModel`
`double`	`fzd`
`double`	`gamma`
`double`	`gamma_max`
`double`	`heat`
`double`	`hn_d1`
`double`	`hn_d2`
`double`	`hn_d3`
`double`	`hn_lh`
`double`	`hn_lw`
`double`	`hpa`
`double`	`hsk`
`double`	`hskz`
`double`	`I_r`
`boolean`	`isCalculated` INSTANCE VARS
`double`	`live`
`double`	`m_d1`
`double`	`m_d2`
`double`	`m_d3`
`double`	`m_lh`
`double`	`m_lw`
`double`	`Mf_dead`
`double`	`mx`
`double`	`Mx_live`
`double`	`phi_s`
`double`	`phi_t`
`double`	`phi_w`
`double`	`q_d1`
`double`	`q_d2`
`double`	`q_d3`
`double`	`q_lh`
`double`	`q_lw`
`double`	`rho_b`
`double`	`rho_p`
`double`	`rm_d`
`double`	`rm_l`
`double`	`ros`
`double`	`s_e`
`double`	`s_t`
`double`	`s2w_d`
`double`	`s2w_l`
`double`	`s2w_t`
`double`	`sdr`
`double`	`sdr_r`
`double`	`sigma`
`double`	`sin_asp`
`double`	`sin_splitRad`
`double`	`sin_wdr`
`double`	`slp`
`double`	`slp_r`
`double`	`splitDeg`
`double`	`splitRad`
`double`	`sumhd`
`double`	`sumhdm`
`double`	`sumhl`
`double`	`sv_d1`
`double`	`sv_d2`
`double`	`sv_d3`
`double`	`sv_lh`
`double`	`sv_lw`
`double`	`sw_d`
`double`	`sw_d1`
`double`	`sw_d2`
`double`	`sw_d3`
`double`	`sw_l`
`double`	`sw_lh`
`double`	`sw_lw`
`double`	`sw_t`
`double`	`sw2_d`
`double`	`sw2_l`
`double`	`sw2_t`
`double`	`swm_d`
`double`	`swm_l`
`double`	`swm_t`
`double`	`tan_slp`
`double`	`tau`
`double`	`vl`
`double`	`vx`
`double`	`vy`
`double`	`W`
`double`	`w_n`
`double`	`w0`
`double`	`w0_d1`
`double`	`w0_d2`
`double`	`w0_d3`
`double`	`w0_lh`
`double`	`w0_lw`
`double`	`wdr`
`double`	`wdr_r`
`double`	`wn_d`
`double`	`wn_d1`
`double`	`wn_d2`
`double`	`wn_d3`
`double`	`wn_l`
`double`	`wn_lh`
`double`	`wn_lw`
`double`	`wsp`
`double`	`xi`

Constructor Summary

Constructors
Constructor and Description

Behave()

Constructors
Constructor and Description
`Behave()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calc()`
`protected void`	`calcFuel()` calcFuel calculates: - characteristic surface-to-volume ration (sigma) - bulk densities (rho_b) - packing ratios (beta, beta_opt, beta_ratio) - net fuel loadings (wn_..) Exceptions are thrown if - w0 <= 0.
`protected void`	`combinedWindAndSlopeFactor()` phi combined wind and slope factor assumptions: wsp > 0.
`static double`	`getRosInDir(double dRos, double dMaxDirection, double dDirection, double dEcc)`
`protected void`	`heatSink()` heat sink term Rothermel (1972): eq.
`protected void`	`moistureDamping()` moistureDamping ********************************************************************* calculate the moisture damping coefficients for dead and live fuel Exceptions thrown if mx <= 0.
`protected void`	`reactionVelocity()` gamma': reaction velocity
`void`	`setAspect(double aspect)`
`void`	`setDeadMoisture1(double moisture)`
`void`	`setDeadMoisture10(double moisture)`
`void`	`setDeadMoisture100(double moisture)`
`boolean`	`setFuelModel(int model)`
`void`	`setHerbMoisture(double moisture)`
`void`	`setSlope(double slope)`
`void`	`setWindDir(double dir)`
`void`	`setWindSpeed(double speed)`
`void`	`setWoodyMoisture(double moisture)`
`protected void`	`slopeFactor()` phi_s: slope factor called from combinedWindAndSlopeFactor()
`protected void`	`windFactor()` phi_w: wind factor called from combinedWindAndSlopeFactor() conversion: sigma [1/ft] = sigma[1/m] * 0.3048! original formulae in Rothermel 1972, eq.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

A
```
public double A
```

al
```
public double al
```

alDeg
```
public double alDeg
```

alRad
```
public double alRad
```

asp
```
public double asp
```

asp_r
```
public double asp_r
```

B
```
public double B
```

beta
```
public double beta
```

beta_opt
```
public double beta_opt
```

beta_ratio
```
public double beta_ratio
```

C
```
public double C
```

canDerive
```
public boolean canDerive
```

cos_asp
```
public double cos_asp
```

cos_splitRad
```
public double cos_splitRad
```

cos_wdr
```
public double cos_wdr
```

dead
```
public double dead
```

depth
```
public double depth
```

E
```
public double E
```

ecc
```
public double ecc
```

efw
```
public double efw
```

eps_d1
```
public double eps_d1
```

eps_d2
```
public double eps_d2
```

eps_d3
```
public double eps_d3
```

eps_lh
```
public double eps_lh
```

eps_lw
```
public double eps_lw
```

eta_M
```
public double eta_M
```

eta_Md
```
public double eta_Md
```

eta_Ml
```
public double eta_Ml
```

eta_s
```
public double eta_s
```

fli
```
public double fli
```

fln
```
public double fln
```

fuelModel
```
public int fuelModel
```

fzd
```
public double fzd
```

gamma
```
public double gamma
```

gamma_max
```
public double gamma_max
```

heat
```
public double heat
```

hn_d1
```
public double hn_d1
```

hn_d2
```
public double hn_d2
```

hn_d3
```
public double hn_d3
```

hn_lh
```
public double hn_lh
```

hn_lw
```
public double hn_lw
```

hpa
```
public double hpa
```

hsk
```
public double hsk
```

hskz
```
public double hskz
```

I_r
```
public double I_r
```

isCalculated
```
public boolean isCalculated
```
INSTANCE VARS

live
```
public double live
```

m_d1
```
public double m_d1
```

m_d2
```
public double m_d2
```

m_d3
```
public double m_d3
```

m_lh
```
public double m_lh
```

m_lw
```
public double m_lw
```

Mf_dead
```
public double Mf_dead
```

mx
```
public double mx
```

Mx_live
```
public double Mx_live
```

phi_s
```
public double phi_s
```

phi_t
```
public double phi_t
```

phi_w
```
public double phi_w
```

q_d1
```
public double q_d1
```

q_d2
```
public double q_d2
```

q_d3
```
public double q_d3
```

q_lh
```
public double q_lh
```

q_lw
```
public double q_lw
```

rho_b
```
public double rho_b
```

rho_p
```
public double rho_p
```

rm_d
```
public double rm_d
```

rm_l
```
public double rm_l
```

ros
```
public double ros
```

s_e
```
public double s_e
```

s_t
```
public double s_t
```

s2w_d
```
public double s2w_d
```

s2w_l
```
public double s2w_l
```

s2w_t
```
public double s2w_t
```

sdr
```
public double sdr
```

sdr_r
```
public double sdr_r
```

sigma
```
public double sigma
```

sin_asp
```
public double sin_asp
```

sin_splitRad
```
public double sin_splitRad
```

sin_wdr
```
public double sin_wdr
```

slp
```
public double slp
```

slp_r
```
public double slp_r
```

splitDeg
```
public double splitDeg
```

splitRad
```
public double splitRad
```

sumhd
```
public double sumhd
```

sumhdm
```
public double sumhdm
```

sumhl
```
public double sumhl
```

sv_d1
```
public double sv_d1
```

sv_d2
```
public double sv_d2
```

sv_d3
```
public double sv_d3
```

sv_lh
```
public double sv_lh
```

sv_lw
```
public double sv_lw
```

sw_d
```
public double sw_d
```

sw_d1
```
public double sw_d1
```

sw_d2
```
public double sw_d2
```

sw_d3
```
public double sw_d3
```

sw_l
```
public double sw_l
```

sw_lh
```
public double sw_lh
```

sw_lw
```
public double sw_lw
```

sw_t
```
public double sw_t
```

sw2_d
```
public double sw2_d
```

sw2_l
```
public double sw2_l
```

sw2_t
```
public double sw2_t
```

swm_d
```
public double swm_d
```

swm_l
```
public double swm_l
```

swm_t
```
public double swm_t
```

tan_slp
```
public double tan_slp
```

tau
```
public double tau
```

vl
```
public double vl
```

vx
```
public double vx
```

vy
```
public double vy
```

W
```
public double W
```

w_n
```
public double w_n
```

w0
```
public double w0
```

w0_d1
```
public double w0_d1
```

w0_d2
```
public double w0_d2
```

w0_d3
```
public double w0_d3
```

w0_lh
```
public double w0_lh
```

w0_lw
```
public double w0_lw
```

wdr
```
public double wdr
```

wdr_r
```
public double wdr_r
```

wn_d
```
public double wn_d
```

wn_d1
```
public double wn_d1
```

wn_d2
```
public double wn_d2
```

wn_d3
```
public double wn_d3
```

wn_l
```
public double wn_l
```

wn_lh
```
public double wn_lh
```

wn_lw
```
public double wn_lw
```

wsp
```
public double wsp
```

xi
```
public double xi
```

Constructor Detail
- Behave
```
public Behave()
```

Method Detail
- calc
```
public void calc()
```
- calcFuel
```
protected void calcFuel()
```
  calcFuel calculates: - characteristic surface-to-volume ration (sigma) - bulk densities (rho_b) - packing ratios (beta, beta_opt, beta_ratio) - net fuel loadings (wn_..) Exceptions are thrown if - w0 <= 0. no fuel specified - sw_t <= 0. surface-to-voume-ratios not properly specified - depth <= 0. depth of fuel bed not properly specified
- combinedWindAndSlopeFactor
```
protected void combinedWindAndSlopeFactor()
```
  phi combined wind and slope factor assumptions: wsp > 0. and/or slp > 0. -> phi_t
- getRosInDir
```
public static double getRosInDir(double dRos,
                 double dMaxDirection,
                 double dDirection,
                 double dEcc)
```
- heatSink
```
protected void heatSink()
```
  heat sink term Rothermel (1972): eq. (77) + (78)
- moistureDamping
```
protected void moistureDamping()
```
  moistureDamping ********************************************************************* calculate the moisture damping coefficients for dead and live fuel Exceptions thrown if mx <= 0.
- reactionVelocity
```
protected void reactionVelocity()
```
  gamma': reaction velocity
- setAspect
```
public void setAspect(double aspect)
```
- setDeadMoisture1
```
public void setDeadMoisture1(double moisture)
```
- setDeadMoisture10
```
public void setDeadMoisture10(double moisture)
```
- setDeadMoisture100
```
public void setDeadMoisture100(double moisture)
```
- setFuelModel
```
public boolean setFuelModel(int model)
```
- setHerbMoisture
```
public void setHerbMoisture(double moisture)
```
- setSlope
```
public void setSlope(double slope)
```
- setWindDir
```
public void setWindDir(double dir)
```
- setWindSpeed
```
public void setWindSpeed(double speed)
```
- setWoodyMoisture
```
public void setWoodyMoisture(double moisture)
```
- slopeFactor
```
protected void slopeFactor()
```
  phi_s: slope factor called from combinedWindAndSlopeFactor()
- windFactor
```
protected void windFactor()
```
  phi_w: wind factor called from combinedWindAndSlopeFactor() conversion: sigma [1/ft] = sigma[1/m] * 0.3048! original formulae in Rothermel 1972, eq. XXXXX B = 0.013298 * Math.pow(sigma,0.54); C = 7.47 * Math.exp(-0.06919 * Math.pow(sigma,0.55)); E = 0.715 * Math.exp(0.0001094 * sigma);

Class Behave

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

A

al

alDeg

alRad

asp

asp_r

B

beta

beta_opt

beta_ratio

C

canDerive

cos_asp

cos_splitRad

cos_wdr

dead

depth

E

ecc

efw

eps_d1

eps_d2

eps_d3

eps_lh

eps_lw

eta_M

eta_Md

eta_Ml

eta_s

fli

fln

fuelModel

fzd

gamma

gamma_max

heat

hn_d1

hn_d2

hn_d3

hn_lh

hn_lw

hpa

hsk

hskz

I_r

isCalculated

live

m_d1

m_d2

m_d3

m_lh

m_lw

Mf_dead

mx

Mx_live

phi_s

phi_t

phi_w

q_d1

q_d2

q_d3

q_lh

q_lw

rho_b

rho_p

rm_d

rm_l

ros

s_e

s_t

s2w_d

s2w_l

s2w_t

sdr