ansys-fluent-core 0.20.dev12__py3-none-any.whl → 0.21.dev0__py3-none-any.whl

ansys/fluent/core/session.py

@@ -3,7 +3,7 @@
 import importlib
 import json
 import logging
-from typing import Any, Optional
+from typing import Any, Optional, Union
 import warnings
 
 from ansys.fluent.core.fluent_connection import FluentConnection
@@ -308,16 +308,31 @@ class BaseSession:
         data."""
         self._fluent_connection.force_exit()
 
-    def upload(self, file_name: str):
+    def _file_transfer_api_warning(self, method_name: str) -> str:
+        """User warning for upload/download methods."""
+        return f"You have directly called the {method_name} method of the session. \
+        Please be advised that for the current version of Fluent, many API methods \
+        automatically handle file uploads and downloads internally. You may not \
+        need to explicitly call {method_name} in most cases. \
+        However, there are exceptions, particularly in PMFileManagement, where complex \
+        file interactions require explicit use of {method_name}  method \
+        for relevant files."
+
+    def upload(
+        self, file_name: Union[list[str], str], remote_file_name: Optional[str] = None
+    ):
         """Upload a file to the server.
 
         Parameters
         ----------
         file_name : str
             Name of the local file to upload to the server.
+        remote_file_name : str, optional
+            remote file name, by default None
         """
+        warnings.warn(self._file_transfer_api_warning("upload()"), UserWarning)
         if self._file_transfer_service:
-            return self._file_transfer_service.upload_file(file_name)
+            return self._file_transfer_service.upload(file_name, remote_file_name)
 
     def download(self, file_name: str, local_directory: Optional[str] = "."):
         """Download a file from the server.
@@ -329,8 +344,9 @@ class BaseSession:
         local_directory : str, optional
             Local destination directory. The default is the current working directory.
         """
+        warnings.warn(self._file_transfer_api_warning("download()"), UserWarning)
         if self._file_transfer_service:
-            return self._file_transfer_service.download_file(file_name, local_directory)
+            return self._file_transfer_service.download(file_name, local_directory)
 
     def __enter__(self):
         return self

ansys/fluent/core/session_meshing.pyi

@@ -3,12 +3,10 @@ from ansys.fluent.core.datamodel_241.PMFileManagement import (
 )
 from ansys.fluent.core.datamodel_241.PartManagement import Root as partmanagement_root
 from ansys.fluent.core.datamodel_241.meshing import Root as meshing_root
-from ansys.fluent.core.datamodel_241.meshing_utilities import (
-    Root as meshing_utilities_root,
-)
 from ansys.fluent.core.datamodel_241.preferences import Root as preferences_root
 from ansys.fluent.core.datamodel_241.workflow import Root as workflow_root
-from ansys.fluent.core.solver.tui_241 import main_menu
+from ansys.fluent.core.meshing.tui_241 import main_menu
+from ansys.fluent.core.services.meshing_queries import MeshingQueries
 
 class Meshing:
     @property
@@ -16,7 +14,7 @@ class Meshing:
     @property
     def meshing(self) -> meshing_root: ...
     @property
-    def meshing_utilities(self) -> meshing_utilities_root: ...
+    def meshing_queries(self) -> MeshingQueries: ...
     @property
     def workflow(self) -> workflow_root: ...
     @property

ansys/fluent/core/session_pure_meshing.py

@@ -81,7 +81,7 @@ class PureMeshing(BaseSession):
         return self._base_meshing.meshing
 
     @property
-    def meshing_queries(self):
+    def meshing_queries(self) -> MeshingQueries:
         """Datamodel root of meshing_queries."""
         if self.get_fluent_version() >= FluentVersion.v232:
             return MeshingQueries(self.meshing_queries_service)

ansys/fluent/core/session_pure_meshing.pyi

@@ -3,12 +3,10 @@ from ansys.fluent.core.datamodel_241.PMFileManagement import (
 )
 from ansys.fluent.core.datamodel_241.PartManagement import Root as partmanagement_root
 from ansys.fluent.core.datamodel_241.meshing import Root as meshing_root
-from ansys.fluent.core.datamodel_241.meshing_utilities import (
-    Root as meshing_utilities_root,
-)
 from ansys.fluent.core.datamodel_241.preferences import Root as preferences_root
 from ansys.fluent.core.datamodel_241.workflow import Root as workflow_root
-from ansys.fluent.core.solver.tui_241 import main_menu
+from ansys.fluent.core.meshing.tui_241 import main_menu
+from ansys.fluent.core.services.meshing_queries import MeshingQueries
 
 class PureMeshing:
     @property
@@ -16,7 +14,7 @@ class PureMeshing:
     @property
     def meshing(self) -> meshing_root: ...
     @property
-    def meshing_utilities(self) -> meshing_utilities_root: ...
+    def meshing_utilities(self) -> MeshingQueries: ...
     @property
     def workflow(self) -> workflow_root: ...
     def watertight(self): ...

ansys/fluent/core/session_solver.pyi

@@ -1,5 +1,4 @@
 from ansys.fluent.core.datamodel_241.preferences import Root as preferences_root
-from ansys.fluent.core.datamodel_241.solverworkflow import Root as solverworkflow_root
 from ansys.fluent.core.datamodel_241.workflow import Root as workflow_root
 from ansys.fluent.core.solver.settings_241.current_parametric_study import (
     current_parametric_study,
@@ -7,8 +6,8 @@ from ansys.fluent.core.solver.settings_241.current_parametric_study import (
 from ansys.fluent.core.solver.settings_241.file import file
 from ansys.fluent.core.solver.settings_241.mesh import mesh
 from ansys.fluent.core.solver.settings_241.parallel import parallel
+from ansys.fluent.core.solver.settings_241.parameters import parameters
 from ansys.fluent.core.solver.settings_241.parametric_studies import parametric_studies
-from ansys.fluent.core.solver.settings_241.report import report
 from ansys.fluent.core.solver.settings_241.results import results
 from ansys.fluent.core.solver.settings_241.server import server
 from ansys.fluent.core.solver.settings_241.setup import setup
@@ -44,8 +43,6 @@ class Solver:
     @property
     def results(self) -> results: ...
     @property
-    def design(self) -> design: ...
-    @property
     def parametric_studies(self) -> parametric_studies: ...
     @property
     def current_parametric_study(self) -> current_parametric_study: ...

ansys/fluent/core/solver/settings_242/__init__.py

@@ -5,5 +5,5 @@
 """A package providing Fluent's Settings Objects in Python."""
 from ansys.fluent.core.solver.flobject import *
 
