ansys.dpf.core.operators.math.modal_superposition

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

Bases: ansys.dpf.core.dpf_operator.Operator

Computes 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) – 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) – Compute the result on a subset of the space domain defined in the modal_basis fields container.

Returns:

fields_container

Return type:

FieldsContainer

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()

_inputs

_outputs

static _spec() → ansys.dpf.core.operators.specification.Specification

static default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config

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 with channel connected to the remote or local instance. When None, attempts to use the global server.

Returns:

A new Config instance equivalent to the default config for this operator.

Return type:

config

property inputs: InputsModalSuperposition

Enables to connect inputs to the operator

Returns:

An instance of InputsModalSuperposition.

Return type:

inputs

property outputs: OutputsModalSuperposition

Enables to get outputs of the operator by evaluating it

Returns:

An instance of OutputsModalSuperposition.

Return type:

outputs