VolumeSelector

VolumeSelector#

class VolumeSelector[source]#

Bases: EntitySelector

Pattern-based selector for volume zone entities. Stores matching rules, enabling reusable SimulationParams templates.

Example

>>> # Simple: match volumes by glob pattern
>>> fl.VolumeSelector(name="fluid_zones").match("fluid*")
>>> # With OR logic: match specific zones by name
>>> sel = fl.VolumeSelector(
...     name="porous_zones", logic="OR",
...     description="Zones for porous medium"
... ).any_of(["zone1", "zone2"])

Attributes

description: str, optional#

Customizable description of the selector.

Default:

None

name: str#

Unique name for this selector.

logic: Literal['AND', 'OR']#
Default:

'AND'

children: list[Predicate]#
Default:

[]

Additional Constructors

match(pattern, *, attribute='name')#

Append a matches predicate and return self for chaining.

Glob dialect: flow360_schema.framework.glob_pattern.

Parameters:
Return type:

Self

not_match(pattern, *, attribute='name')#

Append a not-matches predicate and return self for chaining.

Glob dialect: flow360_schema.framework.glob_pattern.

Parameters:
Return type:

Self

any_of(values, *, attribute='name')#

Append an in predicate and return self for chaining.

Parameters:
Return type:

Self

not_any_of(values, *, attribute='name')#

Append a notIn predicate and return self for chaining.

Parameters:
Return type:

Self