-SHASH = "4f612f8931d4279f86fcb3b9470af828a9f9e31358a1f6046103111c39317a61"
+SHASH = "ccbf753c171a9c821e25ce82ff606c956ad7d331c3464f80caaa8b9e97293886"
 from .root import root

ansys/fluent/core/solver/settings_242/ablation.py

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .enabled_16 import enabled as enabled_cls
+from .enabled_17 import enabled as enabled_cls
 class ablation(Group):
     """
     Enable/disable ablation model.

ansys/fluent/core/solver/settings_242/ablation_1.py

@@ -19,7 +19,7 @@ from .ablation_vielle_a import ablation_vielle_a as ablation_vielle_a_cls
 from .ablation_vielle_n import ablation_vielle_n as ablation_vielle_n_cls
 from .ablation_flux import ablation_flux as ablation_flux_cls
 from .ablation_surfacerxn_density import ablation_surfacerxn_density as ablation_surfacerxn_density_cls
-from .ablation_species_mf import ablation_species_mf as ablation_species_mf_cls
+from .species_mass_fractions_1 import species_mass_fractions as species_mass_fractions_cls
 class ablation(Group):
     """
     Help not available.
@@ -30,7 +30,7 @@ class ablation(Group):
     child_names = \
         ['ablation_select_model', 'ablation_vielle_a', 'ablation_vielle_n',
          'ablation_flux', 'ablation_surfacerxn_density',
-         'ablation_species_mf']
+         'species_mass_fractions']
 
     _child_classes = dict(
         ablation_select_model=ablation_select_model_cls,
@@ -38,6 +38,10 @@ class ablation(Group):
         ablation_vielle_n=ablation_vielle_n_cls,
         ablation_flux=ablation_flux_cls,
         ablation_surfacerxn_density=ablation_surfacerxn_density_cls,
-        ablation_species_mf=ablation_species_mf_cls,
+        species_mass_fractions=species_mass_fractions_cls,
+    )
+
+    _child_aliases = dict(
+        ablation_species_mf="species_mass_fractions",
     )
 

