ansys-api-fluent 0.3.38__tar.gz

ansys_api_fluent-0.3.38/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys_api_fluent-0.3.38/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: ansys-api-fluent
+Version: 0.3.38
+Summary: Autogenerated python gRPC interface package for ansys-api-fluent, built on 10:47:33 on 16 February 2026
+Author: ANSYS, Inc.
+Author-email: support@ansys.com
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio~=1.30
+Requires-Dist: protobuf<7,>=3.19
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+### ansys-api-fluent gRPC Interface Package
+
+This Python package contains the auto-generated gRPC Python interface files for
+Fluent.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-fluent
+```
+
+Otherwise, see the
+
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.
+
+Note that the interface files are identical regardless of the version of Python
+used to generate them, but the last pre-built wheel for ``grpcio~=1.30`` was
+Python 3.7, so to improve your build time, use Python 3.7 when building the
+wheel.
+
+
+#### Manual Deployment
+
+After building the packages, manually deploy them with:
+
+```
+pip install twine
+twine upload dist/*
+```
+
+Note that this is automatically done through CI/CD.
+
+
+#### Automatic Deployment
+
+This repository contains GitHub CI/CD that enables the automatic building of
+source and wheel packages for these gRPC Python interface files. By default,
+these are built on PRs, the main branch, and on tags when pushing. Artifacts
+are uploaded for each PR.
+
+To publicly release wheels to PyPI, ensure your branch is up-to-date and then
+push tags. For example, for the version ``v0.5.0``.
+
+```bash
+git tag v0.5.0
+git push --tags
+```

ansys_api_fluent-0.3.38/README.md

@@ -0,0 +1,63 @@
+### ansys-api-fluent gRPC Interface Package
+
+This Python package contains the auto-generated gRPC Python interface files for
+Fluent.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-fluent
+```
+
+Otherwise, see the
+
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.
+
+Note that the interface files are identical regardless of the version of Python
+used to generate them, but the last pre-built wheel for ``grpcio~=1.30`` was
+Python 3.7, so to improve your build time, use Python 3.7 when building the
+wheel.
+
+
+#### Manual Deployment
+
+After building the packages, manually deploy them with:
+
+```
+pip install twine
+twine upload dist/*
+```
+
+Note that this is automatically done through CI/CD.
+
+
+#### Automatic Deployment
+
+This repository contains GitHub CI/CD that enables the automatic building of
+source and wheel packages for these gRPC Python interface files. By default,
+these are built on PRs, the main branch, and on tags when pushing. Artifacts
+are uploaded for each PR.
+
+To publicly release wheels to PyPI, ensure your branch is up-to-date and then
+push tags. For example, for the version ``v0.5.0``.
+
+```bash
+git tag v0.5.0
+git push --tags
+```

ansys_api_fluent-0.3.38/ansys/api/fluent/__init__.py

@@ -0,0 +1,6 @@
+"""Autogenerated Python gRPC interface package for ansys-api-fluent."""
+
+from ansys.api.fluent._version import __version__ as version  # noqa: F401
+
+
+__version__ = version

ansys_api_fluent-0.3.38/ansys/api/fluent/_version.py

@@ -0,0 +1,3 @@
+"""Version of ansys-api-fluent module."""
+
+__version__ = "0.3.38"

ansys_api_fluent-0.3.38/ansys/api/fluent/v0/Connection.proto

@@ -0,0 +1,32 @@
+//
+// Copyright 1987-2022 ANSYS, Inc. All Rights Reserved.
+//
+
+syntax = "proto3";
+
+package ansys.api.fluent.v0;
+
+service Connection {
+  rpc Connect(ConnectRequest) returns (stream ConnectResponse) {}
+}
+enum ConnectionError {
+  NoError = 0;
+  PasswordMismatch = 1;
+  MaxConnectionsCountExceeded = 2;
+  UnknownError = 3;
+  VersionMismatch = 4;
+  WaitTimeExpired = 5;
+}
+message ConnectRequest {
+  enum RequestType {
+    CONNECT = 0;
+    PAUSE = 1;
+  }
+  RequestType requesttype = 1;
+  string password = 2;
+  string version = 3;
+}
+
+message ConnectResponse {
+  ConnectionError errorcode = 1;
+}

ansys_api_fluent-0.3.38/ansys/api/fluent/v0/app_utilities.proto

@@ -0,0 +1,249 @@
+// Miscellaneous utilities for solver apps which do not fit into any other category.
+
+syntax = "proto3";
+
+package ansys.api.fluent.v0.app_utilities;
+
+service AppUtilities {
+  /* Get product version */
+  rpc GetProductVersion(GetProductVersionRequest) returns (GetProductVersionResponse);
+
+  /* Get build information */
+  rpc GetBuildInfo(GetBuildInfoRequest) returns (GetBuildInfoResponse);
+
+  /**
+   * Get Controller process information if the solver app is running in client-server mode,
+   * Controller process commanding the Solver process.
+   */
+  rpc GetControllerProcessInfo(GetControllerProcessInfoRequest) returns (GetControllerProcessInfoResponse);
+
+  /* Get Solver process information */
+  rpc GetSolverProcessInfo(GetSolverProcessInfoRequest) returns (GetSolverProcessInfoResponse);
+
+  /* Get App mode */
+  rpc GetAppMode(GetAppModeRequest) returns (GetAppModeResponse);
+
+  /* Start Python journal */
+  rpc StartPythonJournal(StartPythonJournalRequest) returns (StartPythonJournalResponse);
+
+  /* Stop Python journal */
+  rpc StopPythonJournal(StopPythonJournalRequest) returns (StopPythonJournalResponse);
+
+  /* Is beta feature enabled? */
+  rpc IsBetaEnabled(IsBetaEnabledRequest) returns (IsBetaEnabledResponse);
+
+  /* Enable beta features */
+  rpc EnableBeta(EnableBetaRequest) returns (EnableBetaResponse);
+
+  /* Is wildcard as per the solver app's syntax? */
+  rpc IsWildcard(IsWildcardRequest) returns (IsWildcardResponse);
+
+  /* Is solution data available? */
+  rpc IsSolutionDataAvailable(IsSolutionDataAvailableRequest) returns (IsSolutionDataAvailableResponse);
+
+  /**
+   * Following 3 methods are useful to execute synchronous callbacks in gRPC client on solution events
+   * such as iteration or time-step advancement. An implementation of such mechanism will look like:
+   * 1. After each solution event, the solver will send a paused event to clients and pause itself.
+   * 2. The registered client will receive the paused event and execute the callback and then resume the solver.
+   *
+   * Register to pause on solution events.
+   */
+  rpc RegisterPauseOnSolutionEvents(RegisterPauseOnSolutionEventsRequest) returns (RegisterPauseOnSolutionEventsResponse);
+
+  /* Resume from pause on a solution event */
+  rpc ResumeOnSolutionEvent(ResumeOnSolutionEventRequest) returns (ResumeOnSolutionEventResponse);
+
+  /* Unregister to pause on solution events */
+  rpc UnregisterPauseOnSolutionEvents(UnregisterPauseOnSolutionEventsRequest) returns (UnregisterPauseOnSolutionEventsResponse);
+
+  /* Exit the solver app */
+  rpc Exit(ExitRequest) returns (ExitResponse);
+
+  /* Change cortex working directory */
+  rpc SetWorkingDirectory(SetWorkingDirectoryRequest) returns (SetWorkingDirectoryResponse);
+}
+
+message GetProductVersionRequest {
+}
+
+message GetProductVersionResponse {
+  /* Major version */
+  int64 major = 1;
+  /* Minor version */
+  int64 minor = 2;
+  /* Patch version */
+  int64 patch = 3;
+}
+
+message GetBuildInfoRequest {
+}
+
+message GetBuildInfoResponse {
+  /* Build time */
+  string build_time = 1;
+  /* Build id */
+  int64 build_id = 2;
+  /* VCS revision */
+  string vcs_revision = 3;
+  /* VCS branch */
+  string vcs_branch = 4;
+}
+
+message GetControllerProcessInfoRequest {
+}
+
+message GetControllerProcessInfoResponse {
+  /* Controller hostname */
+  string hostname = 1;
+  /* Controller process id */
+  int64 process_id = 2;
+  /* Controller working directory */
+  string working_directory = 3;
+}
+
+message GetSolverProcessInfoRequest {
+}
+
+message GetSolverProcessInfoResponse {
+  /* Solver hostname */
+  string hostname = 1;
+  /* Solver process id */
+  int64 process_id = 2;
+  /* Solver working directory */
+  string working_directory = 3;
+}
+
+message GetAppModeRequest {
+}
+
+message GetAppModeResponse {
+  /* App mode */
+  AppMode app_mode = 1;
+}
+
+message StartPythonJournalRequest {
+  /**
+   * Journal file name
+   * If journal_name is not provided, StopPythonJournal should return the journal lines.
+   */
+  optional string journal_name = 1;
+}
+
+message StartPythonJournalResponse {
+  /**
+   * Journal id
+   * Journal id is returned if journal_name is not provided.
+   */
+  optional string journal_id = 1;
+}
+
+message StopPythonJournalRequest {
+  /**
+   * Journal id
+   * Journal id is required if journal_name is not provided in StartPythonJournal.
+   */
+  optional string journal_id = 1;
+}
+
+message StopPythonJournalResponse {
+  /**
+   * Journal string
+   * Journal string is returned if journal_name is not provided in StartPythonJournal.
+   */
+  string journal_str = 1;
+}
+
+message IsBetaEnabledRequest {
+}
+
+message IsBetaEnabledResponse {
+  /* Is beta feature enabled */
+  bool is_beta_enabled = 1;
+}
+
+message EnableBetaRequest {
+}
+
+message EnableBetaResponse {
+}
+
+message IsWildcardRequest {
+  /* String to check if it is a wildcard */
+  string input = 1;
+}
+
+message IsWildcardResponse {
+  /* Is wildcard */
+  bool is_wildcard = 1;
+}
+
+message IsSolutionDataAvailableRequest {
+}
+
+message IsSolutionDataAvailableResponse {
+  /* Is solution data available */
+  bool is_solution_data_available = 1;
+}
+
+message RegisterPauseOnSolutionEventsRequest {
+  /* Solution event */
+  SolutionEvent solution_event = 1;
+}
+
+message RegisterPauseOnSolutionEventsResponse {
+  /* Registration id */
+  int64 registration_id = 1;
+}
+
+message ResumeOnSolutionEventRequest {
+  /* Registration id */
+  int64 registration_id = 1;
+}
+
+message ResumeOnSolutionEventResponse {
+}
+
+message UnregisterPauseOnSolutionEventsRequest {
+  /* Registration id */
+  int64 registration_id = 1;
+}
+
+message UnregisterPauseOnSolutionEventsResponse {
+}
+
+message ExitRequest {
+}
+
+message ExitResponse {
+}
+
+message SetWorkingDirectoryRequest {
+  /* New directory path */
+  string path = 1;
+}
+
+message SetWorkingDirectoryResponse {
+}
+
+enum AppMode {
+  /* App mode unknown */
+  APP_MODE_UNKNOWN = 0;
+  /* App mode meshing */
+  APP_MODE_MESHING = 1;
+  /* App mode solver */
+  APP_MODE_SOLVER = 2;
+  /* App mode icing */
+  APP_MODE_SOLVER_ICING = 3;
+  /* App mode aero */
+  APP_MODE_SOLVER_AERO = 4;
+}
+
+enum SolutionEvent {
+  /* Solution event unknown */
+  SOLUTION_EVENT_UNKNOWN = 0;
+  /* Solution event iteration */
+  SOLUTION_EVENT_ITERATION = 1;
+  /* Solution event time step */
+  SOLUTION_EVENT_TIME_STEP = 2;
+}

