Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
28 changes: 21 additions & 7 deletions src/ansys/fluent/core/services/solution_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,19 @@ def __init__(self, zone_name: str, allowed_values: List[str]):
)


class DomainError(ValueError):
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prmukherj looks like ZoneError is defined above so I think the location of this exception should be fine

"""Exception class for errors in domain name."""

def __init__(self, domain_name: str, allowed_values: List[str]):
"""Initialize DomainError."""
self.domain_name = domain_name
super().__init__(
allowed_name_error_message(
context="domain", trial_name=domain_name, allowed_values=allowed_values
)
)


class _AllowedNames:
def is_valid(self, name):
"""Check whether a given name is valid or not."""
Expand Down Expand Up @@ -422,15 +435,16 @@ def valid_name(self, domain_name):

Raises
------
ZoneError
DomainError
If the given domain name is invalid.
"""
if not self.is_valid(domain_name):
raise ZoneError(
domain_name=domain_name,
allowed_values=self(),
)
return self._zones_info.domain_id(domain_name)
domain_id = self._zones_info.domain_id(domain_name)
if domain_id is not None:
return domain_id
raise DomainError(
domain_name=domain_name,
allowed_values=self(),
)


class _SvarMethod:
Expand Down
55 changes: 55 additions & 0 deletions tests/test_solution_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,64 @@

from ansys.fluent.core import examples
from ansys.fluent.core.examples.downloads import download_file
from ansys.fluent.core.services.solution_variables import (
DomainError,
_AllowedDomainNames,
)
from ansys.units.variable_descriptor import VariableCatalog


class _DummyZonesInfo:
"""Mock ZonesInfo for unit testing _AllowedDomainNames."""

def __init__(self, domains, domain_id_map):
self._domains = domains
self._domain_id_map = domain_id_map

@property
def domains(self):
return self._domains

def domain_id(self, name):
return self._domain_id_map.get(name, None)


class _DummySVInfo:
"""Mock SolutionVariableInfo for unit testing _AllowedDomainNames."""

def __init__(self, zones_info):
self._zones_info = zones_info

def get_zones_info(self):
return self._zones_info


def test_allowed_domain_names_valid_name_returns_domain_id():
zones_info = _DummyZonesInfo(domains=["mixture"], domain_id_map={"mixture": 1})
allowed = _AllowedDomainNames(_DummySVInfo(zones_info))
assert allowed.valid_name("mixture") == 1


def test_allowed_domain_names_valid_name_domain_id_zero():
zones_info = _DummyZonesInfo(domains=["mixture"], domain_id_map={"mixture": 0})
allowed = _AllowedDomainNames(_DummySVInfo(zones_info))
assert allowed.valid_name("mixture") == 0


def test_allowed_domain_names_valid_name_raises_on_missing_domain_id():
zones_info = _DummyZonesInfo(domains=["mixture"], domain_id_map={})
allowed = _AllowedDomainNames(_DummySVInfo(zones_info))
with pytest.raises(DomainError):
allowed.valid_name("mixture")


def test_allowed_domain_names_valid_name_raises_on_invalid_domain():
zones_info = _DummyZonesInfo(domains=["mixture"], domain_id_map={"mixture": 1})
allowed = _AllowedDomainNames(_DummySVInfo(zones_info))
with pytest.raises(DomainError):
allowed.valid_name("nonexistent")


@pytest.mark.fluent_version(">=23.2")
def test_solution_variables(new_solver_session):
solver = new_solver_session
Expand Down
Loading