Skip to content

Dev Code doc

Jump to bottom
Emanuele Gissi edited this page Sep 29, 2025 · 7 revisions

ℹ️ Work in progress

This wiki page documents the BFDS properties and operators for scripting purposes.

Introduction

FIXME

BFDS Properties

Here is a list of all the BFDS properties.

Class MP_namelist_cls

Label: Namelist

Desc: Identification of FDS namelist

Value property: Material.bf_namelist_cls = EnumProperty(name='Namelist', {'items': [('MN_SURF', 'SURF', 'Boundary condition', 2000)], 'update': <function update_MP_namelist_cls at 0x154abdd02980>, 'default': 'MN_SURF'})

Class MP_ID

Label: ID

Desc: Material identification name

FDS label: ID

Value property: Material.name

Class MP_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Material.bf_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class MP_RGB

Label: RGB, TRANSPARENCY

Desc: Set color and transparency of the boundary condition

FDS label: RGB

Value property: Material.diffuse_color

Class MP_COLOR

Label: COLOR

Desc: Color

FDS label: COLOR

Value property: Material.diffuse_color

Class MP_TRANSPARENCY

Label: TRANSPARENCY

Desc: Transparency

FDS label: TRANSPARENCY

Default FDS value: 1.0

Value property: Material.diffuse_color

Class MP_DEFAULT

Label: DEFAULT

Desc: Set default SURF

FDS label: DEFAULT

Default FDS value: False

Class OP_is_tmp

Label: Temporary Object

Desc: Set if it is a temporary Object

Value property: Object.bf_is_tmp = BoolProperty(name='Temporary Object', {'default': False})

Class OP_has_tmp

Label: Has Temporary Object

Desc: Set if it has related temporary Object instances

Value property: Object.bf_has_tmp = BoolProperty(name='Has Temporary Object', {'default': False})

Class OP_namelist_cls

Label: Namelist

Desc: Identification of FDS namelist

Value property: Object.bf_namelist_cls = EnumProperty(name='Namelist', {'items': [('ON_DEVC', 'DEVC', 'Device', 1011), ('ON_GEOM', 'GEOM', 'Geometry', 1021), ('ON_HOLE', 'HOLE', 'Obstruction cutout', 1009), ('ON_INIT', 'INIT', 'Initial condition', 1015), ('ON_MESH', 'MESH', 'Domain of simulation', 1014), ('ON_OBST', 'OBST', 'Obstruction', 1000), ('ON_other', 'Other', 'Other namelist', 1007), ('ON_PROF', 'PROF', 'Wall profile output', 1013), ('ON_SLCF', 'SLCF', 'Slice file', 1012), ('ON_VENT', 'VENT', 'Boundary condition patch', 1010), ('ON_ZONE', 'ZONE', 'Pressure zone', 1016)], 'update': <function update_OP_namelist_cls at 0x154abdd014e0>, 'default': 'ON_OBST'})

Class OP_ID

Label: ID

Desc: Object identification name

FDS label: ID

Value property: Object.name

Class OP_ID_suffix

Label: IDs Suffix

Desc: Suffix for IDs in case of multiple geometry (eg. voxels, faces, ...)

Value property: Object.bf_id_suffix = EnumProperty(name='IDs Suffix', {'items': (('IDI', 'Index', 'Append an index', 100), ('IDX', 'x', 'Append the x coordinate', 200), ('IDY', 'y', 'Append the y coordinate', 300), ('IDZ', 'z', 'Append the z coordinate', 400), ('IDXY', 'xy', 'Append the x,y coordinates', 500), ('IDXZ', 'xz', 'Append the x,z coordinates', 600), ('IDYZ', 'yz', 'Append the y,z coordinates', 700), ('IDXYZ', 'xyz', 'Append the x,y,z coordinates', 800))})

Class OP_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Object.bf_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class OP_RGB_override

Label: Override RGB

Desc: Override color and transparency from boundary conditions

FDS label: RGB

Value property: Object.color

Export property: Object.bf_rgb_export = BoolProperty(name='Enable Override RGB')

Export default: False

Class OP_COLOR_override

Label: COLOR

Desc: Color

FDS label: COLOR

Value property: Object.color

Class OP_TRANSPARENCY_override

Label: TRANSPARENCY

Desc: Transparency

FDS label: TRANSPARENCY

Default FDS value: 1.0

Value property: Object.color

Export property: Object.bf_rgb_export

Class SP_config_case_name

Label: Case Filename

Desc: Filename for exported FDS case, also used as HEAD CHID

Value property: Scene.name

Class SP_config_directory

Label: Case Directory

Desc: Default destination directory for the exported FDS case

Value property: Scene.bf_config_directory = StringProperty(name='Case Directory', {'subtype': 'DIR_PATH', 'maxlen': 1024, 'options': {'PATH_SUPPORTS_BLEND_RELATIVE'}})

Class SP_config_text

Label: Free Text

Desc: Internal free text, included verbatim

Value property: Scene.bf_config_text = PointerProperty(name='Free Text', {'type': <class 'bpy_types.Text'>})

Class SP_config_text_position

