Result of classifying a single world-space point against an OpenLB-tagged DDS scene. More...

#include <bgi_openlb_bridge.h>

Data Fields
std::string	boundary
	Value of the `openlb.boundary` attribute of the matched object.

bool	matched {false}
	`true` if a DDS object containing the query point was found; `false` otherwise.

int	material {0}
	Resolved material ID for the matched object.

std::string	objectId
	ID string of the matched DDS object.

bool	occupied {false}
	`true` when the matched object's `openlb.role` is anything other than `"fluid"` (i.e., the point is inside a solid/wall/obstacle region).

int	priority {0}
	Sort key used to resolve conflicts when multiple DDS objects contain the same point.

std::string	role
	Lower-cased value of the `openlb.role` attribute of the matched object.

Detailed Description

Result of classifying a single world-space point against an OpenLB-tagged DDS scene.

Populated by openlbClassifyPoint(). The matched flag is the authoritative indicator of whether any DDS object was found; all other fields are meaningful only when matched == true.

Field Documentation

◆ boundary

std::string bgi::OpenLbMaterialHit::boundary

Value of the openlb.boundary attribute of the matched object.

Typical values: "wall", "obstacle", "inlet", "outlet". Empty when the attribute is absent or when matched == false.

◆ matched

bool bgi::OpenLbMaterialHit::matched {false}

true if a DDS object containing the query point was found; false otherwise.

◆ material

int bgi::OpenLbMaterialHit::material {0}

Resolved material ID for the matched object.

Derived in priority order from the openlb.material attribute (if present), then from openlb.role ("fluid" → defaultFluidMaterial, otherwise → defaultSolidMaterial). Zero when matched == false.

◆ objectId

std::string bgi::OpenLbMaterialHit::objectId

ID string of the matched DDS object.

Empty when matched == false.

◆ occupied

bool bgi::OpenLbMaterialHit::occupied {false}

true when the matched object's openlb.role is anything other than "fluid" (i.e., the point is inside a solid/wall/obstacle region).

◆ priority

int bgi::OpenLbMaterialHit::priority {0}

Sort key used to resolve conflicts when multiple DDS objects contain the same point.

Populated from the openlb.priority attribute (integer). Higher values take precedence. Defaults to 0 when the attribute is absent.

◆ role

std::string bgi::OpenLbMaterialHit::role

Lower-cased value of the openlb.role attribute of the matched object.

Typical values: "fluid", "solid", "wall", "obstacle". Empty when the attribute is absent or when matched == false.

The documentation for this struct was generated from the following file:

bgi_openlb_bridge.h

Data Fields