Skip to content

Dev Doc

Emanuele Gissi edited this page Sep 29, 2025 · 2 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

Description: Identification of FDS namelist

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

Class MP_ID

Label: ID

Description: Material identification name

From/To FDS as: ID

Value in: Material.name

Class MP_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class MP_RGB

Label: RGB, TRANSPARENCY

Description: Set color and transparency of the boundary condition

From/To FDS as: RGB

Value in: Material.diffuse_color

Class MP_COLOR

Label: COLOR

Description: Color

From/To FDS as: COLOR

Value in: Material.diffuse_color

Class MP_TRANSPARENCY

Label: TRANSPARENCY

Description: Transparency

From/To FDS as: TRANSPARENCY

Default FDS value: 1.0

Value in: Material.diffuse_color

Class MP_DEFAULT

Label: DEFAULT

Description: Set default SURF

From/To FDS as: DEFAULT

Default FDS value: False

Class OP_is_tmp

Label: Temporary Object

Description: Set if it is a temporary Object

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

Class OP_has_tmp

Label: Has Temporary Object

Description: Set if it has related temporary Object instances

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

Class OP_namelist_cls

Label: Namelist

Description: Identification of FDS namelist

Value in: 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 0x1516a2af94e0>, 'default': 'ON_OBST'})

Class OP_ID

Label: ID

Description: Object identification name

From/To FDS as: ID

Value in: Object.name

Class OP_ID_suffix

Label: IDs Suffix

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

Value in: 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

Description: For your information

From/To FDS as: FYI

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

Class OP_RGB_override

Label: Override RGB

Description: Override color and transparency from boundary conditions

From/To FDS as: RGB

Value in: Object.color

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

Export default: False

Class OP_COLOR_override

Label: COLOR

Description: Color

From/To FDS as: COLOR

Value in: Object.color

Class OP_TRANSPARENCY_override

Label: TRANSPARENCY

Description: Transparency

From/To FDS as: TRANSPARENCY

Default FDS value: 1.0

Value in: Object.color

Export status in: Object.bf_rgb_export

Class SP_config_case_name

Label: Case Filename

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

Value in: Scene.name

Class SP_config_directory

Label: Case Directory

Description: Default destination directory for the exported FDS case

Value in: 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

Description: Internal free text, included verbatim

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

Class SP_config_text_position

Label: Free Text Position

Description: Set Free Text position in the exported file

Value in: 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

Description: Default voxel/pixel resolution

Value in: 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

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

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

Class SP_config_mpi_processes

Label: MPI Processes

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

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

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

Export default: True

Class SP_config_openmp_threads

Label: OpenMP Threads

Description: Number of OpenMP threads assigned to each process.

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

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

Export default: False

Class SP_HEAD_CHID

Label: CHID

Description: Case identificator, also used as case filename

From/To FDS as: CHID

Value in: Scene.name

Class SP_HEAD_TITLE

Label: TITLE

Description: Case description

From/To FDS as: TITLE

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

Class SP_TIME_setup_only

Label: Smokeview Geometry Setup

Description: Set Smokeview to setup only geometry

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

Class SP_TIME_T_BEGIN

Label: T_BEGIN [s]

Description: Simulation starting time

From/To FDS as: T_BEGIN

Default FDS value: 0.0

Value in: 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]

Description: Simulation ending time

From/To FDS as: T_END

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

Class SP_MISC_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class SP_MISC_OVERWRITE

Label: OVERWRITE

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

From/To FDS as: OVERWRITE

Default FDS value: True

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

Class SP_MISC_THICKEN_OBSTRUCTIONS

Label: THICKEN_OBSTRUCTIONS

Description: Do not allow thin sheet obstructions

From/To FDS as: THICKEN_OBSTRUCTIONS

Default FDS value: False

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

Class SP_origin_geoname_export

Label: Export origin geoposition

Description: Set if origin geoposition shall be exported to FDS

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

Class SP_origin_geoname

Label: Origin Geoname

Description: Origin location geographic name

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

Export status in: Scene.bf_origin_export

Class SP_ORIGIN_LON

Label: ORIGIN_LON

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

From/To FDS as: ORIGIN_LON

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

Export status in: Scene.bf_origin_export

Class SP_ORIGIN_LAT

Label: ORIGIN_LAT

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

