module_config#

Configuration variables for PyFluent.

Classes:

Config()

Set the global configuration variables for PyFluent.

Data:

config

Global configuration object for PyFluent

class ansys.fluent.core.module_config.Config#

Bases: object

Set the global configuration variables for PyFluent.

Methods:

`__init__`()	__init__ method of Config class.
`print`()	Print all configuration variables.

Attributes:

`check_health`	Whether to skip health check, defaults to True.
`check_health_timeout`	Health check timeout in seconds, defaults to 60 seconds.
`clear_fluent_para_envs`	Whether to clear environment variables related to Fluent parallel mode, defaults to False.
`codegen_outdir`	Directory where API files are written out during codegen.
`codegen_skip_builtin_settings`	Whether to skip code generation of built-in settings, defaults to the value of `PYFLUENT_CODEGEN_SKIP_BUILTIN_SETTINGS` environment variable.
`container_mount_source`	Host path which is mounted to the container, defaults to the value of `PYFLUENT_CONTAINER_MOUNT_SOURCE` environment variable.
`container_mount_target`	Path inside the container where the host path is mounted, defaults to "/home/container/workdir".
`datamodel_return_state_changes`	Whether to return the state changes on mutating datamodel RPCs, defaults to True.
`datamodel_use_attr_cache`	Whether to use datamodel attribute caching, defaults to True.
`datamodel_use_nocommands_diff_state`	Whether to stream and cache commands state, defaults to True.
`datamodel_use_state_cache`	Whether to use datamodel state caching, defaults to True.
`disable_monitor_refresh_on_init`	Whether to disable monitor refresh on solution initialization, defaults to False.
`disable_parameter_list_return_fix`	Whether to disable the fix for returning parameter lists via settings API, defaults to the value of `PYFLUENT_NO_FIX_PARAMETER_LIST_RETURN` environment variable.
`examples_path`	Directory where example files are downloaded.
`fluent_automatic_transcript`	Whether to write the automatic transcript in Fluent, defaults to True if `PYFLUENT_SKIP_FLUENT_AUTOMATIC_TRANSCRIPT` environment variable is not set to "1".
`fluent_container_name`	The name of the Fluent container to use when launching in a container, defaults to the value of `FLUENT_CONTAINER_NAME` environment variable.
`fluent_debug`	Whether to launch Fluent in debug mode, defaults to the value of `PYFLUENT_FLUENT_DEBUG` environment variable.
`fluent_dev_version`	The latest development version of Fluent.
`fluent_image_name`	The name of the Fluent image to use when launching in a container, defaults to the value of `FLUENT_IMAGE_NAME` environment variable.
`fluent_image_tag`	The tag of the Fluent image to use when launching in a container, defaults to the value of `FLUENT_IMAGE_TAG` environment variable or the latest release version of Fluent.
`fluent_release_version`	The latest released version of Fluent.
`fluent_server_info_dir`	The directory where server info will be written from Fluent, defaults to the value of `SERVER_INFO_DIR` environment variable.
`fluent_show_mesh_after_case_read`	Whether to show mesh in Fluent after case read, defaults to False.
`force_exit_timeout`	The timeout in seconds to wait for Fluent to exit, defaults to the value of `PYFLUENT_FORCE_EXIT_TIMEOUT` environment variable.
`grpc_log_bytes_limit`	The maximum number of bytes to log in gRPC logs, defaults to the value of `PYFLUENT_GRPC_LOG_BYTES_LIMIT` environment variable or 1000 bytes.
`hide_log_secrets`	Whether to hide sensitive information in logs, defaults to the value of `PYFLUENT_HIDE_LOG_SECRETS` environment variable.
`infer_remoting_ip`	Set this to False to stop automatically inferring and setting REMOTING_SERVER_ADDRESS, defaults to True.
`launch_fluent_container`	Whether to launch Fluent in a container, defaults to the value of `PYFLUENT_LAUNCH_CONTAINER` environment variable.
`launch_fluent_ip`	Set the IP address of the Fluent server while launching Fluent, defaults to the value of `PYFLUENT_FLUENT_IP` environment variable.
`launch_fluent_port`	Set the port of the Fluent server while launching Fluent, defaults to the value of `PYFLUENT_FLUENT_PORT` environment variable.
`launch_fluent_skip_password_check`	Skip password check during RPC execution when Fluent is launched from PyFluent, defaults to False.
`launch_fluent_stderr`	Set stderr of the launched Fluent process.
`launch_fluent_stdout`	Set stdout of the launched Fluent process.
`launch_fluent_timeout`	The timeout in seconds to wait for Fluent to launch, defaults to the value of `PYFLUENT_LAUNCH_FLUENT_TIMEOUT` environment variable or 60 seconds.
`logging_level_default`	The default logging level for PyFluent, defaults to the value of `PYFLUENT_LOGGING` environment variable.
`print_search_results`	Whether to print search results, defaults to True.
`remoting_server_address`	The remoting server address to be used in Fluent, defaults to the value of `REMOTING_SERVER_ADDRESS` environment variable.
`show_fluent_gui`	Whether to show the Fluent GUI when launching the server, defaults to the value of `PYFLUENT_SHOW_SERVER_GUI` environment variable.
`skip_api_upgrade_advice`	Whether to skip API upgrade advice, defaults to the value of `PYFLUENT_SKIP_API_UPGRADE_ADVICE` environment variable.
`start_watchdog`	Whether to start watchdog.
`support_solver_interrupt`	Whether to interrupt Fluent solver from PyFluent, defaults to False.
`test_name`	Current unit test name, defaults to the value of `PYFLUENT_TEST_NAME` environment variable.
`use_docker_compose`	Whether to use Docker Compose for launching Fluent in a container, defaults to the value of `PYFLUENT_USE_DOCKER_COMPOSE` environment variable.
`use_file_transfer_service`	Whether to use remote gRPC file transfer service, defaults to False.
`use_podman_compose`	Whether to use Podman Compose for launching Fluent in a container, defaults to the value of `PYFLUENT_USE_PODMAN_COMPOSE` environment variable.
`use_runtime_python_classes`	Whether to use runtime Python classes for settings, defaults to the value of `PYFLUENT_USE_RUNTIME_PYTHON_CLASSES` environment variable.
`watchdog_debug`	Whether to enable debug logging for the watchdog, defaults to the value of `PYFLUENT_WATCHDOG_DEBUG` environment variable.
`watchdog_exception_on_error`	Whether to raise an exception when the watchdog encounters an error, defaults to the value of `PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR` environment variable.

