Skip to content

Added check for dependent features #1218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benflexcompute merged 5 commits into from
Jul 1, 2025
Merged

Added check for dependent features #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbec1d9
Now hand over to helper
benflexcompute Jul 1, 2025
16c13ee
Added check for dependent features
benflexcompute Jul 1, 2025
7ae36fd
Removed print
benflexcompute Jul 1, 2025
e44bbb9
Added missing check
benflexcompute Jul 1, 2025
512aabd
Merge branch 'expressions' into BenY/MovePipelineValidaiton-1
benflexcompute Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion flow360/component/project_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ def validate_params_with_context(params, root_item_type, up_to):
)

params, errors, _ = services.validate_model(
params_as_dict=params.model_dump(),
params_as_dict=params.model_dump(exclude_none=True),
validated_by=services.ValidationCalledBy.LOCAL,
root_item_type=root_item_type,
validation_level=validation_level,
Expand Down
82 changes: 82 additions & 0 deletions flow360/component/simulation/user_code/core/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
is_runtime_expression,
split_keep_delimiters,
)
from flow360.component.simulation.validation.validation_context import (
get_validation_info,
)

_solver_variables: dict[str, str] = {}

Expand Down Expand Up @@ -562,6 +565,62 @@ def get_input_value_length(
return 0 if isinstance(value, (unyt_quantity, Number)) else value.shape[0]


_feature_requirement_map = {
"solution.nu_hat": (
lambda x: x.feature_usage.turbulence_model_type == "SpalartAllmaras",
"Spalart-Allmaras turbulence solver is not used.",
),
"solution.turbulence_kinetic_energy": (
lambda x: x.feature_usage.turbulence_model_type == "kOmegaSST",
"k-omega turbulence solver is not used.",
),
"solution.specific_rate_of_dissipation": (
lambda x: x.feature_usage.turbulence_model_type == "kOmegaSST",
"k-omega turbulence solver is not used.",
),
"solution.amplification_factor": (
lambda x: x.feature_usage.transition_model_type == "AmplificationFactorTransport",
"Amplification factor transition model is not used.",
),
"solution.turbulence_intermittency": (
lambda x: x.feature_usage.transition_model_type == "AmplificationFactorTransport",
"Amplification factor transition model is not used.",
),
"solution.density": (
lambda x: x.using_liquid_as_material is False,
"Liquid operating condition is used.",
),
"solution.temperature": (
lambda x: x.using_liquid_as_material is False,
"Liquid operating condition is used.",
),
"solution.Mach": (
lambda x: x.using_liquid_as_material is False,
"Liquid operating condition is used.",
),
"control.physicalStep": (
lambda x: x.time_stepping == "Unsteady",
"Unsteady time stepping is not used.",
),
"control.timeStepSize": (
lambda x: x.time_stepping == "Unsteady",
"Unsteady time stepping is not used.",
),
"control.theta": (
lambda x: x.feature_usage.rotation_zone_count == 0,
"Rotation zone is not used.",
),
"control.omega": (
lambda x: x.feature_usage.rotation_zone_count == 0,
"Rotation zone is not used.",
),
"control.omegaDot": (
lambda x: x.feature_usage.rotation_zone_count == 0,
"Rotation zone is not used.",
),
}


class Expression(Flow360BaseModel, Evaluable):
"""
A symbolic, validated representation of a mathematical expression.
Expand Down Expand Up @@ -606,6 +665,7 @@ def _validate_expression(cls, value) -> Self:
type="value_error", ctx={"error": f"Invalid type {type(value)}"}
)
raise pd.ValidationError.from_exception_data("Expression type error", [details])

try:
# To ensure the expression is valid (also checks for
expr_to_model(expression, default_context)
Expand Down Expand Up @@ -664,6 +724,28 @@ def disable_relative_temperature_scale_in_output_units(cls, value: str) -> str:
)
return value

@pd.model_validator(mode="after")
def ensure_dependent_feature_enabled(self) -> str:
"""
Ensure that all dependent features are enabled for all the solver variables.
Remaining checks:
1. variable valid source check.
2. variable location check.

"""
validation_info = get_validation_info()
if validation_info is None:
return self

for solver_variable_name in self.solver_variable_names():
if solver_variable_name in _feature_requirement_map:
if not _feature_requirement_map[solver_variable_name][0](validation_info):
raise ValueError(
f"`{solver_variable_name}` cannot be used "
f"because {_feature_requirement_map[solver_variable_name][1]}"
)
return self

def evaluate(
self,
context: EvaluationContext = None,
Expand Down
46 changes: 46 additions & 0 deletions flow360/component/simulation/validation/validation_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,42 @@ class TimeSteppingType(Enum):
UNSET = "Unset"


class FeatureUsageInfo:
"""
Model that provides the information for each individual feature usage.
"""

# pylint: disable=too-few-public-methods
__slots__ = [
"turbulence_model_type",
"transition_model_type",
"rotation_zone_count",
"bet_disk_count",
]

def __init__(self, param_as_dict: dict):
self.turbulence_model_type = None
self.transition_model_type = None
self.rotation_zone_count = 0
self.bet_disk_count = 0

if "models" in param_as_dict and param_as_dict["models"]:
for model in param_as_dict["models"]:
if model["type"] == "Fluid":
self.turbulence_model_type = model.get("turbulence_model_solver", {}).get(
"type_name", None
)
self.transition_model_type = model.get("transition_model_solver", {}).get(
"type_name", None
)

if model["type"] == "Rotation":
self.rotation_zone_count += 1

if model["type"] == "BETDisk":
self.bet_disk_count += 1


_validation_level_ctx = contextvars.ContextVar("validation_levels", default=None)
_validation_info_ctx = contextvars.ContextVar("validation_info", default=None)

Expand Down Expand Up @@ -74,6 +110,7 @@ class ParamsValidationInfo: # pylint:disable=too-few-public-methods
"use_geometry_AI",
"using_liquid_as_material",
"time_stepping",
"feature_usage",
]

@classmethod
Expand Down Expand Up @@ -126,6 +163,14 @@ def _get_time_stepping_(cls, param_as_dict: dict):
except KeyError:
return TimeSteppingType.UNSET

@classmethod
def _get_feature_usage_info(cls, param_as_dict: dict):
# 1. Turbulence model type
# 2. Transition model type
# 3. Usage of Rotation zone
# 4. Usage of BETDisk
return FeatureUsageInfo(param_as_dict=param_as_dict)

def __init__(self, param_as_dict: dict):
self.auto_farfield_method = self._get_auto_farfield_method_(param_as_dict=param_as_dict)
self.is_beta_mesher = self._get_is_beta_mesher_(param_as_dict=param_as_dict)
Expand All @@ -136,6 +181,7 @@ def __init__(self, param_as_dict: dict):
param_as_dict=param_as_dict
)
self.time_stepping = self._get_time_stepping_(param_as_dict=param_as_dict)
self.feature_usage = self._get_feature_usage_info(param_as_dict=param_as_dict)


class ValidationContext:
Expand Down
Loading