RuntimeCoreConfig

class ansys.dpf.core.runtime_config.RuntimeCoreConfig(data_tree, server=None)

Bases: _RuntimeConfig

Enables to access and set runtime configuration options to DataProcessingCore.

Parameters:

• data_tree (ctypes.cvoid_p) – DataTree pointer describing the existing parameters configuration of DataprocessingCore.

• server (BaseServer, optional) – Server with channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Notes

Available from 4.0 server version.

Examples

Get runtime configuration for DataProcessingCore.

>>> from ansys.dpf import core as dpf
>>> server = dpf.start_local_server(config=dpf.server_factory.AvailableServerConfigs.GrpcServer
...    , as_global=False) 
>>> core_config = dpf.settings.get_runtime_core_config(server=server) 
>>> num_threads = core_config.num_threads 
>>> core_config.num_threads = num_threads # or 3, 6, ... 

Overview

Properties

num_threads	Sets the default number of threads to use for all operators, default is omp_get_num_threads.
license_timeout_in_seconds	Sets the default number of threads to use for all operators, default is omp_get_num_threads.

Import detail

from ansys.dpf.core.runtime_config import RuntimeCoreConfig

Property detail

property RuntimeCoreConfig.num_threads

Sets the default number of threads to use for all operators, default is omp_get_num_threads.

Return type:

int

property RuntimeCoreConfig.license_timeout_in_seconds

Sets the default number of threads to use for all operators, default is omp_get_num_threads.

Return type:

float