__init__()#: __init__ method of Config class.

check_health#: Whether to skip health check, defaults to True.

check_health_timeout#: Health check timeout in seconds, defaults to 60 seconds.

clear_fluent_para_envs#: Whether to clear environment variables related to Fluent parallel mode, defaults to False.

codegen_outdir#: Directory where API files are written out during codegen.

codegen_skip_builtin_settings#: Whether to skip code generation of built-in settings, defaults to the value of PYFLUENT_CODEGEN_SKIP_BUILTIN_SETTINGS environment variable.

container_mount_source#: Host path which is mounted to the container, defaults to the value of PYFLUENT_CONTAINER_MOUNT_SOURCE environment variable.

container_mount_target#: Path inside the container where the host path is mounted, defaults to “/home/container/workdir”.

datamodel_return_state_changes#: Whether to return the state changes on mutating datamodel RPCs, defaults to True.

datamodel_use_attr_cache#: Whether to use datamodel attribute caching, defaults to True.

datamodel_use_nocommands_diff_state#: Whether to stream and cache commands state, defaults to True.

datamodel_use_state_cache#: Whether to use datamodel state caching, defaults to True.

disable_monitor_refresh_on_init#: Whether to disable monitor refresh on solution initialization, defaults to False.

disable_parameter_list_return_fix#: Whether to disable the fix for returning parameter lists via settings API, defaults to the value of PYFLUENT_NO_FIX_PARAMETER_LIST_RETURN environment variable.

examples_path#: Directory where example files are downloaded.

fluent_automatic_transcript#: Whether to write the automatic transcript in Fluent, defaults to True if PYFLUENT_SKIP_FLUENT_AUTOMATIC_TRANSCRIPT environment variable is not set to “1”.

fluent_container_name#: The name of the Fluent container to use when launching in a container, defaults to the value of FLUENT_CONTAINER_NAME environment variable.

fluent_debug#: Whether to launch Fluent in debug mode, defaults to the value of PYFLUENT_FLUENT_DEBUG environment variable.

property fluent_dev_version: str#: The latest development version of Fluent.