ansys_api_fluent-0.3.38/ansys/api/fluent/v0/batch_ops.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package ansys.api.fluent.v0;
+
+service BatchOps {
+  rpc Execute(stream ExecuteRequest) returns (stream ExecuteResponse);
+}
+
+message ExecuteRequest {
+  string package = 1;
+  string service = 2;
+  string method = 3;
+  bytes request_body = 4;
+}
+
+enum ExecuteStatus {
+  STATUS_UNSPECIFIED = 0;
+  STATUS_UNKNOWN = 1;      // package, service or method is not known
+  STATUS_UNSUPPORTED = 2;  // method is not grpc-unary
+  STATUS_SUCCESSFUL = 3;
+  STATUS_FAILED = 4;
+  STATUS_CANCELLED = 5;  // one of the previous operations is not successful
+}
+
+message ExecuteResponse {
+  ExecuteStatus status = 1;
+  bytes response_body = 2;
+}

ansys_api_fluent-0.3.38/ansys/api/fluent/v0/common.proto

@@ -0,0 +1,10 @@
+//
+// Copyright 1987-2022 ANSYS, Inc. All Rights Reserved.
+//
+
+syntax = "proto3";
+
+package grpcRemoting;
+
+message Empty {
+}

ansys_api_fluent-0.3.38/ansys/api/fluent/v0/common_api.proto

@@ -0,0 +1,13 @@
+//
+// Copyright 1987-2023 ANSYS, Inc. All Rights Reserved.
+//
+
+syntax = "proto3";
+
+package ansys.api.fluent.v0;
+
+message Point {
+  double x = 1;
+  double y = 2;
+  double z = 3;
+}