Label: Free Text Position

Desc: Set Free Text position in the exported file

Value property: Scene.bf_config_text_position = EnumProperty(name='Free Text Position', {'items': (('BEGIN', 'At Beginning', 'Insert at the beginning of the exported file', 100), ('END', 'At End', 'Insert at the end of the exported file', 500)), 'default': 'BEGIN'})

Class SP_config_default_voxel_size

Label: Default Voxel/Pixel Size

Desc: Default voxel/pixel resolution

Value property: Scene.bf_default_voxel_size = FloatProperty(name='Default Voxel/Pixel Size', {'step': 1.0, 'precision': 3, 'min': 0.001, 'max': 20.0, 'unit': 'LENGTH', 'default': 0.1})

Class SP_config_default_SURF

Label: Default SURF

Desc: Specify the particular SURF to be applied as the default boundary condition

Value property: Scene.bf_default_surf = PointerProperty(name='Default SURF', {'type': <class 'bpy.types.Material'>})

Class SP_config_mpi_processes

Label: MPI Processes

Desc: Number of MPI processes automatically allocated to the MESH instances.

Value property: Scene.bf_config_mpi_processes = IntProperty(name='MPI Processes', {'min': 1, 'default': 1})

Export property: Scene.bf_config_mpi_processes_export = BoolProperty(name='Enable MPI Processes')

Export default: True

Class SP_config_openmp_threads

Label: OpenMP Threads

Desc: Number of OpenMP threads assigned to each process.

Value property: Scene.bf_config_openmp_threads = IntProperty(name='OpenMP Threads', {'min': 1, 'default': 1})

Export property: Scene.bf_config_openmp_threads_export = BoolProperty(name='Enable OpenMP Threads')

Export default: False

Class SP_HEAD_CHID

Label: CHID

Desc: Case identificator, also used as case filename

FDS label: CHID

Value property: Scene.name

Class SP_HEAD_TITLE

Label: TITLE

Desc: Case description

FDS label: TITLE

Value property: Scene.bf_head_title = StringProperty(name='TITLE', {'maxlen': 64})

Class SP_TIME_setup_only

Label: Smokeview Geometry Setup

Desc: Set Smokeview to setup only geometry

Value property: Scene.bf_time_setup_only = BoolProperty(name='Smokeview Geometry Setup', {'default': False})

Class SP_TIME_T_BEGIN

Label: T_BEGIN [s]

Desc: Simulation starting time

FDS label: T_BEGIN

Default FDS value: 0.0

Value property: Scene.bf_time_t_begin = FloatProperty(name='T_BEGIN [s]', {'step': 100.0, 'precision': 1, 'default': 0.0})

Class SP_TIME_T_END

Label: T_END [s]

Desc: Simulation ending time

FDS label: T_END

Value property: Scene.bf_time_t_end = FloatProperty(name='T_END [s]', {'step': 100.0, 'precision': 1, 'default': 1.0})

Class SP_MISC_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Scene.bf_misc_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class SP_MISC_OVERWRITE

Label: OVERWRITE

Desc: Do not check for the existence of CHID.out and overwrite files

FDS label: OVERWRITE

Default FDS value: True

Value property: Scene.bf_misc_overwrite = BoolProperty(name='OVERWRITE', {'default': True})

Class SP_MISC_THICKEN_OBSTRUCTIONS

Label: THICKEN_OBSTRUCTIONS

Desc: Do not allow thin sheet obstructions

FDS label: THICKEN_OBSTRUCTIONS

Default FDS value: False

Value property: Scene.bf_misc_thicken_obstructions = BoolProperty(name='THICKEN_OBSTRUCTIONS', {'default': False})

Class SP_origin_geoname_export

Label: Export origin geoposition

Desc: Set if origin geoposition shall be exported to FDS

Value property: Scene.bf_origin_export = BoolProperty(name='Export origin geoposition', {'update': <function update_lonlat at 0x154abdd1cf40>, 'default': False})

Class SP_origin_geoname

Label: Origin Geoname

Desc: Origin location geographic name

Value property: Scene.bf_origin_geoname = StringProperty(name='Origin Geoname', {})

Export property: Scene.bf_origin_export

Class SP_ORIGIN_LON

Label: ORIGIN_LON

Desc: Longitude (WGS84, EPSG:4326) of world origin in decimal degrees

FDS label: ORIGIN_LON

Value property: Scene.bf_origin_lon = FloatProperty(name='ORIGIN_LON', {'min': -180.0, 'max': 180.0, 'precision': 9, 'update': <function update_lonlat at 0x154abdd1cf40>, 'default': 9.16889})

Export property: Scene.bf_origin_export

Class SP_ORIGIN_LAT

Label: ORIGIN_LAT

Desc: Latitude (WGS84, EPSG:4326) of world origin in decimal degrees

FDS label: ORIGIN_LAT

Value property: Scene.bf_origin_lat = FloatProperty(name='ORIGIN_LAT', {'min': -80.0, 'max': 84.0, 'precision': 9, 'update': <function update_lonlat at 0x154abdd1cf40>, 'default': 44.32676})

