include type stubs

Python/actuator_line/configActuatorLine.txt

@@ -32,7 +32,7 @@ QuadricLimiterD = 100000.0
 
 ##################################################
 readPrecursor = false
-nTimestepsReadPrecursor = 10
+nTimestepsReadPrecursor = 1
 precursorFile = precursor/Precursor
 
 ##################################################

pythonbindings/pyfluids-stubs/bindings/__init__.pyi

+class ostream_redirect:
+    def __init__(self, stdout: bool = ..., stderr: bool = ...) -> None: ...
+    def __enter__(self) -> None: ...
+    def __exit__(self, *args) -> None: ...

pythonbindings/pyfluids-stubs/bindings/basics/__init__.pyi

+from typing import ClassVar
+
+from typing import overload
+
+class ConfigurationFile:
+    def __init__(self) -> None: ...
+    def contains(self, key: str) -> bool: ...
+    @overload
+    def get_bool_value(self, key: str) -> bool: ...
+    @overload
+    def get_bool_value(self, key: str, default_value: bool) -> bool: ...
+    @overload
+    def get_double_value(self, key: str) -> float: ...
+    @overload
+    def get_double_value(self, key: str, default_value: float) -> float: ...
+    @overload
+    def get_float_value(self, key: str) -> float: ...
+    @overload
+    def get_float_value(self, key: str, default_value: float) -> float: ...
+    @overload
+    def get_int_value(self, key: str) -> int: ...
+    @overload
+    def get_int_value(self, key: str, default_value: int) -> int: ...
+    @overload
+    def get_string_value(self, key: str) -> str: ...
+    @overload
+    def get_string_value(self, key: str, default_value: str) -> str: ...
+    @overload
+    def get_uint_value(self, key: str) -> int: ...
+    @overload
+    def get_uint_value(self, key: str, default_value: int) -> int: ...
+    def load(self, file: str) -> bool: ...
+
+class LbmOrGks:
+    __members__: ClassVar[dict] = ...  # read-only
+    GKS: ClassVar[LbmOrGks] = ...
+    LBM: ClassVar[LbmOrGks] = ...
+    __entries: ClassVar[dict] = ...
+    def __init__(self, arg0: int) -> None: ...
+    def __eq__(self, arg0: object) -> bool: ...
+    def __getstate__(self) -> int: ...
+    def __hash__(self) -> int: ...
+    def __index__(self) -> int: ...
+    def __int__(self) -> int: ...
+    def __ne__(self, arg0: object) -> bool: ...
+    def __setstate__(self, arg0: int) -> None: ...
+    @property
+    def name(self) -> str: ...

pythonbindings/pyfluids-stubs/bindings/basics/logger.pyi

+from typing import Any, ClassVar
+
+log: None
+
+class Level:
+    __members__: ClassVar[dict] = ...  # read-only
+    INFO_HIGH: ClassVar[Level] = ...
+    INFO_INTERMEDIATE: ClassVar[Level] = ...
+    INFO_LOW: ClassVar[Level] = ...
+    LOGGER_ERROR: ClassVar[Level] = ...
+    WARNING: ClassVar[Level] = ...
+    __entries: ClassVar[dict] = ...
+    def __init__(self, arg0: int) -> None: ...
+    def __eq__(self, arg0: object) -> bool: ...
+    def __getstate__(self) -> int: ...
+    def __hash__(self) -> int: ...
+    def __index__(self) -> int: ...
+    def __int__(self) -> int: ...
+    def __ne__(self, arg0: object) -> bool: ...
+    def __setstate__(self, arg0: int) -> None: ...
+    @property
+    def name(self) -> str: ...
+
+class Logger:
+    def __init__(self, *args, **kwargs) -> None: ...
+    @staticmethod
+    def add_stdout() -> None: ...
+    @staticmethod
+    def enable_printed_rank_numbers() -> None: ...
+    @staticmethod
+    def set_debug_level(level: int) -> None: ...
+    @staticmethod
+    def time_stamp(time_stemp: TimeStamp) -> None: ...
+
+class TimeStamp:
+    __members__: ClassVar[dict] = ...  # read-only
+    DISABLE: ClassVar[TimeStamp] = ...
+    ENABLE: ClassVar[TimeStamp] = ...
+    __entries: ClassVar[dict] = ...
+    def __init__(self, arg0: int) -> None: ...
+    def __eq__(self, arg0: object) -> bool: ...
+    def __getstate__(self) -> int: ...
+    def __hash__(self) -> int: ...
+    def __index__(self) -> int: ...
+    def __int__(self) -> int: ...
+    def __ne__(self, arg0: object) -> bool: ...
+    def __setstate__(self, arg0: int) -> None: ...
+    @property
+    def name(self) -> str: ...

