modal_superposition¶

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

available inputs:

modal_basis (FieldsContainer)
solution_in_modal_space (FieldsContainer)
time_scoping (Scoping, list) (optional)
mesh_scoping (Scoping, ScopingsContainer) (optional)

available outputs:

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

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

property outputs¶

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsModalSuperposition

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

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) – Object you wish to connect.
pin_out (int, optional) – In case of the input is an Operator, this is the output pin of the input Operator. Defaults to 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 ]])

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.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

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

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

pindoc: 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, list,) –

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

pindoc: 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, 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)¶

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

Intermediate class used to get outputs from modal_superposition operator .. rubric:: 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()

minus_fc modulus