make_time_freq_support_chunk_for_each#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.utility.make_time_freq_support_chunk_for_each.make_time_freq_support_chunk_for_each(target_time_freq_support=None, operator_to_iterate=None, pin_index=None, abstract_meshed_region=None, chunk_config=None, producer_op11=None, producer_op12=None, output_pin_of_producer_op11=None, output_pin_of_producer_op12=None, input_pin_of_consumer_op11=None, input_pin_of_consumer_op12=None, consumer_op11=None, consumer_op12=None, config=None, server=None)#

Splits a time freq support into chunks depending on evaluated result properties,mesh or field size and max number of bytes accepted and calls ‘make_for_each_range’ to generate a range that can be consumed by the for_each operator

Parameters:

target_time_freq_support (TimeFreqSupport) – List of time freq support to potentially split in chunks.
operator_to_iterate (Operator) – Operator that must be reconnected with the range values.
pin_index (int) –
abstract_meshed_region (MeshedRegion or Field) – When a mesh is provided, the number of nodes (for “nodal” results) or number of elements (for “elemental” results) is used to compute the chunk. when a field is provided, its scoping size is used to compute the chunk.
chunk_config (DataTree) – A data tree with an int attribute “max_num_bytes”, an int attribute “dimensionality” (average result size by entity), a string attribute “location” (“nodal” or”elemental”) is expected.
producer_op11 (Operator) –
producer_op12 (Operator) –
output_pin_of_producer_op11 (int) –
output_pin_of_producer_op12 (int) –
input_pin_of_consumer_op11 (int) –
input_pin_of_consumer_op12 (int) –
consumer_op11 (Operator) –
consumer_op12 (Operator) –

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()

>>> # Make input connections
>>> my_target_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.target_time_freq_support.connect(my_target_time_freq_support)
>>> my_operator_to_iterate = dpf.Operator()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> my_pin_index = int()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> my_abstract_meshed_region = dpf.MeshedRegion()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> my_chunk_config = dpf.DataTree()
>>> op.inputs.chunk_config.connect(my_chunk_config)
>>> my_producer_op11 = dpf.Operator()
>>> op.inputs.producer_op11.connect(my_producer_op11)
>>> my_producer_op12 = dpf.Operator()
>>> op.inputs.producer_op12.connect(my_producer_op12)
>>> my_output_pin_of_producer_op11 = int()
>>> op.inputs.output_pin_of_producer_op11.connect(my_output_pin_of_producer_op11)
>>> my_output_pin_of_producer_op12 = int()
>>> op.inputs.output_pin_of_producer_op12.connect(my_output_pin_of_producer_op12)
>>> my_input_pin_of_consumer_op11 = int()
>>> op.inputs.input_pin_of_consumer_op11.connect(my_input_pin_of_consumer_op11)
>>> my_input_pin_of_consumer_op12 = int()
>>> op.inputs.input_pin_of_consumer_op12.connect(my_input_pin_of_consumer_op12)
>>> my_consumer_op11 = dpf.Operator()
>>> op.inputs.consumer_op11.connect(my_consumer_op11)
>>> my_consumer_op12 = dpf.Operator()
>>> op.inputs.consumer_op12.connect(my_consumer_op12)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each(
...     target_time_freq_support=my_target_time_freq_support,
...     operator_to_iterate=my_operator_to_iterate,
...     pin_index=my_pin_index,
...     abstract_meshed_region=my_abstract_meshed_region,
...     chunk_config=my_chunk_config,
...     producer_op11=my_producer_op11,
...     producer_op12=my_producer_op12,
...     output_pin_of_producer_op11=my_output_pin_of_producer_op11,
...     output_pin_of_producer_op12=my_output_pin_of_producer_op12,
...     input_pin_of_consumer_op11=my_input_pin_of_consumer_op11,
...     input_pin_of_consumer_op12=my_input_pin_of_consumer_op12,
...     consumer_op11=my_consumer_op11,
...     consumer_op12=my_consumer_op12,
... )

>>> # Get output data
>>> result_chunks = op.outputs.chunks()

static default_config(server=None)#

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:: server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

property inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsMakeTimeFreqSupportChunkForEach

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsMakeTimeFreqSupportChunkForEach

property config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:: Copy of the operator’s current configuration.
Return type:: ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – Operator, os.PathLike Object to connect to.
pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

connect_operator_as_input(pin, op)#: Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is 0. :type pin: int :type op: :param op: Requested type of the output. The default is None. :type op: ansys.dpf.core.dpf_operator.Operator

eval(pin=None)#

Evaluate this operator.

Parameters:: pin (int) – Number of the output pin. The default is None.
Returns:: output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.
Return type:: FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()

get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

pin (int, optional) – Number of the output pin. The default is 0.
output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

static operator_specification(op_name, server=None)#: Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties

property progress_bar: bool#: With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

run()#: Evaluate this operator.

property specification#

Returns the Specification (or documentation) of this Operator

Return type:: Specification