From/To FDS as: ORIGIN_LAT

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

Export status in: Scene.bf_origin_export

Class SP_origin_utm_zn

Label: Origin UTM Zone Number

Description: UTM Zone Number (WGS84) of world origin

Value in: 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

Description: UTM northern emisphere (WGS84) of world origin

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

Class SP_origin_utm_easting

Label: Origin UTM Easting

Description: UTM easting (WGS84) of world origin

Value in: 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

Description: UTM northing (WGS84) of world origin

Value in: 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

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

From/To FDS as: NORTH_BEARING

Default FDS value: 0.0

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

Export status in: Scene.bf_origin_export

Class SP_PRES_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class SP_PRES_BAROCLINIC

Label: BAROCLINIC

Description: Consider baroclinic torque

From/To FDS as: BAROCLINIC

Default FDS value: True

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

Class SP_PRES_VELOCITY_TOLERANCE

Label: VELOCITY_TOLERANCE

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

From/To FDS as: VELOCITY_TOLERANCE

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

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

Export default: False

Class SP_PRES_MAX_PRESSURE_ITERATIONS

Label: MAX_PRESSURE_ITERATIONS

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

From/To FDS as: MAX_PRESSURE_ITERATIONS

Default FDS value: 10

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

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

Export default: False

Class SP_RADI_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class SP_RADI_RADIATION

Label: RADIATION

Description: Turn on/off the radiation solver

From/To FDS as: RADIATION

Default FDS value: True

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

Class SP_RADI_NUMBER_RADIATION_ANGLES

Label: NUMBER_RADIATION_ANGLES

Description: Number of angles for spatial resolution of radiation solver

From/To FDS as: NUMBER_RADIATION_ANGLES

Default FDS value: 100

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

Export status in: 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

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

From/To FDS as: TIME_STEP_INCREMENT

Default FDS value: 3

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

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

Export default: False

Class SP_RADI_ANGLE_INCREMENT

Label: ANGLE_INCREMENT

Description: Increment over which the angles are updated

From/To FDS as: ANGLE_INCREMENT

Default FDS value: 5

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

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

Export default: False

Class SP_RADI_RADIATION_ITERATIONS

Label: RADIATION_ITERATIONS

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

From/To FDS as: RADIATION_ITERATIONS

Default FDS value: 1

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

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

Export default: False

Class SP_REAC_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class SP_REAC_FUEL

Label: FUEL

Description: Identificator of fuel species

From/To FDS as: FUEL

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

Class SP_REAC_FORMULA

Label: FORMULA

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

From/To FDS as: FORMULA

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

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

Export default: False

Class SP_REAC_CO_YIELD

Label: CO_YIELD [kg/kg]

Description: Fraction of fuel mass converted into carbon monoxide

From/To FDS as: CO_YIELD

Default FDS value: 0.0

Value in: 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 status in: 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]

Description: Fraction of fuel mass converted into smoke particulate

From/To FDS as: SOOT_YIELD

Default FDS value: 0.0

Value in: 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 status in: 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]

Description: Fuel heat of combustion

From/To FDS as: HEAT_OF_COMBUSTION

Default FDS value: 0.0

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

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

Export default: False

Class SP_REAC_IDEAL

Label: IDEAL

Description: Set ideal heat of combustion

From/To FDS as: IDEAL

Default FDS value: False

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

Class SP_REAC_RADIATIVE_FRACTION

Label: RADIATIVE_FRACTION

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

From/To FDS as: RADIATIVE_FRACTION

Default FDS value: 0.35

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

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

Export default: False

Class SP_CATF_files

Label: Concatenated File Paths

Description: Concatenated file paths

From/To FDS as: OTHER_FILES

Class SP_DUMP_FYI

Label: FYI

Description: For your information

From/To FDS as: FYI

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

Class SP_DUMP_render_file

Label: Export Geometric Description File

Description: Export geometric description file GE1

From/To FDS as: RENDER_FILE

Default FDS value: False

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

Class SP_DUMP_STATUS_FILES

Label: STATUS_FILES

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

From/To FDS as: STATUS_FILES

Default FDS value: False

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

Class SP_DUMP_NFRAMES

Label: NFRAMES

Description: Number of output dumps per calculation

From/To FDS as: NFRAMES

Default FDS value: 1000

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

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

Export default: False

Class SP_DUMP_frames_freq

