fft_multi_harmonic_minmax#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.math.fft_multi_harmonic_minmax.fft_multi_harmonic_minmax(fields_container=None, rpm_scoping=None, fs_ratio=None, num_subdivisions=None, max_num_subdivisions=None, config=None, server=None)#

Evaluate min max fields on multi harmonic solution. min and max fields are calculated based on evaluating a fft wrt rpms and using the gradient method for adaptive time steping

Parameters

fields_container (FieldsContainer) –
rpm_scoping (Scoping, optional) – Rpm scoping, by default the fft is evaluted using all the rpms
fs_ratio (int, optional) – Field or fields container with only one field is expected
num_subdivisions (int, optional) – Connect number subdivisions, used for uniform discretization
max_num_subdivisions (int, optional) – Connect max number subdivisions, used to avoid huge number of sudivisions

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()

>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_rpm_scoping = dpf.Scoping()
>>> op.inputs.rpm_scoping.connect(my_rpm_scoping)
>>> my_fs_ratio = int()
>>> op.inputs.fs_ratio.connect(my_fs_ratio)
>>> my_num_subdivisions = int()
>>> op.inputs.num_subdivisions.connect(my_num_subdivisions)
>>> my_max_num_subdivisions = int()
>>> op.inputs.max_num_subdivisions.connect(my_max_num_subdivisions)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.fft_multi_harmonic_minmax(
...     fields_container=my_fields_container,
...     rpm_scoping=my_rpm_scoping,
...     fs_ratio=my_fs_ratio,
...     num_subdivisions=my_num_subdivisions,
...     max_num_subdivisions=my_max_num_subdivisions,
... )

>>> # Get output data
>>> result_field_min = op.outputs.field_min()
>>> result_field_max = op.outputs.field_max()
>>> result_all_fields = op.outputs.all_fields()

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 the global server.

property inputs#

Enables to connect inputs to the operator

Returns: inputs
Return type: InputsFftMultiHarmonicMinmax

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsFftMultiHarmonicMinmax

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 create an operator with the new configuration as a parameter.

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

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 of int, list of doubles,) –

Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,
MeshesContainer, DataSources, 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.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 ]])

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.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, 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)#: Put the grpc spec message in self._spec

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.

class ansys.dpf.core.operators.math.fft_multi_harmonic_minmax.InputsFftMultiHarmonicMinmax(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to fft_multi_harmonic_minmax operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_rpm_scoping = dpf.Scoping()
>>> op.inputs.rpm_scoping.connect(my_rpm_scoping)
>>> my_fs_ratio = int()
>>> op.inputs.fs_ratio.connect(my_fs_ratio)
>>> my_num_subdivisions = int()
>>> op.inputs.num_subdivisions.connect(my_num_subdivisions)
>>> my_max_num_subdivisions = int()
>>> op.inputs.max_num_subdivisions.connect(my_max_num_subdivisions)

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.math.fft_multi_harmonic_minmax()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

property rpm_scoping#

Allows to connect rpm_scoping input to the operator.

Rpm scoping, by default the fft is evaluted using all the rpms

Parameters: my_rpm_scoping (Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> op.inputs.rpm_scoping.connect(my_rpm_scoping)
>>> # or
>>> op.inputs.rpm_scoping(my_rpm_scoping)

property fs_ratio#

Allows to connect fs_ratio input to the operator.

Field or fields container with only one field is expected

Parameters: my_fs_ratio (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> op.inputs.fs_ratio.connect(my_fs_ratio)
>>> # or
>>> op.inputs.fs_ratio(my_fs_ratio)

property num_subdivisions#

Allows to connect num_subdivisions input to the operator.

Connect number subdivisions, used for uniform discretization

Parameters: my_num_subdivisions (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> op.inputs.num_subdivisions.connect(my_num_subdivisions)
>>> # or
>>> op.inputs.num_subdivisions(my_num_subdivisions)

property max_num_subdivisions#

Allows to connect max_num_subdivisions input to the operator.

Connect max number subdivisions, used to avoid huge number of sudivisions

Parameters: my_max_num_subdivisions (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> op.inputs.max_num_subdivisions.connect(my_max_num_subdivisions)
>>> # or
>>> op.inputs.max_num_subdivisions(my_max_num_subdivisions)

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, Field, FieldsContainer, Scoping,) –

DataSources, MeshedRegion, ScopingsContainer, CyclicSupport,: …, Output, Outputs, Operator, os.PathLike

Input of the operator.

class ansys.dpf.core.operators.math.fft_multi_harmonic_minmax.OutputsFftMultiHarmonicMinmax(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from fft_multi_harmonic_minmax operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> # Connect inputs : op.inputs. ...
>>> result_field_min = op.outputs.field_min()
>>> result_field_max = op.outputs.field_max()
>>> result_all_fields = op.outputs.all_fields()

property field_min#

Allows to get field_min output of the operator

Returns: my_field_min
Return type: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> # Connect inputs : op.inputs. ...
>>> result_field_min = op.outputs.field_min()

property field_max#

Allows to get field_max output of the operator

Returns: my_field_max
Return type: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> # Connect inputs : op.inputs. ...
>>> result_field_max = op.outputs.field_max()

property all_fields#

Allows to get all_fields output of the operator

Returns: my_all_fields
Return type: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.fft_multi_harmonic_minmax()
>>> # Connect inputs : op.inputs. ...
>>> result_all_fields = op.outputs.all_fields()