class ansys.dpf.core.operators.utility.make_time_freq_support_chunk_for_each.InputsMakeTimeFreqSupportChunkForEach(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to make_time_freq_support_chunk_for_each operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> my_target_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.target_time_freq_support.connect(my_target_time_freq_support)
>>> my_operator_to_iterate = dpf.Operator()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> my_pin_index = int()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> my_abstract_meshed_region = dpf.MeshedRegion()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> my_chunk_config = dpf.DataTree()
>>> op.inputs.chunk_config.connect(my_chunk_config)
>>> my_producer_op11 = dpf.Operator()
>>> op.inputs.producer_op11.connect(my_producer_op11)
>>> my_producer_op12 = dpf.Operator()
>>> op.inputs.producer_op12.connect(my_producer_op12)
>>> my_output_pin_of_producer_op11 = int()
>>> op.inputs.output_pin_of_producer_op11.connect(my_output_pin_of_producer_op11)
>>> my_output_pin_of_producer_op12 = int()
>>> op.inputs.output_pin_of_producer_op12.connect(my_output_pin_of_producer_op12)
>>> my_input_pin_of_consumer_op11 = int()
>>> op.inputs.input_pin_of_consumer_op11.connect(my_input_pin_of_consumer_op11)
>>> my_input_pin_of_consumer_op12 = int()
>>> op.inputs.input_pin_of_consumer_op12.connect(my_input_pin_of_consumer_op12)
>>> my_consumer_op11 = dpf.Operator()
>>> op.inputs.consumer_op11.connect(my_consumer_op11)
>>> my_consumer_op12 = dpf.Operator()
>>> op.inputs.consumer_op12.connect(my_consumer_op12)

property target_time_freq_support#

Allows to connect target_time_freq_support input to the operator.

List of time freq support to potentially split in chunks.

Parameters:: my_target_time_freq_support (TimeFreqSupport) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.target_time_freq_support.connect(my_target_time_freq_support)
>>> # or
>>> op.inputs.target_time_freq_support(my_target_time_freq_support)

property operator_to_iterate#

Allows to connect operator_to_iterate input to the operator.

Operator that must be reconnected with the range values.

Parameters:: my_operator_to_iterate (Operator) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> # or
>>> op.inputs.operator_to_iterate(my_operator_to_iterate)

property pin_index#

Allows to connect pin_index input to the operator.

Parameters:: my_pin_index (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> # or
>>> op.inputs.pin_index(my_pin_index)

property abstract_meshed_region#

Allows to connect abstract_meshed_region input to the operator.

When a mesh is provided, the number of nodes (for “nodal” results) or number of elements (for “elemental” results) is used to compute the chunk. when a field is provided, its scoping size is used to compute the chunk.

Parameters:: my_abstract_meshed_region (MeshedRegion or Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> # or
>>> op.inputs.abstract_meshed_region(my_abstract_meshed_region)

property chunk_config#

Allows to connect chunk_config input to the operator.

A data tree with an int attribute “max_num_bytes”, an int attribute “dimensionality” (average result size by entity), a string attribute “location” (“nodal” or”elemental”) is expected.

Parameters:: my_chunk_config (DataTree) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.chunk_config.connect(my_chunk_config)
>>> # or
>>> op.inputs.chunk_config(my_chunk_config)

property producer_op11#

Allows to connect producer_op11 input to the operator.

Parameters:: my_producer_op11 (Operator) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.producer_op11.connect(my_producer_op11)
>>> # or
>>> op.inputs.producer_op11(my_producer_op11)

property producer_op12#

Allows to connect producer_op12 input to the operator.

Parameters:: my_producer_op12 (Operator) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.producer_op12.connect(my_producer_op12)
>>> # or
>>> op.inputs.producer_op12(my_producer_op12)

property output_pin_of_producer_op11#

Allows to connect output_pin_of_producer_op11 input to the operator.

Parameters:: my_output_pin_of_producer_op11 (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.output_pin_of_producer_op11.connect(my_output_pin_of_producer_op11)
>>> # or
>>> op.inputs.output_pin_of_producer_op11(my_output_pin_of_producer_op11)

property output_pin_of_producer_op12#

Allows to connect output_pin_of_producer_op12 input to the operator.

Parameters:: my_output_pin_of_producer_op12 (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.output_pin_of_producer_op12.connect(my_output_pin_of_producer_op12)
>>> # or
>>> op.inputs.output_pin_of_producer_op12(my_output_pin_of_producer_op12)

property input_pin_of_consumer_op11#

Allows to connect input_pin_of_consumer_op11 input to the operator.

Parameters:: my_input_pin_of_consumer_op11 (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.input_pin_of_consumer_op11.connect(my_input_pin_of_consumer_op11)
>>> # or
>>> op.inputs.input_pin_of_consumer_op11(my_input_pin_of_consumer_op11)

property input_pin_of_consumer_op12#

Allows to connect input_pin_of_consumer_op12 input to the operator.

Parameters:: my_input_pin_of_consumer_op12 (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.input_pin_of_consumer_op12.connect(my_input_pin_of_consumer_op12)
>>> # or
>>> op.inputs.input_pin_of_consumer_op12(my_input_pin_of_consumer_op12)

property consumer_op11#

Allows to connect consumer_op11 input to the operator.

Parameters:: my_consumer_op11 (Operator) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.consumer_op11.connect(my_consumer_op11)
>>> # or
>>> op.inputs.consumer_op11(my_consumer_op11)

property consumer_op12#

Allows to connect consumer_op12 input to the operator.

Parameters:: my_consumer_op12 (Operator) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> op.inputs.consumer_op12.connect(my_consumer_op12)
>>> # or
>>> op.inputs.consumer_op12(my_consumer_op12)

connect(inpt)#

Connect any input (an entity or an operator output) to any input pin of this operator. Searches for the input type corresponding to the output.

Parameters:

inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.

class ansys.dpf.core.operators.utility.make_time_freq_support_chunk_for_each.OutputsMakeTimeFreqSupportChunkForEach(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from make_time_freq_support_chunk_for_each operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> # Connect inputs : op.inputs. ...
>>> result_chunks = op.outputs.chunks()

property chunks#

Allows to get chunks output of the operator

Return type:: my_chunks

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_time_freq_support_chunk_for_each()
>>> # Connect inputs : op.inputs. ...
>>> result_chunks = op.outputs.chunks()