Label: Dump Output Frequency [s]

Description: Dump output frequency in seconds

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

Export status in: 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]

Description: Time interval between restart files are saved

From/To FDS as: DT_RESTART

Default FDS value: 600.0

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

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

Export default: False

Class OP_MULT_ID

Label: ID

Description: Multiplier transformation name

From/To FDS as: ID

Class OP_MULT_DX

Label: DX

Description: Displacement along axis x

From/To FDS as: DX

Default FDS value: 0.0

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

Class OP_MULT_DY

Label: DY

Description: Displacement along axis y

From/To FDS as: DY

Default FDS value: 0.0

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

Class OP_MULT_DZ

Label: DZ

Description: Displacement along axis z

From/To FDS as: DZ

Default FDS value: 0.0

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

Class OP_MULT_DX0

Label: DX0

Description: Initial displacement along axis x

From/To FDS as: DX0

Default FDS value: 0.0

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

Class OP_MULT_DY0

Label: DY0

Description: Initial displacement along axis y

From/To FDS as: DY0

Default FDS value: 0.0

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

Class OP_MULT_DZ0

Label: DZ0

Description: Initial displacement along axis z

From/To FDS as: DZ0

Default FDS value: 0.0

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

Class OP_MULT_I_LOWER

Label: I_LOWER

Description: Lower I index

From/To FDS as: I_LOWER

Default FDS value: 0

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

Class OP_MULT_I_LOWER_SKIP

Label: I_LOWER_SKIP

Description: Lower skip I index

From/To FDS as: I_LOWER_SKIP

Default FDS value: -999

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

Class OP_MULT_I_UPPER_SKIP

Label: I_UPPER_SKIP

Description: Upper skip I index

From/To FDS as: I_UPPER_SKIP

Default FDS value: 999

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

Class OP_MULT_I_UPPER

Label: I_UPPER

Description: Upper I index

From/To FDS as: I_UPPER

Default FDS value: 0

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

Class OP_MULT_J_LOWER

Label: J_LOWER

Description: Lower J index

From/To FDS as: J_LOWER

Default FDS value: 0

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

Class OP_MULT_J_LOWER_SKIP

Label: J_LOWER_SKIP

Description: Lower skip J index

From/To FDS as: J_LOWER_SKIP

Default FDS value: -999

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

Class OP_MULT_J_UPPER_SKIP

Label: J_UPPER_SKIP

Description: Upper skip J index

From/To FDS as: J_UPPER_SKIP

Default FDS value: 999

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

Class OP_MULT_J_UPPER

Label: J_UPPER

Description: Upper J index

From/To FDS as: J_UPPER

Default FDS value: 0

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

Class OP_MULT_K_LOWER

Label: K_LOWER

Description: Lower K index

From/To FDS as: K_LOWER

Default FDS value: 0

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

Class OP_MULT_K_LOWER_SKIP

Label: K_LOWER_SKIP

Description: Lower skip K index

From/To FDS as: K_LOWER_SKIP

Default FDS value: -999

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

Class OP_MULT_K_UPPER_SKIP

Label: K_UPPER_SKIP

Description: Upper skip K index

From/To FDS as: K_UPPER_SKIP

Default FDS value: 999

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

Class OP_MULT_K_UPPER

Label: K_UPPER

Description: Upper K index

From/To FDS as: K_UPPER

Default FDS value: 0

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

Class OP_MULT_DXB

Label: DXB

Description: Displacements along XB

From/To FDS as: DXB

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

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

Class OP_MULT_N_LOWER

Label: N_LOWER

Description: Lower N index

From/To FDS as: N_LOWER

Default FDS value: 0

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

Class OP_MULT_N_LOWER_SKIP

Label: N_LOWER_SKIP

Description: Lower skip N index

From/To FDS as: N_LOWER_SKIP

Default FDS value: -999

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

Class OP_MULT_N_UPPER_SKIP

Label: N_UPPER_SKIP

Description: Upper skip N index

From/To FDS as: N_UPPER_SKIP

Default FDS value: 999

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

Class OP_MULT_N_UPPER

Label: N_UPPER

Description: Upper N index

From/To FDS as: N_UPPER

Default FDS value: 0

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

Class OP_other_MULT_ID

Label: MULT_ID

Description: Reference to multiplier transformation