fluent_image_name#: The name of the Fluent image to use when launching in a container, defaults to the value of FLUENT_IMAGE_NAME environment variable.

fluent_image_tag#: The tag of the Fluent image to use when launching in a container, defaults to the value of FLUENT_IMAGE_TAG environment variable or the latest release version of Fluent.

property fluent_release_version: str#: The latest released version of Fluent.

fluent_server_info_dir#: The directory where server info will be written from Fluent, defaults to the value of SERVER_INFO_DIR environment variable.

fluent_show_mesh_after_case_read#: Whether to show mesh in Fluent after case read, defaults to False.

force_exit_timeout#: The timeout in seconds to wait for Fluent to exit, defaults to the value of PYFLUENT_FORCE_EXIT_TIMEOUT environment variable.

grpc_log_bytes_limit#: The maximum number of bytes to log in gRPC logs, defaults to the value of PYFLUENT_GRPC_LOG_BYTES_LIMIT environment variable or 1000 bytes.

hide_log_secrets#: Whether to hide sensitive information in logs, defaults to the value of PYFLUENT_HIDE_LOG_SECRETS environment variable.

infer_remoting_ip#: Set this to False to stop automatically inferring and setting REMOTING_SERVER_ADDRESS, defaults to True.

infer_remoting_ip_timeout_per_ip#: Descriptor for managing configuration attributes.

launch_fluent_container#: Whether to launch Fluent in a container, defaults to the value of PYFLUENT_LAUNCH_CONTAINER environment variable.

launch_fluent_ip#: Set the IP address of the Fluent server while launching Fluent, defaults to the value of PYFLUENT_FLUENT_IP environment variable.

launch_fluent_port#: Set the port of the Fluent server while launching Fluent, defaults to the value of PYFLUENT_FLUENT_PORT environment variable.

launch_fluent_skip_password_check#: Skip password check during RPC execution when Fluent is launched from PyFluent, defaults to False.

launch_fluent_stderr#: Set stderr of the launched Fluent process. Valid values are the same as subprocess.Popen’s stderr argument.

launch_fluent_stdout#: Set stdout of the launched Fluent process. Valid values are the same as subprocess.Popen’s stdout argument.

launch_fluent_timeout#: The timeout in seconds to wait for Fluent to launch, defaults to the value of PYFLUENT_LAUNCH_FLUENT_TIMEOUT environment variable or 60 seconds.

logging_level_default#: The default logging level for PyFluent, defaults to the value of PYFLUENT_LOGGING environment variable.

print()#: Print all configuration variables.

print_search_results#: Whether to print search results, defaults to True.

remoting_server_address#: The remoting server address to be used in Fluent, defaults to the value of REMOTING_SERVER_ADDRESS environment variable.

show_fluent_gui#: Whether to show the Fluent GUI when launching the server, defaults to the value of PYFLUENT_SHOW_SERVER_GUI environment variable.

skip_api_upgrade_advice#: Whether to skip API upgrade advice, defaults to the value of PYFLUENT_SKIP_API_UPGRADE_ADVICE environment variable.

start_watchdog#: Whether to start watchdog.

support_solver_interrupt#: Whether to interrupt Fluent solver from PyFluent, defaults to False.

test_name#: Current unit test name, defaults to the value of PYFLUENT_TEST_NAME environment variable.

use_docker_compose#: Whether to use Docker Compose for launching Fluent in a container, defaults to the value of PYFLUENT_USE_DOCKER_COMPOSE environment variable.

use_file_transfer_service#: Whether to use remote gRPC file transfer service, defaults to False.

use_podman_compose#: Whether to use Podman Compose for launching Fluent in a container, defaults to the value of PYFLUENT_USE_PODMAN_COMPOSE environment variable.

use_runtime_python_classes#: Whether to use runtime Python classes for settings, defaults to the value of PYFLUENT_USE_RUNTIME_PYTHON_CLASSES environment variable.

watchdog_debug#: Whether to enable debug logging for the watchdog, defaults to the value of PYFLUENT_WATCHDOG_DEBUG environment variable.

watchdog_exception_on_error#: Whether to raise an exception when the watchdog encounters an error, defaults to the value of PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR environment variable.

ansys.fluent.core.module_config.config = <ansys.fluent.core.module_config.Config object>#: Global configuration object for PyFluent