---

RothFuelModel.h

Go to the documentation of this file.

#ifndef RothFuelModel_H
#define RothFuelModel_H

#include <stdlib.h>
#include <stdio.h>
#include <math.h>

#include "Units.h"
#include "FStreamIO.h"
#include "Err.h"
#include "FuelSizeClasses.h"
#include "RothPipeline.h"

/*
 *********************************************************
 * DEFINES, ENUMS
 *********************************************************
 */

/* fmd file constants */
#ifndef DOXYGEN_SHOULD_SKIP_THIS

#define ROTH_FM_FMD_SEPARATOR_CHARS         (" =,\t")
#define ROTH_FM_FMD_COMMENT_CHAR            ("#")
#define ROTH_FM_FMD_KEYWORD_METRIC          ("METRIC")
#define ROTH_FM_FMD_KEYWORD_ENGLISH         ("ENGLISH")

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

/* sequence of FMD file variables expected to be:                               */
/* 1H  10H  100H  LiveH LiveW  1HSAV LiveHSAV LiveWSAV Depth  XtMoist  DHt  LHt */
#ifndef DOXYGEN_SHOULD_SKIP_THIS

#define ROTH_FM_FMD_D1H_LOAD                (0)
#define ROTH_FM_FMD_D10H_LOAD               (1)
#define ROTH_FM_FMD_D100H_LOAD              (2)
#define ROTH_FM_FMD_LH_LOAD                 (3)
#define ROTH_FM_FMD_LW_LOAD                 (4)
#define ROTH_FM_FMD_1H_SAV                  (5)
#define ROTH_FM_FMD_LH_SAV                  (6)
#define ROTH_FM_FMD_LW_SAV                  (7)
#define ROTH_FM_FMD_FBED_DEPTH              (8)
#define ROTH_FM_FMD_EXT_MOIST               (9)
#define ROTH_FM_FMD_DHC                     (10)
#define ROTH_FM_FMD_LHC                     (11)
#define ROTH_FM_FMD_NUM_VALUES              (12)

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
#define ROTH_FM_STD_TOTAL_SILICA_UNITLESS   (0.0555)

#define ROTH_FM_STD_EFF_SILICA_UNITLESS     (0.0100)

#define ROTH_FM_STD_FP_DENSITY_ENGLISH      (32.0)

#define ROTH_FM_D10H_STD_SAV_ENGLISH        (109.0)

#define ROTH_FM_D100H_STD_SAV_ENGLISH       (30.0)

#define ROTH_FM_ZERO_ROS_ADJ_FACTOR         (0.0)

enum EnumRothFuelType_  {
    EnumRothBurnable        = 0,
    EnumRothUnBurnable      = 1
    };
 
/*
 *********************************************************
 * STRUCTS, TYPEDEFS
 *********************************************************
 */

typedef enum EnumRothFuelType_ EnumRothFuelType;

typedef struct RothFuelModel_ RothFuelModel;
    
struct RothFuelModel_   {
    EnumRothFuelType brntype;               
    EnumUnitType units;                     
    float fdepth;                           
    float mex;                              
    float ros_adj;                          
    int   num_fp;                           
    float fdens;                            
    float fsav;                 
    float pkrat;                            
    float load  [EnumNumSizeClasses];       
    float sav   [EnumNumSizeClasses];       
    float dens  [EnumNumSizeClasses];       
    float hc    [EnumNumSizeClasses];       
    float stot  [EnumNumSizeClasses];       
    float seff  [EnumNumSizeClasses];       
    float sarea [EnumNumSizeClasses];       
    float effhn [EnumNumSizeClasses];
    float awtg  [EnumNumSizeClasses];
    float larea;                            
    float darea;
    float fm    [EnumNumSizeClasses];       
    RothPipeline * rp;                      
    };
     
/*
 *********************************************************
 * MACROS
 *********************************************************
 */
 
/*
 *********************************************************
 * PUBLIC FUNCTIONS
 *********************************************************
 */

RothFuelModel * InitRothFuelModelEmpty();

RothFuelModel * InitRothFuelModelFMDFile(FILE * fstream, int model_num);

RothFuelModel * InitRothFuelModelUnBurnable();

int RothFuelModelMetricToEnglish(RothFuelModel * rfm);

int RothFuelModelEnglishToMetric(RothFuelModel * rfm);

void RothFuelModelDumpToStream(RothFuelModel * rfm, FILE * fstream);

void FreeRothFuelModel(void * vptr);
  
#endif RothFuelModel_H      /* end of RothFuelModel.h */

---