rom_data_provider#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.result.rom_data_provider.rom_data_provider(rom_type=None, reduced_stiff_matrix=None, reduced_damping_matrix=None, reduced_mass_matrix=None, data_sources=None, reduced_rhs_vector=None, lumped_mass_matrix=None, mode_shapes=None, config=None, server=None)#

Set the required data for the invariant terms computation (reduced matrices, lumped mass matrix, modes …)

Parameters:

rom_type (bool) – If this pin is set to true, customized rom data must be given
reduced_stiff_matrix (FieldsContainer) – Fieldscontainers containing the reduced stiffness matrix
reduced_damping_matrix (FieldsContainer) – Fieldscontainers containing the reduced mass matrix
reduced_mass_matrix (FieldsContainer) – Fieldscontainers containing the reduced damp matrix
data_sources (DataSources) –
reduced_rhs_vector (FieldsContainer) – Fieldscontainers containing the reduced rhs vector
lumped_mass_matrix (FieldsContainer) – Fieldscontainers containing the lumped mass matrix
mode_shapes (FieldsContainer) – Fieldscontainers containing the customized mode shapes

Returns:

rom_matrices (FieldsContainer) – Fieldscontainers containing the reduced matrices
mode_shapes (FieldsContainer) – Fieldscontainers containing the mode shapes, which are cst and nor for the cms method
lumped_mass (FieldsContainer) – Fieldscontainers containing the lumped mass
model_data (PropertyField) – Data describing the finite element model
center_of_mass (PropertyField)
inertia_relief (Field) – Inertia matrix
model_size (float) – Size of the model
field_coordinates_and_euler_angles (float) – Coordinates and euler angles of all nodes
nod – Ids of master nodes
meshed_region (MeshedRegion) – Expanded meshed region.

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.result.rom_data_provider()

>>> # Make input connections
>>> my_rom_type = bool()
>>> op.inputs.rom_type.connect(my_rom_type)
>>> my_reduced_stiff_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_stiff_matrix.connect(my_reduced_stiff_matrix)
>>> my_reduced_damping_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_damping_matrix.connect(my_reduced_damping_matrix)
>>> my_reduced_mass_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_mass_matrix.connect(my_reduced_mass_matrix)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_reduced_rhs_vector = dpf.FieldsContainer()
>>> op.inputs.reduced_rhs_vector.connect(my_reduced_rhs_vector)
>>> my_lumped_mass_matrix = dpf.FieldsContainer()
>>> op.inputs.lumped_mass_matrix.connect(my_lumped_mass_matrix)
>>> my_mode_shapes = dpf.FieldsContainer()
>>> op.inputs.mode_shapes.connect(my_mode_shapes)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.rom_data_provider(
...     rom_type=my_rom_type,
...     reduced_stiff_matrix=my_reduced_stiff_matrix,
...     reduced_damping_matrix=my_reduced_damping_matrix,
...     reduced_mass_matrix=my_reduced_mass_matrix,
...     data_sources=my_data_sources,
...     reduced_rhs_vector=my_reduced_rhs_vector,
...     lumped_mass_matrix=my_lumped_mass_matrix,
...     mode_shapes=my_mode_shapes,
... )

>>> # Get output data
>>> result_rom_matrices = op.outputs.rom_matrices()
>>> result_mode_shapes = op.outputs.mode_shapes()
>>> result_lumped_mass = op.outputs.lumped_mass()
>>> result_model_data = op.outputs.model_data()
>>> result_center_of_mass = op.outputs.center_of_mass()
>>> result_inertia_relief = op.outputs.inertia_relief()
>>> result_model_size = op.outputs.model_size()
>>> result_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles()
>>> result_nod = op.outputs.nod()
>>> result_meshed_region = op.outputs.meshed_region()

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

property inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsRomDataProvider

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsRomDataProvider

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

For information on an operator’s options, see the documentation for that operator.

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

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

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[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – 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.find_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
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

connect_operator_as_input(pin, op)#: Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is 0. :type pin: int :type op: :param op: Requested type of the output. The default is None. :type op: ansys.dpf.core.dpf_operator.Operator

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.find_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, type, 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)#: Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties

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.

property specification#

Returns the Specification (or documentation) of this Operator

Return type:: Specification

