Operator Config

class ansys.dpf.core.config.Config(operator_name=None, config=None, server=None)

A class used to represent an operator’s configuration. With configurations the user can optionally choose how the operator will run. This is an advanced feature used for deep customization. The different options can change the way loops are done, it can change whether the operator needs to make check on the input or not…

property options

Returns a list of the different config options and their values

set_config_option(config_name, config_value)

Change the value of a config option

Parameters
  • config_name (str) – Name of the config option to change

  • config_value (bool, int, float) – The value to give to this config option

config_option_value(config_name)

Description of the given config_name and how it impacts the operator

Parameters

config_name (str) – Name of the config option to change

Returns

value

Return type

str

config_option_documentation(config_name)

Description of the given config_name and how it impacts the operator

Parameters

config_name (str) – Name of the config option to change

Returns

documentation

Return type

str

config_option_accepted_types(config_name)

Description of the given config_name and how it impacts the operator

Parameters

config_name (str) – Name of the config option to change

Returns

types

Return type

list str

config_option_default_value(config_name)

Description of the given config_name and how it impacts the operator

Parameters

config_name (str) – Name of the config option to change

Returns

default value

Return type

str

property available_config_options

Returns the list of available config options for this operator

Returns

types

Return type

list str