Export property: Scene.bf_origin_export

Class SP_origin_utm_zn

Label: Origin UTM Zone Number

Desc: UTM Zone Number (WGS84) of world origin

Value property: Scene.bf_origin_utm_zn = IntProperty(name='Origin UTM Zone Number', {'min': 1, 'max': 60, 'default': 32})

Class SP_origin_utm_ne

Label: Origin UTM Northern Emisphere

Desc: UTM northern emisphere (WGS84) of world origin

Value property: Scene.bf_origin_utm_ne = BoolProperty(name='Origin UTM Northern Emisphere', {'default': True})

Class SP_origin_utm_easting

Label: Origin UTM Easting

Desc: UTM easting (WGS84) of world origin

Value property: Scene.bf_origin_utm_easting = FloatProperty(name='Origin UTM Easting', {'unit': 'LENGTH', 'min': 0, 'max': 1000000, 'default': 500000.0})

Class SP_origin_utm_northing

Label: Origin UTM Northing

Desc: UTM northing (WGS84) of world origin

Value property: Scene.bf_origin_utm_northing = FloatProperty(name='Origin UTM Northing', {'unit': 'LENGTH', 'min': 0, 'max': 10000000, 'default': 5000000.0})

Class SP_ORIGIN_NORTH_BEARING

Label: NORTH_BEARING

Desc: Angle between the geographical north and the world Y axis

FDS label: NORTH_BEARING

Default FDS value: 0.0

Value property: Scene.bf_origin_north_bearing = FloatProperty(name='NORTH_BEARING', {'min': -180.0, 'max': 180.0, 'precision': 1, 'default': 0.0})

Export property: Scene.bf_origin_export

Class SP_PRES_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Scene.bf_pres_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class SP_PRES_BAROCLINIC

Label: BAROCLINIC

Desc: Consider baroclinic torque

FDS label: BAROCLINIC

Default FDS value: True

Value property: Scene.bf_pres_baroclinic = BoolProperty(name='BAROCLINIC', {'default': True})

Class SP_PRES_VELOCITY_TOLERANCE

Label: VELOCITY_TOLERANCE

Desc: Maximum allowable normal velocity component on the solid boundary or the largest error at a mesh interface

FDS label: VELOCITY_TOLERANCE

Value property: Scene.bf_pres_velocity_tolerance = FloatProperty(name='VELOCITY_TOLERANCE', {'precision': 6, 'min': 0.0, 'max': 1.0})

Export property: Scene.bf_pres_velocity_tolerance_export = BoolProperty(name='Enable VELOCITY_TOLERANCE')

Export default: False

Class SP_PRES_MAX_PRESSURE_ITERATIONS

Label: MAX_PRESSURE_ITERATIONS

Desc: Maximum number of pressure iterations for each half of the time step

FDS label: MAX_PRESSURE_ITERATIONS

Default FDS value: 10

Value property: Scene.bf_pres_max_pressure_iterations = IntProperty(name='MAX_PRESSURE_ITERATIONS', {'min': 1, 'default': 10})

Export property: Scene.bf_pres_max_pressure_iterations_export = BoolProperty(name='Enable MAX_PRESSURE_ITERATIONS')

Export default: False

Class SP_RADI_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Scene.bf_radi_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class SP_RADI_RADIATION

Label: RADIATION

Desc: Turn on/off the radiation solver

FDS label: RADIATION

Default FDS value: True

Value property: Scene.bf_radi_radiation = BoolProperty(name='RADIATION', {'default': True})

Class SP_RADI_NUMBER_RADIATION_ANGLES

Label: NUMBER_RADIATION_ANGLES

Desc: Number of angles for spatial resolution of radiation solver

FDS label: NUMBER_RADIATION_ANGLES

Default FDS value: 100

Value property: Scene.bf_radi_number_radiation_angles = IntProperty(name='NUMBER_RADIATION_ANGLES', {'min': 1, 'default': 100})

Export property: Scene.bf_radi_number_radiation_angles_export = BoolProperty(name='Enable NUMBER_RADIATION_ANGLES')

Export default: False

Class SP_RADI_TIME_STEP_INCREMENT

Label: TIME_STEP_INCREMENT

Desc: Frequency of calls to the radiation solver in time steps

FDS label: TIME_STEP_INCREMENT

Default FDS value: 3

Value property: Scene.bf_radi_time_step_increment = IntProperty(name='TIME_STEP_INCREMENT', {'min': 1, 'default': 3})

Export property: Scene.bf_radi_time_step_increment_export = BoolProperty(name='Enable TIME_STEP_INCREMENT')

Export default: False

Class SP_RADI_ANGLE_INCREMENT

Label: ANGLE_INCREMENT

Desc: Increment over which the angles are updated

FDS label: ANGLE_INCREMENT

Default FDS value: 5

Value property: Scene.bf_radi_angle_increment = IntProperty(name='ANGLE_INCREMENT', {'min': 1, 'default': 5})

Export property: Scene.bf_radi_angle_increment_export = BoolProperty(name='Enable ANGLE_INCREMENT')

