min_max_over_time_by_entity

class ansys.dpf.core.operators.min_max.min_max_over_time_by_entity.min_max_over_time_by_entity(fields_container=None, compute_amplitude=None, config=None, server=None)

Evaluates minimum, maximum over time/frequency and returns those min max as well as the time/freq where they occured

available inputs:
  • fields_container (FieldsContainer)

  • compute_amplitude (bool) (optional)

available outputs:
  • min (FieldsContainer)

  • max (FieldsContainer)

  • time_freq_of_min (FieldsContainer)

  • time_freq_of_max (FieldsContainer)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_compute_amplitude = bool()
>>> op.inputs.compute_amplitude.connect(my_compute_amplitude)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.min_max.min_max_over_time_by_entity(fields_container=my_fields_container,compute_amplitude=my_compute_amplitude)
>>> # Get output data
>>> result_min = op.outputs.min()
>>> result_max = op.outputs.max()
>>> result_time_freq_of_min = op.outputs.time_freq_of_min()
>>> result_time_freq_of_max = op.outputs.time_freq_of_max()
static default_config()

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters
  • name (str) – Name of the operator. For example ‘U’.

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

property inputs

Enables to connect inputs to the operator

Returns

inputs

Return type

InputsMinMaxOverTimeByEntity

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMinMaxOverTimeByEntity

property config

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns

config

Return type

Config

connect(pin, inpt, pin_out=0)

Connect an input on the operator using a pin number.

Parameters

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.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
array([[0.59428386, 0.00201751, 0.0006032 ]])
get_output(pin=0, output_type=None)

Returns the output of the operator on the pin number.

Parameters
  • pin (int, optional) – Number of the output pin.

  • output_type (core.type enum, optional) – The requested type of the output.

run()

Evaluate this operator

class ansys.dpf.core.operators.min_max.min_max_over_time_by_entity.InputsMinMaxOverTimeByEntity(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to connect user inputs to min_max_over_time_by_entity operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_compute_amplitude = bool()
>>> op.inputs.compute_amplitude.connect(my_compute_amplitude)
property fields_container

Allows to connect fields_container input to the operator

Parameters

my_fields_container (FieldsContainer,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> #or
>>> op.inputs.fields_container(my_fields_container)
property compute_amplitude

Allows to connect compute_amplitude input to the operator

  • pindoc: Do calculate amplitude.

Parameters

my_compute_amplitude (bool,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> op.inputs.compute_amplitude.connect(my_compute_amplitude)
>>> #or
>>> op.inputs.compute_amplitude(my_compute_amplitude)
connect(inpt)

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters

inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – input of the operator

class ansys.dpf.core.operators.min_max.min_max_over_time_by_entity.OutputsMinMaxOverTimeByEntity(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to get outputs from min_max_over_time_by_entity operator .. rubric:: Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Connect inputs : op.inputs. ...
>>> result_min = op.outputs.min()
>>> result_max = op.outputs.max()
>>> result_time_freq_of_min = op.outputs.time_freq_of_min()
>>> result_time_freq_of_max = op.outputs.time_freq_of_max()
property min

Allows to get min output of the operator

Returns

my_min

Return type

FieldsContainer,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Connect inputs : op.inputs. ...
>>> result_min = op.outputs.min()
property max

Allows to get max output of the operator

Returns

my_max

Return type

FieldsContainer,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Connect inputs : op.inputs. ...
>>> result_max = op.outputs.max()
property time_freq_of_min

Allows to get time_freq_of_min output of the operator

Returns

my_time_freq_of_min

Return type

FieldsContainer,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Connect inputs : op.inputs. ...
>>> result_time_freq_of_min = op.outputs.time_freq_of_min()
property time_freq_of_max

Allows to get time_freq_of_max output of the operator

Returns

my_time_freq_of_max

Return type

FieldsContainer,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_time_by_entity()
>>> # Connect inputs : op.inputs. ...
>>> result_time_freq_of_max = op.outputs.time_freq_of_max()