pythonbindings/pyfluids-stubs/bindings/gpu/grid_generator.pyi

+from typing import Any, List
+
+from typing import overload
+import pyfluids.bindings.basics
+import pyfluids.bindings.gpu
+
+class BoundingBox:
+    def __init__(self, min_x: float, max_x: float, min_y: float, max_y: float, min_z: float, max_z: float) -> None: ...
+
+class Conglomerate(Object):
+    def __init__(self, *args, **kwargs) -> None: ...
+    def add(self, object: Object) -> None: ...
+    @staticmethod
+    def make_shared() -> Conglomerate: ...
+    def subtract(self, object: Object) -> None: ...
+
+class Cuboid(Object):
+    def __init__(self, min_x1: float, min_x2: float, min_x3: float, max_x1: float, max_x2: float, max_x3: float) -> None: ...
+
+class GridBuilder:
+    def __init__(self, *args, **kwargs) -> None: ...
+    def get_number_of_grid_levels(self) -> int: ...
+
+class GridFactory:
+    def __init__(self, *args, **kwargs) -> None: ...
+    @staticmethod
+    def make() -> GridFactory: ...
+
+class LevelGridBuilder(GridBuilder):
+    def __init__(self, *args, **kwargs) -> None: ...
+    def set_no_slip_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType) -> None: ...
+    def set_periodic_boundary_condition(self, periodic_x: bool, periodic_y: bool, periodic_z: bool) -> None: ...
+    def set_precursor_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType, file_collection: pyfluids.bindings.gpu.VelocityFileCollection, n_t_read: int, velocity_x: float = ..., velocity_y: float = ..., velocity_z: float = ..., file_level_to_grid_level_map: List[int] = ...) -> None: ...
+    def set_pressure_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType, rho: float) -> None: ...
+    def set_slip_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType, normal_x: float, normal_y: float, normal_z: float) -> None: ...
+    def set_stress_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType, normal_x: float, normal_y: float, normal_z: float, sampling_offset: int, z0: float, dx: float) -> None: ...
+    def set_velocity_boundary_condition(self, side_type: pyfluids.bindings.gpu.SideType, vx: float, vy: float, vz: float) -> None: ...
+
+class MultipleGridBuilder(LevelGridBuilder):
+    def __init__(self, *args, **kwargs) -> None: ...
+    def add_coarse_grid(self, start_x: float, start_y: float, start_z: float, end_x: float, end_y: float, end_z: float, delta: float) -> None: ...
+    @overload
+    def add_geometry(self, solid_object: Object) -> None: ...
+    @overload
+    def add_geometry(self, solid_object: Object, level: int) -> None: ...
+    @overload
+    def add_grid(self, grid_shape: Object) -> None: ...
+    @overload
+    def add_grid(self, grid_shape: Object, level_fine: int) -> None: ...
+    def build_grids(self, lbm_or_gks: pyfluids.bindings.basics.LbmOrGks, enable_thin_walls: bool) -> None: ...
+    def get_number_of_levels(self) -> int: ...
+    @staticmethod
+    def make_shared(grid_factory: GridFactory) -> MultipleGridBuilder: ...
+
+class Object:
+    def __init__(self, *args, **kwargs) -> None: ...
+
+class Sphere(Object):
+    def __init__(self, *args, **kwargs) -> None: ...
+    @staticmethod
+    def make_shared() -> Sphere: ...
+
+class TriangularMesh(Object):
+    def __init__(self, *args, **kwargs) -> None: ...
+    @staticmethod
+    def make() -> TriangularMesh: ...