ansys/fluent/core/solver/settings_242/acoustic_wave_model.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class acoustic_wave_model(String, _HasAllowedValuesMixin):
+    """
+    Select acoustic wave model.
+    """
+
+    fluent_name = "acoustic-wave-model"
+

ansys/fluent/core/solver/settings_242/adaptive_time_stepping.py

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .enabled_39 import enabled as enabled_cls
+from .enabled_40 import enabled as enabled_cls
 from .user_defined_timestep import user_defined_timestep as user_defined_timestep_cls
 from .error_tolerance import error_tolerance as error_tolerance_cls
 from .time_end import time_end as time_end_cls

ansys/fluent/core/solver/settings_242/additional_temperature_intervals.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class additional_temperature_intervals(Integer):
     """
-    Temperature Classes.
+    Number of Temperature Classes.
     """
 
     fluent_name = "additional-temperature-intervals"

ansys/fluent/core/solver/settings_242/additional_velocity_intervals.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class additional_velocity_intervals(Integer):
     """
-    Velocity Classes.
+    Number of Velocity Classes.
     """
 
     fluent_name = "additional-velocity-intervals"

ansys/fluent/core/solver/settings_242/amplitude_1.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .option_13 import option as option_cls
+from .value_12 import value as value_cls
+from .profile_name import profile_name as profile_name_cls
+from .field_name import field_name as field_name_cls
+from .udf import udf as udf_cls
+class amplitude(Group):
+    """
+    Specify Amplitude of Periodic Displacement.
+    """
+
+    fluent_name = "amplitude"
+
+    child_names = \
+        ['option', 'value', 'profile_name', 'field_name', 'udf']
+
+    _child_classes = dict(
+        option=option_cls,
+        value=value_cls,
+        profile_name=profile_name_cls,
+        field_name=field_name_cls,
+        udf=udf_cls,
+    )
+
+    _child_aliases = dict(
+        constant="value",
+    )
+

ansys/fluent/core/solver/settings_242/angular_components_count.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class angular_components_count(Integer):
+    """
+    Specify Number of Angular components.
+    """
+
+    fluent_name = "angular-components-count"
+

ansys/fluent/core/solver/settings_242/angular_deviation.py

@@ -21,7 +21,7 @@ from .field_name import field_name as field_name_cls
 from .udf import udf as udf_cls
 class angular_deviation(Group):
     """
-    Angular Deviation.
+    Specify Angular Deviation.
     """
 
     fluent_name = "angular-deviation"

ansys/fluent/core/solver/settings_242/apply_precondition.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class apply_precondition(Boolean):
+    """
+    Apply preconditioning for adjoint calculation.
+    """
+
+    fluent_name = "apply-precondition"
+

ansys/fluent/core/solver/settings_242/auto_display_1.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class auto_display(Boolean):
+    """
+    Automatically updates the display as the design conditions are changed.
+    """
+
+    fluent_name = "auto-display"
+

ansys/fluent/core/solver/settings_242/autosave.py

@@ -15,7 +15,7 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .file_name_16 import file_name as file_name_cls
-from .frequency_4 import frequency as frequency_cls
+from .frequency_5 import frequency as frequency_cls
 from .max_files_1 import max_files as max_files_cls
 class autosave(Group):
     """

ansys/fluent/core/solver/settings_242/averaged_flow_specification_method.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class averaged_flow_specification_method(String, _HasAllowedValuesMixin):
     """
-    Averaged Flow Specification Method.
+    Select Averaged Flow Specification Method.
     """
 
     fluent_name = "averaged-flow-specification-method"

ansys/fluent/core/solver/settings_242/avg_flow_velocity.py

@@ -21,7 +21,7 @@ from .field_name import field_name as field_name_cls
 from .udf import udf as udf_cls
 class avg_flow_velocity(Group):
     """