Export default: False

Class SP_RADI_RADIATION_ITERATIONS

Label: RADIATION_ITERATIONS

Desc: Number of times the radiative intensity is updated in a time step

FDS label: RADIATION_ITERATIONS

Default FDS value: 1

Value property: Scene.bf_radi_radiation_iterations = IntProperty(name='RADIATION_ITERATIONS', {'min': 1, 'default': 1})

Export property: Scene.bf_radi_radiation_iterations_export = BoolProperty(name='Enable RADIATION_ITERATIONS')

Export default: False

Class SP_REAC_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Scene.bf_reac_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class SP_REAC_FUEL

Label: FUEL

Desc: Identificator of fuel species

FDS label: FUEL

Value property: Scene.bf_reac_fuel = StringProperty(name='FUEL', {})

Class SP_REAC_FORMULA

Label: FORMULA

Desc: Chemical formula of fuel species, it can only contain C, H, O, or N

FDS label: FORMULA

Value property: Scene.bf_reac_formula = StringProperty(name='FORMULA', {})

Export property: Scene.bf_reac_formula_export = BoolProperty(name='Enable FORMULA')

Export default: False

Class SP_REAC_CO_YIELD

Label: CO_YIELD [kg/kg]

Desc: Fraction of fuel mass converted into carbon monoxide

FDS label: CO_YIELD

Default FDS value: 0.0

Value property: Scene.bf_reac_co_yield = FloatProperty(name='CO_YIELD [kg/kg]', {'step': 1.0, 'precision': 3, 'min': 0.0, 'max': 1.0, 'default': 0.0})

Export property: Scene.bf_reac_co_yield_export = BoolProperty(name='Enable CO_YIELD [kg/kg]')

Export default: False

Class SP_REAC_SOOT_YIELD

Label: SOOT_YIELD [kg/kg]

Desc: Fraction of fuel mass converted into smoke particulate

FDS label: SOOT_YIELD

Default FDS value: 0.0

Value property: Scene.bf_reac_soot_yield = FloatProperty(name='SOOT_YIELD [kg/kg]', {'step': 1.0, 'precision': 3, 'min': 0.0, 'max': 1.0, 'default': 0.0})

Export property: Scene.bf_reac_soot_yield_export = BoolProperty(name='Enable SOOT_YIELD [kg/kg]')

Export default: False

Class SP_REAC_HEAT_OF_COMBUSTION

Label: HEAT_OF_COMBUSTION [kJ/kg]

Desc: Fuel heat of combustion

FDS label: HEAT_OF_COMBUSTION

Default FDS value: 0.0

Value property: Scene.bf_reac_heat_of_combustion = FloatProperty(name='HEAT_OF_COMBUSTION [kJ/kg]', {'precision': 1, 'min': 0.0, 'default': 0.0})

Export property: Scene.bf_reac_heat_of_combustion_export = BoolProperty(name='Enable HEAT_OF_COMBUSTION [kJ/kg]')

Export default: False

Class SP_REAC_IDEAL

Label: IDEAL

Desc: Set ideal heat of combustion

FDS label: IDEAL

Default FDS value: False

Value property: Scene.bf_reac_ideal = BoolProperty(name='IDEAL', {'default': False})

Class SP_REAC_RADIATIVE_FRACTION

Label: RADIATIVE_FRACTION

Desc: Fraction of the total combustion energy that is released in the form of thermal radiation

FDS label: RADIATIVE_FRACTION

Default FDS value: 0.35

Value property: Scene.bf_reac_radiative_fraction = FloatProperty(name='RADIATIVE_FRACTION', {'precision': 2, 'min': 0.0, 'max': 1.0, 'default': 0.35})

Export property: Scene.bf_reac_radiative_fraction_export = BoolProperty(name='Enable RADIATIVE_FRACTION')

Export default: False

Class SP_CATF_files

Label: Concatenated File Paths

Desc: Concatenated file paths

FDS label: OTHER_FILES

Class SP_DUMP_FYI

Label: FYI

Desc: For your information

FDS label: FYI

Value property: Scene.bf_dump_fyi = StringProperty(name='FYI', {'maxlen': 128})

Class SP_DUMP_render_file

Label: Export Geometric Description File

Desc: Export geometric description file GE1

FDS label: RENDER_FILE

Default FDS value: False

Value property: Scene.bf_dump_render_file = BoolProperty(name='Export Geometric Description File', {'default': False})

Class SP_DUMP_STATUS_FILES

Label: STATUS_FILES

Desc: Export status file (*.notready), deleted when the simulation is completed successfully

FDS label: STATUS_FILES

Default FDS value: False

Value property: Scene.bf_dump_status_files = BoolProperty(name='STATUS_FILES', {'default': False})

Class SP_DUMP_NFRAMES

Label: NFRAMES

Desc: Number of output dumps per calculation

FDS label: NFRAMES

Default FDS value: 1000

Value property: Scene.bf_dump_nframes = IntProperty(name='NFRAMES', {'min': 1, 'default': 1000})

Export property: Scene.bf_dump_nframes_export = BoolProperty(name='Enable NFRAMES')

