modal_superposition#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.math.modal_superposition.modal_superposition(modal_basis=None, solution_in_modal_space=None, time_scoping=None, mesh_scoping=None, config=None, server=None)#

Compute the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0) by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1).

Parameters

modal_basis (FieldsContainer) – One field by mode with each field representing a mode shape on nodes or elements
solution_in_modal_space (FieldsContainer) – One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin
time_scoping (Scoping, optional) – This input allows to compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container
mesh_scoping (Scoping or ScopingsContainer, optional) – This input allows to compute the result on a subset of the space domain defined in the modal_basis fields container

Examples

>>> from ansys.dpf import core as dpf

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

>>> # Make input connections
>>> my_modal_basis = dpf.FieldsContainer()
>>> op.inputs.modal_basis.connect(my_modal_basis)
>>> my_solution_in_modal_space = dpf.FieldsContainer()
>>> op.inputs.solution_in_modal_space.connect(my_solution_in_modal_space)
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.modal_superposition(
...     modal_basis=my_modal_basis,
...     solution_in_modal_space=my_solution_in_modal_space,
...     time_scoping=my_time_scoping,
...     mesh_scoping=my_mesh_scoping,
... )

>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()

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: InputsModalSuperposition

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsModalSuperposition

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.modal_superposition.InputsModalSuperposition(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to modal_superposition operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> my_modal_basis = dpf.FieldsContainer()
>>> op.inputs.modal_basis.connect(my_modal_basis)
>>> my_solution_in_modal_space = dpf.FieldsContainer()
>>> op.inputs.solution_in_modal_space.connect(my_solution_in_modal_space)
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)

property modal_basis#

Allows to connect modal_basis input to the operator.

One field by mode with each field representing a mode shape on nodes or elements

Parameters: my_modal_basis (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> op.inputs.modal_basis.connect(my_modal_basis)
>>> # or
>>> op.inputs.modal_basis(my_modal_basis)

property solution_in_modal_space#

Allows to connect solution_in_modal_space input to the operator.

One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin

Parameters: my_solution_in_modal_space (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> op.inputs.solution_in_modal_space.connect(my_solution_in_modal_space)
>>> # or
>>> op.inputs.solution_in_modal_space(my_solution_in_modal_space)

property time_scoping#

Allows to connect time_scoping input to the operator.

This input allows to compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container

Parameters: my_time_scoping (Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

property mesh_scoping#

Allows to connect mesh_scoping input to the operator.

This input allows to compute the result on a subset of the space domain defined in the modal_basis fields container

Parameters: my_mesh_scoping (Scoping or ScopingsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

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.modal_superposition.OutputsModalSuperposition(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from modal_superposition operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()

property fields_container#

Allows to get fields_container output of the operator

Returns: my_fields_container
Return type: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.modal_superposition()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()