-    Averaged Flow Velocity Magnitude.
+    Specify Averaged Flow Velocity Magnitude.
     """
 
     fluent_name = "avg-flow-velocity"

ansys/fluent/core/solver/settings_242/avg_method.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class avg_method(String, _HasAllowedValuesMixin):
+    """
+    Select Averaging Method.
+    """
+
+    fluent_name = "avg-method"
+

ansys/fluent/core/solver/settings_242/avg_pressure_spec.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class avg_pressure_spec(Boolean):
+    """
+    Set Average Pressure Specification on/off.
+    """
+
+    fluent_name = "avg-pressure-spec?"
+

ansys/fluent/core/solver/settings_242/backflow_dir_spec_method.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class backflow_dir_spec_method(String, _HasAllowedValuesMixin):
+    """
+    Select Backflow Direction Specification Method.
+    """
+
+    fluent_name = "backflow-dir-spec-method"
+

ansys/fluent/core/solver/settings_242/backflow_flame_area_density.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .option_13 import option as option_cls
+from .value_12 import value as value_cls
+from .profile_name import profile_name as profile_name_cls
+from .field_name import field_name as field_name_cls
+from .udf import udf as udf_cls
+class backflow_flame_area_density(Group):
+    """
+    Specify Flame Area Density.
+    """
+
+    fluent_name = "backflow-flame-area-density"
+
+    child_names = \
+        ['option', 'value', 'profile_name', 'field_name', 'udf']
+
+    _child_classes = dict(
+        option=option_cls,
+        value=value_cls,
+        profile_name=profile_name_cls,
+        field_name=field_name_cls,
+        udf=udf_cls,
+    )
+
+    _child_aliases = dict(
+        constant="value",
+    )
+

ansys/fluent/core/solver/settings_242/backflow_granular_temperature.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .option_13 import option as option_cls
+from .value_12 import value as value_cls
+from .profile_name import profile_name as profile_name_cls
+from .field_name import field_name as field_name_cls
+from .udf import udf as udf_cls
+class backflow_granular_temperature(Group):
+    """
+    Specify granular temperature.
+    """
+
+    fluent_name = "backflow-granular-temperature"
+
+    child_names = \
+        ['option', 'value', 'profile_name', 'field_name', 'udf']
+
+    _child_classes = dict(
+        option=option_cls,
+        value=value_cls,
+        profile_name=profile_name_cls,
+        field_name=field_name_cls,
+        udf=udf_cls,
+    )
+
+    _child_aliases = dict(
+        constant="value",
+    )
+

ansys/fluent/core/solver/settings_242/backflow_hydraulic_diameter.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class backflow_hydraulic_diameter(Real):
+    """
+    Specify Hydraulic Diameter.
+    """
+
+    fluent_name = "backflow-hydraulic-diameter"
+

ansys/fluent/core/solver/settings_242/backflow_inert_stream.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .option_13 import option as option_cls
+from .value_12 import value as value_cls
+from .profile_name import profile_name as profile_name_cls
+from .field_name import field_name as field_name_cls
+from .udf import udf as udf_cls
+class backflow_inert_stream(Group):
+    """
+    Specify Inert Stream.
+    """
+
+    fluent_name = "backflow-inert-stream"
+
+    child_names = \
+        ['option', 'value', 'profile_name', 'field_name', 'udf']
+
+    _child_classes = dict(
+        option=option_cls,
+        value=value_cls,
+        profile_name=profile_name_cls,
+        field_name=field_name_cls,
+        udf=udf_cls,
+    )
+
+    _child_aliases = dict(
+        constant="value",
+    )
+

ansys/fluent/core/solver/settings_242/backflow_interfacial_area_concentration.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .option_13 import option as option_cls
+from .value_12 import value as value_cls
+from .profile_name import profile_name as profile_name_cls
+from .field_name import field_name as field_name_cls
+from .udf import udf as udf_cls
+class backflow_interfacial_area_concentration(Group):
+    """
+    Specify interfacial area concentration.
+    """
+
+    fluent_name = "backflow-interfacial-area-concentration"
+
+    child_names = \
+        ['option', 'value', 'profile_name', 'field_name', 'udf']
+
+    _child_classes = dict(
+        option=option_cls,
+        value=value_cls,
+        profile_name=profile_name_cls,
+        field_name=field_name_cls,
+        udf=udf_cls,
+    )
+
+    _child_aliases = dict(
+        constant="value",
+    )
+