Skip to content

Commit f13ec1f

Browse files
yifan-flexyifan-flex
committed
[FXC-4804] Support surface selection for custom force distribution
1 parent 9f45485 commit f13ec1f

File tree

5 files changed

+319
-3
lines changed

5 files changed

+319
-3
lines changed

‎flow360/component/simulation/outputs/outputs.py‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1539,12 +1539,23 @@ class ForceDistributionOutput(Flow360BaseModel):
15391539
Example
15401540
-------
15411541
1542+
Basic usage with default settings (all wall surfaces):
15421543
15431544
>>> fl.ForceDistributionOutput(
15441545
... name="spanwise",
15451546
... distribution_direction=[0.1, 0.9, 0.0],
15461547
... )
15471548
1549+
Specifying specific surfaces to include in the force integration (useful for automotive cases
1550+
to exclude road/floor surfaces):
1551+
1552+
>>> fl.ForceDistributionOutput(
1553+
... name="vehicle_x_distribution",
1554+
... distribution_direction=[1.0, 0.0, 0.0],
1555+
... entities=[volume_mesh["vehicle_body"], volume_mesh["wheels"]],
1556+
... number_of_segments=500,
1557+
... )
1558+
15481559
====
15491560
"""
15501561

@@ -1555,10 +1566,29 @@ class ForceDistributionOutput(Flow360BaseModel):
15551566
distribution_type: Literal["incremental", "cumulative"] = pd.Field(
15561567
"incremental", description="Type of the distribution."
15571568
)
1569+
entities: Optional[EntityList[Surface, MirroredSurface]] = pd.Field(
1570+
None,
1571+
alias="surfaces",
1572+
description="List of surfaces to include in the force integration. "
1573+
"If not specified, all wall surfaces are included. "
1574+
"This is useful for automotive cases to exclude road/floor surfaces.",
1575+
)
1576+
number_of_segments: Optional[pd.PositiveInt] = pd.Field(
1577+
None,
1578+
description="Number of segments (bins) to use along the distribution direction. "
1579+
"If not specified, the default of 300 segments is used. "
1580+
"Increasing this value provides higher resolution in the force distribution plot.",
1581+
)
15581582
output_type: Literal["ForceDistributionOutput"] = pd.Field(
15591583
"ForceDistributionOutput", frozen=True
15601584
)
15611585

1586+
@contextual_field_validator("entities", mode="after")
1587+
@classmethod
1588+
def ensure_surface_existence(cls, value, param_info: ParamsValidationInfo):
1589+
"""Ensure all boundaries will be present after mesher"""
1590+
return validate_entity_list_surface_existence(value, param_info)
1591+
15621592

15631593
class TimeAverageForceDistributionOutput(ForceDistributionOutput):
15641594
"""
@@ -1576,6 +1606,17 @@ class TimeAverageForceDistributionOutput(ForceDistributionOutput):
15761606
... start_step=4,
15771607
... )
15781608
1609+
Specifying specific surfaces to include in the force integration (useful for automotive cases
1610+
to exclude road/floor surfaces):
1611+
1612+
>>> fl.TimeAverageForceDistributionOutput(
1613+
... name="vehicle_x_distribution",
1614+
... distribution_direction=[1.0, 0.0, 0.0],
1615+
... entities=[volume_mesh["vehicle_body"], volume_mesh["wheels"]],
1616+
... number_of_segments=500,
1617+
... start_step=100,
1618+
... )
1619+
15791620
====
15801621
"""
15811622

‎flow360/component/simulation/services.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121

2222
# Required for correct global scope initialization
2323
from flow360.component.simulation.blueprint.core.dependency_graph import DependencyGraph
24-
from flow360.component.simulation.entity_info import GeometryEntityInfo
24+
from flow360.component.simulation.entity_info import (
25+
GeometryEntityInfo,
26+
)
2527
from flow360.component.simulation.entity_info import (
2628
merge_geometry_entity_info as merge_geometry_entity_info_obj,
2729
)

‎flow360/component/simulation/translator/solver_translator.py‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -818,10 +818,18 @@ def translate_force_distribution_output(output_params: list):
818818
force_distribution_output = {}
819819
for output in output_params:
820820
if is_exact_instance(output, ForceDistributionOutput):
821-
force_distribution_output[output.name] = {
821+
config = {
822822
"direction": list(output.distribution_direction),
823823
"type": output.distribution_type,
824824
}
825+
# Add surfaces if specified (for selective face integration)
826+
if output.entities is not None:
827+
surface_names = [entity.full_name for entity in output.entities.stored_entities]
828+
config["surfaces"] = surface_names
829+
# Add number of segments if specified
830+
if output.number_of_segments is not None:
831+
config["numberOfSegments"] = output.number_of_segments
832+
force_distribution_output[output.name] = config
825833
return force_distribution_output
826834

827835

@@ -830,11 +838,19 @@ def translate_time_averaged_force_distribution_output(output_params: list):
830838
time_averaged_force_distribution_output = {}
831839
for output in output_params:
832840
if isinstance(output, TimeAverageForceDistributionOutput):
833-
time_averaged_force_distribution_output[output.name] = {
841+
config = {
834842
"direction": list(output.distribution_direction),
835843
"type": output.distribution_type,
836844
"startAverageIntegrationStep": output.start_step,
837845
}
846+
# Add surfaces if specified (for selective face integration)
847+
if output.entities is not None:
848+
surface_names = [entity.full_name for entity in output.entities.stored_entities]
849+
config["surfaces"] = surface_names
850+
# Add number of segments if specified
851+
if output.number_of_segments is not None:
852+
config["numberOfSegments"] = output.number_of_segments
853+
time_averaged_force_distribution_output[output.name] = config
838854
return time_averaged_force_distribution_output
839855

840856

‎tests/simulation/params/test_validators_output.py‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1386,3 +1386,72 @@ def test_force_output_with_model_id():
13861386
assert err["type"] == exp_err["type"]
13871387
assert err["ctx"]["relevant_for"] == exp_err["ctx"]["relevant_for"]
13881388
assert err["msg"] == exp_err["msg"]
1389+
1390+
1391+
def test_force_distribution_output_entities_validation():
1392+
"""Test ForceDistributionOutput entities validation."""
1393+
1394+
# Test 1: Valid case - ForceDistributionOutput without entities (default all walls)
1395+
with imperial_unit_system:
1396+
SimulationParams(
1397+
outputs=[
1398+
ForceDistributionOutput(
1399+
name="test_default",
1400+
distribution_direction=[1.0, 0.0, 0.0],
1401+
),
1402+
],
1403+
)
1404+
1405+
# Test 2: Valid case - ForceDistributionOutput with surface entities
1406+
with imperial_unit_system:
1407+
SimulationParams(
1408+
outputs=[
1409+
ForceDistributionOutput(
1410+
name="test_with_surfaces",
1411+
distribution_direction=[1.0, 0.0, 0.0],
1412+
entities=[Surface(name="fluid/wing")],
1413+
),
1414+
],
1415+
)
1416+
1417+
# Test 3: Valid case - TimeAverageForceDistributionOutput with entities
1418+
with imperial_unit_system:
1419+
SimulationParams(
1420+
outputs=[
1421+
TimeAverageForceDistributionOutput(
1422+
name="test_time_avg",
1423+
distribution_direction=[0.0, 1.0, 0.0],
1424+
entities=[Surface(name="fluid/body")],
1425+
start_step=10,
1426+
),
1427+
],
1428+
time_stepping=Unsteady(steps=100, step_size=1e-3),
1429+
)
1430+
1431+
# Test 4: Valid case - ForceDistributionOutput with multiple surfaces
1432+
with imperial_unit_system:
1433+
SimulationParams(
1434+
outputs=[
1435+
ForceDistributionOutput(
1436+
name="test_multiple_surfaces",
1437+
distribution_direction=[0.0, 0.0, 1.0],
1438+
entities=[
1439+
Surface(name="fluid/wing"),
1440+
Surface(name="fluid/fuselage"),
1441+
],
1442+
),
1443+
],
1444+
)
1445+
1446+
# Test 5: Valid case - ForceDistributionOutput with custom number_of_segments
1447+
with imperial_unit_system:
1448+
SimulationParams(
1449+
outputs=[
1450+
ForceDistributionOutput(
1451+
name="test_custom_segments",
1452+
distribution_direction=[1.0, 0.0, 0.0],
1453+
entities=[Surface(name="fluid/wing")],
1454+
number_of_segments=500,
1455+
),
1456+
],
1457+
)

‎tests/simulation/translator/test_output_translation.py‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,6 +1224,93 @@ def test_force_distribution_output():
12241224
assert compare_values(param_with_ref[1], translated["forceDistributionOutput"])
12251225

12261226

1227+
def test_force_distribution_output_with_entities_and_segments():
1228+
"""Test ForceDistributionOutput with entities (selective surfaces) and number_of_segments parameters."""
1229+
# Test with entities (selective surfaces)
1230+
param_with_entities = (
1231+
[
1232+
ForceDistributionOutput(
1233+
name="test_with_entities",
1234+
distribution_direction=[1.0, 0.0, 0.0],
1235+
entities=[
1236+
Surface(name="wing", private_attribute_full_name="fluid/wing"),
1237+
Surface(name="fuselage", private_attribute_full_name="fluid/fuselage"),
1238+
],
1239+
),
1240+
],
1241+
{
1242+
"test_with_entities": {
1243+
"direction": [1.0, 0.0, 0.0],
1244+
"type": "incremental",
1245+
"surfaces": ["fluid/wing", "fluid/fuselage"],
1246+
},
1247+
},
1248+
)
1249+
1250+
with SI_unit_system:
1251+
param = SimulationParams(outputs=param_with_entities[0])
1252+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1253+
1254+
translated = {}
1255+
translated = translate_output(param, translated)
1256+
assert compare_values(param_with_entities[1], translated["forceDistributionOutput"])
1257+
1258+
# Test with number_of_segments
1259+
param_with_segments = (
1260+
[
1261+
ForceDistributionOutput(
1262+
name="test_with_segments",
1263+
distribution_direction=[0.0, 1.0, 0.0],
1264+
number_of_segments=500,
1265+
),
1266+
],
1267+
{
1268+
"test_with_segments": {
1269+
"direction": [0.0, 1.0, 0.0],
1270+
"type": "incremental",
1271+
"numberOfSegments": 500,
1272+
},
1273+
},
1274+
)
1275+
1276+
with SI_unit_system:
1277+
param = SimulationParams(outputs=param_with_segments[0])
1278+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1279+
1280+
translated = {}
1281+
translated = translate_output(param, translated)
1282+
assert compare_values(param_with_segments[1], translated["forceDistributionOutput"])
1283+
1284+
# Test with both entities and number_of_segments
1285+
param_with_both = (
1286+
[
1287+
ForceDistributionOutput(
1288+
name="test_with_both",
1289+
distribution_direction=[0.0, 0.0, 1.0],
1290+
entities=[Surface(name="body", private_attribute_full_name="fluid/body")],
1291+
number_of_segments=400,
1292+
distribution_type="cumulative",
1293+
),
1294+
],
1295+
{
1296+
"test_with_both": {
1297+
"direction": [0.0, 0.0, 1.0],
1298+
"type": "cumulative",
1299+
"surfaces": ["fluid/body"],
1300+
"numberOfSegments": 400,
1301+
},
1302+
},
1303+
)
1304+
1305+
with SI_unit_system:
1306+
param = SimulationParams(outputs=param_with_both[0])
1307+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1308+
1309+
translated = {}
1310+
translated = translate_output(param, translated)
1311+
assert compare_values(param_with_both[1], translated["forceDistributionOutput"])
1312+
1313+
12271314
def test_time_averaged_force_distribution_output():
12281315
param_with_ref = (
12291316
[
@@ -1263,6 +1350,107 @@ def test_time_averaged_force_distribution_output():
12631350
assert compare_values(param_with_ref[1], translated["timeAveragedForceDistributionOutput"])
12641351

12651352

1353+
def test_time_averaged_force_distribution_output_with_entities_and_segments():
1354+
"""Test TimeAverageForceDistributionOutput with entities and number_of_segments parameters."""
1355+
# Test with entities (selective surfaces)
1356+
param_with_entities = (
1357+
[
1358+
TimeAverageForceDistributionOutput(
1359+
name="test_time_avg_entities",
1360+
distribution_direction=[1.0, 0.0, 0.0],
1361+
entities=[
1362+
Surface(name="wing", private_attribute_full_name="fluid/wing"),
1363+
],
1364+
start_step=10,
1365+
),
1366+
],
1367+
{
1368+
"test_time_avg_entities": {
1369+
"direction": [1.0, 0.0, 0.0],
1370+
"type": "incremental",
1371+
"startAverageIntegrationStep": 10,
1372+
"surfaces": ["fluid/wing"],
1373+
},
1374+
},
1375+
)
1376+
1377+
with SI_unit_system:
1378+
param = SimulationParams(
1379+
outputs=param_with_entities[0], time_stepping=Unsteady(steps=100, step_size=0.1)
1380+
)
1381+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1382+
1383+
translated = {}
1384+
translated = translate_output(param, translated)
1385+
assert compare_values(param_with_entities[1], translated["timeAveragedForceDistributionOutput"])
1386+
1387+
# Test with number_of_segments
1388+
param_with_segments = (
1389+
[
1390+
TimeAverageForceDistributionOutput(
1391+
name="test_time_avg_segments",
1392+
distribution_direction=[0.0, 1.0, 0.0],
1393+
number_of_segments=600,
1394+
start_step=20,
1395+
),
1396+
],
1397+
{
1398+
"test_time_avg_segments": {
1399+
"direction": [0.0, 1.0, 0.0],
1400+
"type": "incremental",
1401+
"startAverageIntegrationStep": 20,
1402+
"numberOfSegments": 600,
1403+
},
1404+
},
1405+
)
1406+
1407+
with SI_unit_system:
1408+
param = SimulationParams(
1409+
outputs=param_with_segments[0], time_stepping=Unsteady(steps=100, step_size=0.1)
1410+
)
1411+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1412+
1413+
translated = {}
1414+
translated = translate_output(param, translated)
1415+
assert compare_values(param_with_segments[1], translated["timeAveragedForceDistributionOutput"])
1416+
1417+
# Test with both entities and number_of_segments
1418+
param_with_both = (
1419+
[
1420+
TimeAverageForceDistributionOutput(
1421+
name="test_time_avg_both",
1422+
distribution_direction=[0.0, 0.0, 1.0],
1423+
entities=[
1424+
Surface(name="body", private_attribute_full_name="fluid/body"),
1425+
Surface(name="tail", private_attribute_full_name="fluid/tail"),
1426+
],
1427+
number_of_segments=350,
1428+
distribution_type="cumulative",
1429+
start_step=50,
1430+
),
1431+
],
1432+
{
1433+
"test_time_avg_both": {
1434+
"direction": [0.0, 0.0, 1.0],
1435+
"type": "cumulative",
1436+
"startAverageIntegrationStep": 50,
1437+
"surfaces": ["fluid/body", "fluid/tail"],
1438+
"numberOfSegments": 350,
1439+
},
1440+
},
1441+
)
1442+
1443+
with SI_unit_system:
1444+
param = SimulationParams(
1445+
outputs=param_with_both[0], time_stepping=Unsteady(steps=100, step_size=0.1)
1446+
)
1447+
param = param._preprocess(mesh_unit=1.0 * u.m, exclude=["models"])
1448+
1449+
translated = {}
1450+
translated = translate_output(param, translated)
1451+
assert compare_values(param_with_both[1], translated["timeAveragedForceDistributionOutput"])
1452+
1453+
12661454
def test_surface_slice_output(vel_in_km_per_hr):
12671455
param_with_ref = (
12681456
[

0 commit comments

Comments
 (0)