From/To FDS as: MULT_ID

Class OP_XB_voxel_size

Label: Voxel/Pixel Size

Description: Voxel/pixel size for the current Object

Value in: 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 0x1516a2916480>, 'default': 0.1})

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

Export default: False

Class OP_XB_center_voxels

Label: Center Voxels/Pixels

Description: Center voxels/pixels to Object bounding box

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

Class OP_XB

Label: XB

Description: Export as volumes/faces/edges

From/To FDS as: XB

Value in: Object.bf_xb = EnumProperty(name='XB', {'update': <function update_bf_xb at 0x1516a2916480>, '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 status in: Object.bf_xb_export = BoolProperty(name='Enable XB')

Export default: False

Class OP_XB_BBOX

Label: XB

Description: Export as object bounding box (BBOX)

From/To FDS as: XB

Class OP_XYZ

Label: XYZ

Description: Export as points

From/To FDS as: XYZ

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

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

Export default: False

Class OP_XYZ_center

Label: XYZ

Description: Export as points (center)

From/To FDS as: XYZ

Value in: Object.bf_xyz

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

Export default: False

Class OP_PB

Label: PBX, PBY, PBZ

Description: Export as planes

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

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

Export default: False

Class OP_PBX

Label: PBX, PBY, PBZ

Description: Export as planes

From/To FDS as: PBX

Value in: Object.bf_pb

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

Export default: False

Class OP_PBY

Label: PBX, PBY, PBZ

Description: Export as planes

From/To FDS as: PBY

Value in: Object.bf_pb

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

Export default: False

Class OP_PBZ

Label: PBX, PBY, PBZ

Description: Export as planes

From/To FDS as: PBZ

Value in: Object.bf_pb

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

Export default: False

Class OP_SURF_ID

Label: SURF_ID

Description: Reference to SURF

From/To FDS as: SURF_ID

Value in: Object.active_material

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

Export default: False

Class OP_DEVC_QUANTITY

Label: QUANTITY

Description: Output quantity

From/To FDS as: QUANTITY

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

Class OP_DEVC_PROP_ID

Label: PROP_ID

Description: Reference to a PROP namelist

From/To FDS as: PROP_ID

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

Class OP_MOVE_ID

Label: ID

Description: Geometric transformation name

From/To FDS as: ID

Class OP_MOVE_T34

Label: T34

Description: Geometric transformation 3x4 matrix

From/To FDS as: T34

Class OP_other_MOVE_ID

Label: MOVE_ID

Description: Reference to geometric transformation

From/To FDS as: MOVE_ID

Class OP_GEOM_SURF_ID

Label: SURF_ID

Description:

From/To FDS as: SURF_ID

Class OP_GEOM_SURF_IDS

Label: SURF_IDS

Description:

From/To FDS as: SURF_IDS

Class OP_GEOM_SURF_ID6

Label: SURF_ID6

Description:

From/To FDS as: SURF_ID6

Class OP_GEOM_BINARY_FILE

Label: BINARY_FILE

Description: Name of the binary bingeom file

From/To FDS as: BINARY_FILE

Value in: Object.data

Class OP_GEOM_binary_directory

Label: Directory

Description: Destination directory for the binary bingeom file

Value in: 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

Description: Reference to geometric transformation

From/To FDS as: MOVE_ID

Class OP_GEOM_check_sanity

Label: Check Sanity While Exporting

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

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

Class OP_GEOM_protect

Label: Protect Original Geometry

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

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

Class OP_GEOM_IS_TERRAIN

Label: IS_TERRAIN

Description: Set if it represents a terrain

From/To FDS as: IS_TERRAIN

Default FDS value: False

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

Class OP_GEOM_EXTEND_TERRAIN

Label: EXTEND_TERRAIN

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

From/To FDS as: EXTEND_TERRAIN

Default FDS value: False

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

Class OP_MESH_IJK

Label: IJK

Description: Cell numbers along axis

From/To FDS as: IJK

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

Class OP_MESH_nsplits

Label: Split IJK

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

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

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

Export default: False

Class OP_MESH_XB_BBOX

Label: XB

Description: Export as object bounding box (BBOX)

From/To FDS as: XB

Class OP_MESH_MPI_PROCESS

Label: MPI_PROCESS

Description: MPI process number

From/To FDS as: MPI_PROCESS

Class OP_other_namelist

Label: Label

Description: Other namelist label, eg

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

Class OP_SLCF_VECTOR

Label: VECTOR

Description: Create animated vectors

From/To FDS as: VECTOR

Default FDS value: False

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

Class OP_SLCF_CELL_CENTERED

Label: CELL_CENTERED

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

From/To FDS as: CELL_CENTERED

Default FDS value: False

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

Class OP_VENT_OBST_ID

Label: OBST_ID

Description: Specify OBST on which projecting the condition

From/To FDS as: OBST_ID

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

Class BFNamelistSc

Label: No Label

Description:

Class BFNamelistOb

Label: No Label

Description:

Export status in: Object.hide_render

Class BFNamelistMa

Label: No Label

Description:

Class SN_MOVE

Label: MOVE

Description: Geometric transformations

From/To FDS as: MOVE

Class SN_config

Label: FDS Case Config

Description:

Linked parameters:

Class SN_HEAD

Label: HEAD

Description: Case header

From/To FDS as: HEAD

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

Export default: True

Linked parameters:

Class SN_TAIL

Label: TAIL

Description: Case closing

From/To FDS as: TAIL

Class SN_TIME

Label: TIME

Description: Simulation time settings

From/To FDS as: TIME

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

Export default: True

Linked parameters:

Class SN_MISC

Label: MISC

Description: Miscellaneous parameters

From/To FDS as: MISC

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

Export default: False

Linked parameters:

Class SN_PRES

Label: PRES

Description: Pressure Solver

From/To FDS as: PRES

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

Export default: False

Linked parameters:

Class SN_RADI

Label: RADI

Description: Radiation parameters

From/To FDS as: RADI

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

Export default: False

Linked parameters:

Class SN_REAC

Label: REAC

Description: Reaction

From/To FDS as: REAC

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

Export default: False

Linked parameters:

Class SN_CATF

Label: CATF

Description: Concatenated file paths

From/To FDS as: CATF

Linked parameters:

Class SN_DUMP

Label: DUMP

Description: Output parameters

From/To FDS as: DUMP

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

Export default: False

Linked parameters:

Class SN_MULT

Label: MULT

Description: Multiplier transformations

From/To FDS as: MULT

Class MN_SURF

Label: SURF

Description: Boundary condition

From/To FDS as: SURF

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

Export default: True

Linked parameters:

Class ON_MULT

Label: MULT

Description: Multiplier

From/To FDS as: MULT

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

Export default: False

Linked parameters:

Class ON_DEVC

Label: DEVC

Description: Device

From/To FDS as: DEVC

Export status in: Object.hide_render

Linked parameters:

Class ON_MOVE

Label: MOVE

Description: Geometric Transformation

From/To FDS as: MOVE

Linked parameters:

Class ON_GEOM

Label: GEOM

Description: Geometry

From/To FDS as: GEOM

Export status in: Object.hide_render

Linked parameters:

Class ON_HOLE

Label: HOLE

Description: Obstruction cutout

From/To FDS as: HOLE

Export status in: Object.hide_render

Linked parameters:

Class ON_INIT

Label: INIT

Description: Initial condition

From/To FDS as: INIT

Export status in: Object.hide_render

Linked parameters:

Class ON_MESH

Label: MESH

Description: Domain of simulation

From/To FDS as: MESH

Export status in: Object.hide_render

Linked parameters:

Class ON_OBST

Label: OBST

Description: Obstruction

From/To FDS as: OBST

Export status in: Object.hide_render

Linked parameters:

Class ON_other

Label: Other

Description: Other namelist

From/To FDS as: <property object at 0x1516a155f6f0>

Export status in: Object.hide_render

Linked parameters:

Class ON_PROF

Label: PROF

Description: Wall profile output

From/To FDS as: PROF

Export status in: Object.hide_render

Linked parameters:

Class ON_SLCF

Label: SLCF

Description: Slice file

From/To FDS as: SLCF

Export status in: Object.hide_render

Linked parameters:

Class ON_VENT

Label: VENT

Description: Boundary condition patch

From/To FDS as: VENT

Export status in: Object.hide_render

Linked parameters:

Class ON_ZONE

Label: ZONE

Description: Pressure zone

From/To FDS as: ZONE

Export status in: Object.hide_render

Linked parameters:

Clone this wiki locally