pythonbindings/pyfluids-stubs/bindings/gpu/probes.pyi

+from typing import ClassVar, List
+
+import pyfluids.bindings.gpu
+
+class PlanarAverageProbe(Probe):
+    def __init__(self, probe_name: str, output_path: str, t_start_avg: int, t_start_tmp_avg: int, t_avg: int, t_start_out: int, t_out: int, plane_normal: str) -> None: ...
+
+class PlaneProbe(Probe):
+    def __init__(self, probe_name: str, output_path: str, t_start_avg: int, t_avg: int, t_start_out: int, t_out: int) -> None: ...
+    def set_probe_plane(self, pos_x: float, pos_y: float, pos_z: float, delta_x: float, delta_y: float, delta_z: float) -> None: ...
+
+class PointProbe(Probe):
+    def __init__(self, probe_name: str, output_path: str, t_start_avg: int, t_avg: int, t_start_out: int, t_out: int, output_timeseries: bool) -> None: ...
+    def add_probe_points_from_list(self, point_coords_x: List[float], point_coords_y: List[float], point_coords_z: List[float]) -> None: ...
+    def add_probe_points_from_x_normal_plane(self, pos_x: float, pos0_y: float, pos0_z: float, pos1_y: float, pos1_z: float, n_y: int, n_z: int) -> None: ...
+
+class Probe(pyfluids.bindings.gpu.PreCollisionInteractor):
+    def __init__(self, *args, **kwargs) -> None: ...
+    def add_all_available_statistics(self) -> None: ...
+    def add_statistic(self, variable: Statistic) -> None: ...
+    def set_file_name_to_n_out(self) -> None: ...
+
+class Statistic:
+    __members__: ClassVar[dict] = ...  # read-only
+    Instantaneous: ClassVar[Statistic] = ...
+    Means: ClassVar[Statistic] = ...
+    SpatialCovariances: ClassVar[Statistic] = ...
+    SpatialFlatness: ClassVar[Statistic] = ...
+    SpatialMeans: ClassVar[Statistic] = ...
+    SpatialSkewness: ClassVar[Statistic] = ...
+    SpatioTemporalCovariances: ClassVar[Statistic] = ...
+    SpatioTemporalFlatness: ClassVar[Statistic] = ...
+    SpatioTemporalMeans: ClassVar[Statistic] = ...
+    SpatioTemporalSkewness: ClassVar[Statistic] = ...
+    Variances: ClassVar[Statistic] = ...
+    __entries: ClassVar[dict] = ...
+    def __init__(self, arg0: int) -> None: ...
+    def __eq__(self, arg0: object) -> bool: ...
+    def __getstate__(self) -> int: ...
+    def __hash__(self) -> int: ...
+    def __index__(self) -> int: ...
+    def __int__(self) -> int: ...
+    def __ne__(self, arg0: object) -> bool: ...
+    def __setstate__(self, arg0: int) -> None: ...
+    @property
+    def name(self) -> str: ...
+
+class WallModelProbe(Probe):
+    def __init__(self, probe_name: str, output_path: str, t_start_avg: int, t_start_tmp_avg: int, t_avg: int, t_start_out: int, t_out: int) -> None: ...
+    def set_evaluate_pressure_gradient(self, eval_press_grad: bool) -> None: ...
+    def set_force_output_to_stress(self, output_stress: bool) -> None: ...

pythonbindings/pyfluids-stubs/bindings/logger.pyi

+class Logger:
+    def __init__(self, *args, **kwargs) -> None: ...
+    def change_log_path(self) -> None: ...
+    def initialize_logger(self) -> None: ...
+
+def vf_log_critical(message: str) -> None: ...
+def vf_log_debug(message: str) -> None: ...
+def vf_log_info(message: str) -> None: ...
+def vf_log_trace(message: str) -> None: ...
+def vf_log_warning(message: str) -> None: ...