Export default: False

Class SP_DUMP_frames_freq

Label: Dump Output Frequency [s]

Desc: Dump output frequency in seconds

Value property: Scene.bf_dump_frames_freq = FloatProperty(name='Dump Output Frequency [s]', {'min': 0.01, 'precision': 1, 'default': 1.0})

Export property: Scene.bf_dump_frames_freq_export = BoolProperty(name='Enable Dump Output Frequency [s]')

Export default: False

Class SP_DUMP_DT_RESTART

Label: DT_RESTART [s]

Desc: Time interval between restart files are saved

FDS label: DT_RESTART

Default FDS value: 600.0

Value property: Scene.bf_dump_dt_restart = FloatProperty(name='DT_RESTART [s]', {'min': 1.0, 'precision': 1, 'default': 600.0})

Export property: Scene.bf_dump_dt_restart_export = BoolProperty(name='Enable DT_RESTART [s]')

Export default: False

Class OP_MULT_ID

Label: ID

Desc: Multiplier transformation name

FDS label: ID

Class OP_MULT_DX

Label: DX

Desc: Displacement along axis x

FDS label: DX

Default FDS value: 0.0

Value property: Object.bf_mult_dx = FloatProperty(name='DX', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_DY

Label: DY

Desc: Displacement along axis y

FDS label: DY

Default FDS value: 0.0

Value property: Object.bf_mult_dy = FloatProperty(name='DY', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_DZ

Label: DZ

Desc: Displacement along axis z

FDS label: DZ

Default FDS value: 0.0

Value property: Object.bf_mult_dz = FloatProperty(name='DZ', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_DX0

Label: DX0

Desc: Initial displacement along axis x

FDS label: DX0

Default FDS value: 0.0

Value property: Object.bf_mult_dx0 = FloatProperty(name='DX0', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_DY0

Label: DY0

Desc: Initial displacement along axis y

FDS label: DY0

Default FDS value: 0.0

Value property: Object.bf_mult_dy0 = FloatProperty(name='DY0', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_DZ0

Label: DZ0

Desc: Initial displacement along axis z

FDS label: DZ0

Default FDS value: 0.0

Value property: Object.bf_mult_dz0 = FloatProperty(name='DZ0', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0.0})

Class OP_MULT_I_LOWER

Label: I_LOWER

Desc: Lower I index

FDS label: I_LOWER

Default FDS value: 0

Value property: Object.bf_mult_i_lower = IntProperty(name='I_LOWER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_I_LOWER_SKIP

Label: I_LOWER_SKIP

Desc: Lower skip I index

FDS label: I_LOWER_SKIP

Default FDS value: -999

Value property: Object.bf_mult_i_lower_skip = IntProperty(name='I_LOWER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': -999})

Class OP_MULT_I_UPPER_SKIP

Label: I_UPPER_SKIP

Desc: Upper skip I index

FDS label: I_UPPER_SKIP

Default FDS value: 999

Value property: Object.bf_mult_i_upper_skip = IntProperty(name='I_UPPER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 999})

Class OP_MULT_I_UPPER

Label: I_UPPER

Desc: Upper I index

FDS label: I_UPPER

Default FDS value: 0

Value property: Object.bf_mult_i_upper = IntProperty(name='I_UPPER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_J_LOWER

Label: J_LOWER

Desc: Lower J index

FDS label: J_LOWER

Default FDS value: 0

Value property: Object.bf_mult_j_lower = IntProperty(name='J_LOWER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_J_LOWER_SKIP

Label: J_LOWER_SKIP

Desc: Lower skip J index

FDS label: J_LOWER_SKIP

Default FDS value: -999

Value property: Object.bf_mult_j_lower_skip = IntProperty(name='J_LOWER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': -999})

Class OP_MULT_J_UPPER_SKIP

Label: J_UPPER_SKIP

Desc: Upper skip J index

FDS label: J_UPPER_SKIP

Default FDS value: 999

Value property: Object.bf_mult_j_upper_skip = IntProperty(name='J_UPPER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 999})

Class OP_MULT_J_UPPER

Label: J_UPPER

Desc: Upper J index

FDS label: J_UPPER

Default FDS value: 0

Value property: Object.bf_mult_j_upper = IntProperty(name='J_UPPER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_K_LOWER

Label: K_LOWER

Desc: Lower K index

FDS label: K_LOWER

Default FDS value: 0

Value property: Object.bf_mult_k_lower = IntProperty(name='K_LOWER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_K_LOWER_SKIP

Label: K_LOWER_SKIP

Desc: Lower skip K index

FDS label: K_LOWER_SKIP

Default FDS value: -999

Value property: Object.bf_mult_k_lower_skip = IntProperty(name='K_LOWER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': -999})

Class OP_MULT_K_UPPER_SKIP

Label: K_UPPER_SKIP

Desc: Upper skip K index

FDS label: K_UPPER_SKIP

Default FDS value: 999

Value property: Object.bf_mult_k_upper_skip = IntProperty(name='K_UPPER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 999})

Class OP_MULT_K_UPPER

Label: K_UPPER

Desc: Upper K index

FDS label: K_UPPER

Default FDS value: 0

Value property: Object.bf_mult_k_upper = IntProperty(name='K_UPPER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_DXB

Label: DXB

Desc: Displacements along XB

FDS label: DXB

Default FDS value: (0.0, 0.0, 0.0, 0.0, 0.0, 0.0)

Value property: Object.bf_mult_dxb = FloatVectorProperty(name='DXB', {'step': 1.0, 'precision': 3, 'unit': 'LENGTH', 'size': 6, 'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': (0.0, 0.0, 0.0, 0.0, 0.0, 0.0)})

Class OP_MULT_N_LOWER

Label: N_LOWER

Desc: Lower N index

FDS label: N_LOWER

Default FDS value: 0

Value property: Object.bf_mult_n_lower = IntProperty(name='N_LOWER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_MULT_N_LOWER_SKIP

Label: N_LOWER_SKIP

Desc: Lower skip N index

FDS label: N_LOWER_SKIP

Default FDS value: -999

Value property: Object.bf_mult_n_lower_skip = IntProperty(name='N_LOWER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': -999})

Class OP_MULT_N_UPPER_SKIP

Label: N_UPPER_SKIP

Desc: Upper skip N index

FDS label: N_UPPER_SKIP

Default FDS value: 999

Value property: Object.bf_mult_n_upper_skip = IntProperty(name='N_UPPER_SKIP', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 999})

Class OP_MULT_N_UPPER

Label: N_UPPER

Desc: Upper N index

FDS label: N_UPPER

Default FDS value: 0

Value property: Object.bf_mult_n_upper = IntProperty(name='N_UPPER', {'update': <function update_bf_mult at 0x154abdd1eac0>, 'default': 0})

Class OP_other_MULT_ID

Label: MULT_ID

Desc: Reference to multiplier transformation

FDS label: MULT_ID

Class OP_XB_voxel_size

Label: Voxel/Pixel Size

Desc: Voxel/pixel size for the current Object

Value property: Object.bf_xb_voxel_size = FloatProperty(name='Voxel/Pixel Size', {'step': 1.0, 'precision': 3, 'min': 0.001, 'max': 20.0, 'unit': 'LENGTH', 'update': <function update_bf_xb at 0x154abdd1e480>, 'default': 0.1})

Export property: Object.bf_xb_custom_voxel = BoolProperty(name='Enable Voxel/Pixel Size')

Export default: False

Class OP_XB_center_voxels

Label: Center Voxels/Pixels

Desc: Center voxels/pixels to Object bounding box

Value property: Object.bf_xb_center_voxels = BoolProperty(name='Center Voxels/Pixels', {'update': <function update_bf_xb at 0x154abdd1e480>, 'default': False})

Class OP_XB

Label: XB

Desc: Export as volumes/faces/edges

FDS label: XB

Value property: Object.bf_xb = EnumProperty(name='XB', {'update': <function update_bf_xb at 0x154abdd1e480>, 'items': (('BBOX', 'Bounding Box', 'Export object bounding box', 100), ('VOXELS', 'Voxels', 'Export voxels from voxelized solid Object', 200), ('FACES', 'Faces', 'Export faces, one for each face', 300), ('PIXELS', 'Pixels', 'Export pixels from pixelized flat Object', 400), ('EDGES', 'Edges', 'Export segments, one for each edge', 500))})

Export property: Object.bf_xb_export = BoolProperty(name='Enable XB')

Export default: False

Class OP_XB_BBOX

Label: XB

Desc: Export as object bounding box (BBOX)

FDS label: XB

Class OP_XYZ

Label: XYZ

Desc: Export as points

FDS label: XYZ

Value property: Object.bf_xyz = EnumProperty(name='XYZ', {'update': <function update_bf_xyz at 0x154abdd1e3e0>, 'items': (('CENTER', 'Center', 'Point, center point of this object', 100), ('VERTICES', 'Vertices', 'Points, one for each vertex of this object', 200))})

Export property: Object.bf_xyz_export = BoolProperty(name='Enable XYZ')

Export default: False

Class OP_XYZ_center

Label: XYZ

Desc: Export as points (center)

FDS label: XYZ

Value property: Object.bf_xyz

Export property: Object.bf_xyz_export = BoolProperty(name='Enable XYZ')

Export default: False

Class OP_PB

Label: PBX, PBY, PBZ

Desc: Export as planes

Value property: Object.bf_pb = EnumProperty(name='PBX, PBY, PBZ', {'update': <function update_bf_pb at 0x154abdd4d580>, 'items': (('PLANES', 'Planes', 'Planes, one for each face of this object', 100),)})

Export property: Object.bf_pb_export = BoolProperty(name='Enable PBX, PBY, PBZ')

Export default: False

Class OP_PBX

Label: PBX, PBY, PBZ

Desc: Export as planes

FDS label: PBX

Value property: Object.bf_pb

Export property: Object.bf_pb_export = BoolProperty(name='Enable PBX, PBY, PBZ')

Export default: False

Class OP_PBY

Label: PBX, PBY, PBZ

Desc: Export as planes

FDS label: PBY

Value property: Object.bf_pb

Export property: Object.bf_pb_export = BoolProperty(name='Enable PBX, PBY, PBZ')

Export default: False

Class OP_PBZ

Label: PBX, PBY, PBZ

Desc: Export as planes

FDS label: PBZ

Value property: Object.bf_pb

Export property: Object.bf_pb_export = BoolProperty(name='Enable PBX, PBY, PBZ')

Export default: False

Class OP_SURF_ID

Label: SURF_ID

Desc: Reference to SURF

FDS label: SURF_ID

Value property: Object.active_material

Export property: Object.bf_surf_id_export = BoolProperty(name='Enable SURF_ID')

Export default: False

Class OP_DEVC_QUANTITY

Label: QUANTITY

Desc: Output quantity

FDS label: QUANTITY

Value property: Object.bf_quantity = StringProperty(name='QUANTITY', {})

Class OP_DEVC_PROP_ID

Label: PROP_ID

Desc: Reference to a PROP namelist

FDS label: PROP_ID

Value property: Object.bf_devc_prop_id = StringProperty(name='PROP_ID', {})

Class OP_MOVE_ID

Label: ID

Desc: Geometric transformation name

FDS label: ID

Class OP_MOVE_T34

Label: T34

Desc: Geometric transformation 3x4 matrix

FDS label: T34

Class OP_other_MOVE_ID

Label: MOVE_ID

Desc: Reference to geometric transformation

FDS label: MOVE_ID

Class OP_GEOM_SURF_ID

Label: SURF_ID

Desc:

FDS label: SURF_ID

Class OP_GEOM_SURF_IDS

Label: SURF_IDS

Desc:

FDS label: SURF_IDS

Class OP_GEOM_SURF_ID6

Label: SURF_ID6

Desc:

FDS label: SURF_ID6

Class OP_GEOM_BINARY_FILE

Label: BINARY_FILE

Desc: Name of the binary bingeom file

FDS label: BINARY_FILE

Value property: Object.data

Class OP_GEOM_binary_directory

Label: Directory

Desc: Destination directory for the binary bingeom file

Value property: Mesh.bf_geom_binary_directory = StringProperty(name='Directory', {'subtype': 'DIR_PATH', 'maxlen': 1024, 'options': {'PATH_SUPPORTS_BLEND_RELATIVE'}, 'default': ''})

Class OP_GEOM_MOVE_ID

Label: MOVE_ID

Desc: Reference to geometric transformation

FDS label: MOVE_ID

Class OP_GEOM_check_sanity

Label: Check Sanity While Exporting

Desc: Check if closed orientable manifold, with no degenerate geometry while exporting

Value property: Mesh.bf_geom_check_sanity = BoolProperty(name='Check Sanity While Exporting', {'default': True})

Class OP_GEOM_protect

Label: Protect Original Geometry

Desc: Protect original Object geometry while checking its sanity (eg. do not triangulate)

Value property: Mesh.bf_geom_protect = BoolProperty(name='Protect Original Geometry', {'default': True})

Class OP_GEOM_IS_TERRAIN

Label: IS_TERRAIN

Desc: Set if it represents a terrain

FDS label: IS_TERRAIN

Default FDS value: False

Value property: Mesh.bf_geom_is_terrain = BoolProperty(name='IS_TERRAIN', {'default': False})

Class OP_GEOM_EXTEND_TERRAIN

Label: EXTEND_TERRAIN

Desc: Set if this terrain needs extension to fully cover the domain

FDS label: EXTEND_TERRAIN

Default FDS value: False

Value property: Mesh.bf_geom_extend_terrain = BoolProperty(name='EXTEND_TERRAIN', {'default': False})

Class OP_MESH_IJK

Label: IJK

Desc: Cell numbers along axis

FDS label: IJK

Value property: Object.bf_mesh_ijk = IntVectorProperty(name='IJK', {'size': 3, 'min': 1, 'default': (10, 10, 10)})

Class OP_MESH_nsplits

Label: Split IJK

Desc: Evenly split IJK along each axis generating an array of MESH namelists, conserving the cell size

Value property: Object.bf_mesh_nsplits = IntVectorProperty(name='Split IJK', {'size': 3, 'min': 1, 'update': <function update_bf_mesh_nsplits at 0x154abc991760>, 'default': (1, 1, 1)})

Export property: Object.bf_mesh_nsplits_export = BoolProperty(name='Enable Split IJK')

Export default: False

Class OP_MESH_XB_BBOX

Label: XB

Desc: Export as object bounding box (BBOX)

FDS label: XB

Class OP_MESH_MPI_PROCESS

Label: MPI_PROCESS

Desc: MPI process number

FDS label: MPI_PROCESS

Class OP_other_namelist

Label: Label

Desc: Other namelist label, eg

Value property: Object.bf_other_namelist = StringProperty(name='Label', {'maxlen': 4, 'default': 'ABCD'})

Class OP_SLCF_VECTOR

Label: VECTOR

Desc: Create animated vectors

FDS label: VECTOR

Default FDS value: False

Value property: Object.bf_slcf_vector = BoolProperty(name='VECTOR', {'default': False})

Class OP_SLCF_CELL_CENTERED

Label: CELL_CENTERED

Desc: Output the actual cell-centered data with no averaging

FDS label: CELL_CENTERED

Default FDS value: False

Value property: Object.bf_slcf_cell_centered = BoolProperty(name='CELL_CENTERED', {'default': False})

Class OP_VENT_OBST_ID

Label: OBST_ID

Desc: Specify OBST on which projecting the condition

FDS label: OBST_ID

Value property: Object.bf_vent_obst_id = PointerProperty(name='OBST_ID', {'type': <class 'bpy_types.Object'>})

Class BFNamelistSc

Label: No Label

Desc:

Class BFNamelistOb

Label: No Label

Desc:

Export property: Object.hide_render

Class BFNamelistMa

Label: No Label

Desc:

Class SN_MOVE

Label: MOVE

Desc: Geometric transformations

FDS label: MOVE

Class SN_config

Label: FDS Case Config

Desc:

Linked parameters:

Class SN_HEAD

Label: HEAD

Desc: Case header

FDS label: HEAD

Export property: Scene.bf_head_export = BoolProperty(name='Enable HEAD')

Export default: True

Linked parameters:

Class SN_TAIL

Label: TAIL

Desc: Case closing

FDS label: TAIL

Class SN_TIME

Label: TIME

Desc: Simulation time settings

FDS label: TIME

Export property: Scene.bf_time_export = BoolProperty(name='Enable TIME')

Export default: True

Linked parameters:

Class SN_MISC

Label: MISC

Desc: Miscellaneous parameters

FDS label: MISC

Export property: Scene.bf_misc_export = BoolProperty(name='Enable MISC')

Export default: False

Linked parameters:

Class SN_PRES

Label: PRES

Desc: Pressure Solver

FDS label: PRES

Export property: Scene.bf_pres_export = BoolProperty(name='Enable PRES')

Export default: False

Linked parameters:

Class SN_RADI

Label: RADI

Desc: Radiation parameters

FDS label: RADI

Export property: Scene.bf_radi_export = BoolProperty(name='Enable RADI')

Export default: False

Linked parameters:

Class SN_REAC

Label: REAC

Desc: Reaction

FDS label: REAC

Export property: Scene.bf_reac_export = BoolProperty(name='Enable REAC')

Export default: False

Linked parameters:

Class SN_CATF

Label: CATF

Desc: Concatenated file paths

FDS label: CATF

Linked parameters:

Class SN_DUMP

Label: DUMP

Desc: Output parameters

FDS label: DUMP

Export property: Scene.bf_dump_export = BoolProperty(name='Enable DUMP')

Export default: False

Linked parameters:

Class SN_MULT

Label: MULT

Desc: Multiplier transformations

FDS label: MULT

Class MN_SURF

Label: SURF

Desc: Boundary condition

FDS label: SURF

Export property: Material.bf_surf_export = BoolProperty(name='Enable SURF')

Export default: True

Linked parameters:

Class ON_MULT

Label: MULT

Desc: Multiplier

FDS label: MULT

Export property: Object.bf_mult_export = BoolProperty(name='Enable MULT')

Export default: False

Linked parameters:

Class ON_DEVC

Label: DEVC

Desc: Device

FDS label: DEVC

Export property: Object.hide_render

Linked parameters:

Class ON_MOVE

Label: MOVE

Desc: Geometric Transformation

FDS label: MOVE

Linked parameters:

Class ON_GEOM

Label: GEOM

Desc: Geometry

FDS label: GEOM

Export property: Object.hide_render

Linked parameters:

Class ON_HOLE

Label: HOLE

Desc: Obstruction cutout

FDS label: HOLE

Export property: Object.hide_render

Linked parameters:

Class ON_INIT

Label: INIT

Desc: Initial condition

FDS label: INIT

Export property: Object.hide_render

Linked parameters:

Class ON_MESH

Label: MESH

Desc: Domain of simulation

FDS label: MESH

Export property: Object.hide_render

Linked parameters:

Class ON_OBST

Label: OBST

Desc: Obstruction

FDS label: OBST

Export property: Object.hide_render

Linked parameters:

Class ON_other

Label: Other

Desc: Other namelist

FDS label: <property object at 0x154abc9773d0>

Export property: Object.hide_render

Linked parameters:

Class ON_PROF

Label: PROF

Desc: Wall profile output

FDS label: PROF

Export property: Object.hide_render

Linked parameters:

Class ON_SLCF

Label: SLCF

Desc: Slice file

FDS label: SLCF

Export property: Object.hide_render

Linked parameters:

Class ON_VENT

Label: VENT

Desc: Boundary condition patch

FDS label: VENT

Export property: Object.hide_render

Linked parameters:

Class ON_ZONE

Label: ZONE

Desc: Pressure zone

FDS label: ZONE

Export property: Object.hide_render

Linked parameters:

BFDS Wiki Home

Contents

Start

Learn

Teach

Develop

Clone this wiki locally