class ansys.dpf.core.operators.result.rom_data_provider.InputsRomDataProvider(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to rom_data_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> my_rom_type = bool()
>>> op.inputs.rom_type.connect(my_rom_type)
>>> my_reduced_stiff_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_stiff_matrix.connect(my_reduced_stiff_matrix)
>>> my_reduced_damping_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_damping_matrix.connect(my_reduced_damping_matrix)
>>> my_reduced_mass_matrix = dpf.FieldsContainer()
>>> op.inputs.reduced_mass_matrix.connect(my_reduced_mass_matrix)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_reduced_rhs_vector = dpf.FieldsContainer()
>>> op.inputs.reduced_rhs_vector.connect(my_reduced_rhs_vector)
>>> my_lumped_mass_matrix = dpf.FieldsContainer()
>>> op.inputs.lumped_mass_matrix.connect(my_lumped_mass_matrix)
>>> my_mode_shapes = dpf.FieldsContainer()
>>> op.inputs.mode_shapes.connect(my_mode_shapes)

property rom_type#

Allows to connect rom_type input to the operator.

If this pin is set to true, customized rom data must be given

Parameters:: my_rom_type (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.rom_type.connect(my_rom_type)
>>> # or
>>> op.inputs.rom_type(my_rom_type)

property reduced_stiff_matrix#

Allows to connect reduced_stiff_matrix input to the operator.

Fieldscontainers containing the reduced stiffness matrix

Parameters:: my_reduced_stiff_matrix (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.reduced_stiff_matrix.connect(my_reduced_stiff_matrix)
>>> # or
>>> op.inputs.reduced_stiff_matrix(my_reduced_stiff_matrix)

property reduced_damping_matrix#

Allows to connect reduced_damping_matrix input to the operator.

Fieldscontainers containing the reduced mass matrix

Parameters:: my_reduced_damping_matrix (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.reduced_damping_matrix.connect(my_reduced_damping_matrix)
>>> # or
>>> op.inputs.reduced_damping_matrix(my_reduced_damping_matrix)

property reduced_mass_matrix#

Allows to connect reduced_mass_matrix input to the operator.

Fieldscontainers containing the reduced damp matrix

Parameters:: my_reduced_mass_matrix (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.reduced_mass_matrix.connect(my_reduced_mass_matrix)
>>> # or
>>> op.inputs.reduced_mass_matrix(my_reduced_mass_matrix)

property data_sources#

Allows to connect data_sources input to the operator.

Parameters:: my_data_sources (DataSources) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property reduced_rhs_vector#

Allows to connect reduced_rhs_vector input to the operator.

Fieldscontainers containing the reduced rhs vector

Parameters:: my_reduced_rhs_vector (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.reduced_rhs_vector.connect(my_reduced_rhs_vector)
>>> # or
>>> op.inputs.reduced_rhs_vector(my_reduced_rhs_vector)

property lumped_mass_matrix#

Allows to connect lumped_mass_matrix input to the operator.

Fieldscontainers containing the lumped mass matrix

Parameters:: my_lumped_mass_matrix (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.lumped_mass_matrix.connect(my_lumped_mass_matrix)
>>> # or
>>> op.inputs.lumped_mass_matrix(my_lumped_mass_matrix)

property mode_shapes#

Allows to connect mode_shapes input to the operator.

Fieldscontainers containing the customized mode shapes

Parameters:: my_mode_shapes (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> op.inputs.mode_shapes.connect(my_mode_shapes)
>>> # or
>>> op.inputs.mode_shapes(my_mode_shapes)

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, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.

class ansys.dpf.core.operators.result.rom_data_provider.OutputsRomDataProvider(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from rom_data_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_rom_matrices = op.outputs.rom_matrices()
>>> result_mode_shapes = op.outputs.mode_shapes()
>>> result_lumped_mass = op.outputs.lumped_mass()
>>> result_model_data = op.outputs.model_data()
>>> result_center_of_mass = op.outputs.center_of_mass()
>>> result_inertia_relief = op.outputs.inertia_relief()
>>> result_model_size = op.outputs.model_size()
>>> result_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles()
>>> result_nod = op.outputs.nod()
>>> result_meshed_region = op.outputs.meshed_region()

property rom_matrices#

Allows to get rom_matrices output of the operator

Returns:: my_rom_matrices
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_rom_matrices = op.outputs.rom_matrices()

property mode_shapes#

Allows to get mode_shapes output of the operator

Returns:: my_mode_shapes
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_mode_shapes = op.outputs.mode_shapes()

property lumped_mass#

Allows to get lumped_mass output of the operator

Returns:: my_lumped_mass
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_lumped_mass = op.outputs.lumped_mass()

property model_data#

Allows to get model_data output of the operator

Returns:: my_model_data
Return type:: PropertyField

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_model_data = op.outputs.model_data()

property center_of_mass#

Allows to get center_of_mass output of the operator

Returns:: my_center_of_mass
Return type:: PropertyField

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_center_of_mass = op.outputs.center_of_mass()

property inertia_relief#

Allows to get inertia_relief output of the operator

Returns:: my_inertia_relief
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_inertia_relief = op.outputs.inertia_relief()

property model_size#

Allows to get model_size output of the operator

Returns:: my_model_size
Return type:: float

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_model_size = op.outputs.model_size()

property field_coordinates_and_euler_angles#

Allows to get field_coordinates_and_euler_angles output of the operator

Returns:: my_field_coordinates_and_euler_angles
Return type:: float

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles()

property nod#

Allows to get nod output of the operator

Return type:: my_nod

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_nod = op.outputs.nod()

property meshed_region#

Allows to get meshed_region output of the operator

Returns:: my_meshed_region
Return type:: MeshedRegion

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.rom_data_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_meshed_region = op.outputs.meshed_region()