---

PhysFuelModel.h

Go to the documentation of this file.

#ifndef PhysFuelModel_H
#define PhysFuelModel_H

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

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

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

/*fmd file constants */
#ifndef DOXYGEN_SHOULD_SKIP_THIS

#define PHYS_FM_FMD_SEPARATOR_CHARS         (" =,\t")
#define PHYS_FM_FMD_COMMENT_CHAR            ("#")
#define PHYS_FM_FMD_KEYWORD_METRIC          ("METRIC")
#define PHYS_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 PHYS_FM_FMD_D1H_LOAD                (0)
#define PHYS_FM_FMD_D10H_LOAD               (1)
#define PHYS_FM_FMD_D100H_LOAD              (2)
#define PHYS_FM_FMD_LH_LOAD                 (3)
#define PHYS_FM_FMD_LW_LOAD                 (4)
#define PHYS_FM_FMD_1H_SAV                  (5)
#define PHYS_FM_FMD_LH_SAV                  (6)
#define PHYS_FM_FMD_LW_SAV                  (7)
#define PHYS_FM_FMD_FBED_DEPTH              (8)
#define PHYS_FM_FMD_EXT_MOIST               (9)
#define PHYS_FM_FMD_DHC                     (10)
#define PHYS_FM_FMD_LHC                     (11)
#define PHYS_FM_FMD_NUM_VALUES              (12)

#endif /* DOXYGEN_SHOULD_SKIP_THIS */


#define PHYS_FM_STD_FP_DENSITY_ENGLISH      (32.0)

#define PHYS_FM_D10H_STD_SAV_ENGLISH        (109.0)

#define PHYS_FM_D100H_STD_SAV_ENGLISH       (30.0)

enum EnumPhysFuelType_  {
    EnumPhysBurnable        = 0,
    EnumPhysUnBurnable      = 1
    };

/*
 *********************************************************
 * STRUCTS, TYPEDEFS
 *********************************************************
 */

typedef enum EnumPhysFuelType_ EnumPhysFuelType;

typedef struct PhysFuelModel_ PhysFuelModel;

struct PhysFuelModel_   {
    EnumPhysFuelType brntype;
    EnumUnitType units;                 
    float fdepth;
    int num_fp;                         
    float fdens;
    float fsav;
    float pkrat;                        
    float load  [EnumNumSizeClasses];
    float sav   [EnumNumSizeClasses];
    float dens  [EnumNumSizeClasses];   
    float sarea [EnumNumSizeClasses];
    float effhn [EnumNumSizeClasses];
    float awtg  [EnumNumSizeClasses];
    float larea;
    float darea;                        
    float fm    [EnumNumSizeClasses];   
    };
     
/*
 *********************************************************
 * MACROS
 *********************************************************
 */
 
/*
 *********************************************************
 * PUBLIC FUNCTIONS
 *********************************************************
 */

PhysFuelModel * InitPhysFuelModelEmpty();

PhysFuelModel * InitPhysFuelModelFMDFile(FILE * fstream, int model_num);

PhysFuelModel * InitPhysFuelModelUnBurnable();

int PhysFuelModelMetricToEnglish(PhysFuelModel * pfm);

int PhysFuelModelEnglishToMetric(PhysFuelModel * pfm);

void PhysFuelModelDumpToStream(PhysFuelModel * pfm, FILE * fstream);

void FreePhysFuelModel(void * vptr);
  
#endif PhysFuelModel_H      /* end of PhysFuelModel.h */

---