write_motion_dfmf_file#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.result.write_motion_dfmf_file.write_motion_dfmf_file(model_data=None, mode_shapes=None, lumped_mass=None, field_coordinates=None, nod=None, used_node_index=None, eigenvalue=None, translational_mode_shape=None, rotational_mode_shape=None, invrt_1=None, invrt_2=None, invrt_3=None, invrt_4=None, invrt_5=None, invrt_6=None, invrt_7=None, invrt_8=None, dfmffile_path=None, rstfile_path=None, config=None, server=None)#

Write the invariant terms and the model data in a motion dfmf file

Parameters:

model_data (PropertyField) – Data describing the finite element model
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
field_coordinates (Field) – Coordinates of all nodes
nod (default: None) –
used_node_index (default: None) –
eigenvalue (default: None) –
translational_mode_shape (default: None) –
rotational_mode_shape (default: None) –
invrt_1 (float) –
invrt_2 (default: None) –
invrt_3 (default: None) –
invrt_4 (default: None) –
invrt_5 (default: None) –
invrt_6 (default: None) –
invrt_7 (default: None) –
invrt_8 (default: None) –
dfmffile_path (str) – Path with motion dfmf extension where the export occurs
rstfile_path (str) –

Examples

>>> from ansys.dpf import core as dpf

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

>>> # Make input connections
>>> my_model_data = dpf.PropertyField()
>>> op.inputs.model_data.connect(my_model_data)
>>> my_mode_shapes = dpf.FieldsContainer()
>>> op.inputs.mode_shapes.connect(my_mode_shapes)
>>> my_lumped_mass = dpf.FieldsContainer()
>>> op.inputs.lumped_mass.connect(my_lumped_mass)
>>> my_field_coordinates = dpf.Field()
>>> op.inputs.field_coordinates.connect(my_field_coordinates)
>>> my_nod = dpf.()
>>> op.inputs.nod.connect(my_nod)
>>> my_used_node_index = dpf.()
>>> op.inputs.used_node_index.connect(my_used_node_index)
>>> my_eigenvalue = dpf.()
>>> op.inputs.eigenvalue.connect(my_eigenvalue)
>>> my_translational_mode_shape = dpf.()
>>> op.inputs.translational_mode_shape.connect(my_translational_mode_shape)
>>> my_rotational_mode_shape = dpf.()
>>> op.inputs.rotational_mode_shape.connect(my_rotational_mode_shape)
>>> my_invrt_1 = float()
>>> op.inputs.invrt_1.connect(my_invrt_1)
>>> my_invrt_2 = dpf.()
>>> op.inputs.invrt_2.connect(my_invrt_2)
>>> my_invrt_3 = dpf.()
>>> op.inputs.invrt_3.connect(my_invrt_3)
>>> my_invrt_4 = dpf.()
>>> op.inputs.invrt_4.connect(my_invrt_4)
>>> my_invrt_5 = dpf.()
>>> op.inputs.invrt_5.connect(my_invrt_5)
>>> my_invrt_6 = dpf.()
>>> op.inputs.invrt_6.connect(my_invrt_6)
>>> my_invrt_7 = dpf.()
>>> op.inputs.invrt_7.connect(my_invrt_7)
>>> my_invrt_8 = dpf.()
>>> op.inputs.invrt_8.connect(my_invrt_8)
>>> my_dfmffile_path = str()
>>> op.inputs.dfmffile_path.connect(my_dfmffile_path)
>>> my_rstfile_path = str()
>>> op.inputs.rstfile_path.connect(my_rstfile_path)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.write_motion_dfmf_file(
...     model_data=my_model_data,
...     mode_shapes=my_mode_shapes,
...     lumped_mass=my_lumped_mass,
...     field_coordinates=my_field_coordinates,
...     nod=my_nod,
...     used_node_index=my_used_node_index,
...     eigenvalue=my_eigenvalue,
...     translational_mode_shape=my_translational_mode_shape,
...     rotational_mode_shape=my_rotational_mode_shape,
...     invrt_1=my_invrt_1,
...     invrt_2=my_invrt_2,
...     invrt_3=my_invrt_3,
...     invrt_4=my_invrt_4,
...     invrt_5=my_invrt_5,
...     invrt_6=my_invrt_6,
...     invrt_7=my_invrt_7,
...     invrt_8=my_invrt_8,
...     dfmffile_path=my_dfmffile_path,
...     rstfile_path=my_rstfile_path,
... )

>>> # Get output data
>>> result_dfmf_data_source = op.outputs.dfmf_data_source()

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

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsWriteMotionDfmfFile

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

Intermediate class used to connect user inputs to write_motion_dfmf_file operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> my_model_data = dpf.PropertyField()
>>> op.inputs.model_data.connect(my_model_data)
>>> my_mode_shapes = dpf.FieldsContainer()
>>> op.inputs.mode_shapes.connect(my_mode_shapes)
>>> my_lumped_mass = dpf.FieldsContainer()
>>> op.inputs.lumped_mass.connect(my_lumped_mass)
>>> my_field_coordinates = dpf.Field()
>>> op.inputs.field_coordinates.connect(my_field_coordinates)
>>> my_nod = dpf.()
>>> op.inputs.nod.connect(my_nod)
>>> my_used_node_index = dpf.()
>>> op.inputs.used_node_index.connect(my_used_node_index)
>>> my_eigenvalue = dpf.()
>>> op.inputs.eigenvalue.connect(my_eigenvalue)
>>> my_translational_mode_shape = dpf.()
>>> op.inputs.translational_mode_shape.connect(my_translational_mode_shape)
>>> my_rotational_mode_shape = dpf.()
>>> op.inputs.rotational_mode_shape.connect(my_rotational_mode_shape)
>>> my_invrt_1 = float()
>>> op.inputs.invrt_1.connect(my_invrt_1)
>>> my_invrt_2 = dpf.()
>>> op.inputs.invrt_2.connect(my_invrt_2)
>>> my_invrt_3 = dpf.()
>>> op.inputs.invrt_3.connect(my_invrt_3)
>>> my_invrt_4 = dpf.()
>>> op.inputs.invrt_4.connect(my_invrt_4)
>>> my_invrt_5 = dpf.()
>>> op.inputs.invrt_5.connect(my_invrt_5)
>>> my_invrt_6 = dpf.()
>>> op.inputs.invrt_6.connect(my_invrt_6)
>>> my_invrt_7 = dpf.()
>>> op.inputs.invrt_7.connect(my_invrt_7)
>>> my_invrt_8 = dpf.()
>>> op.inputs.invrt_8.connect(my_invrt_8)
>>> my_dfmffile_path = str()
>>> op.inputs.dfmffile_path.connect(my_dfmffile_path)
>>> my_rstfile_path = str()
>>> op.inputs.rstfile_path.connect(my_rstfile_path)

property model_data#

Allows to connect model_data input to the operator.

Data describing the finite element model

Parameters:: my_model_data (PropertyField) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.model_data.connect(my_model_data)
>>> # or
>>> op.inputs.model_data(my_model_data)

property mode_shapes#

Allows to connect mode_shapes input to the operator.

Fieldscontainers containing the mode shapes, which are cst and nor for the cms method

Parameters:: my_mode_shapes (FieldsContainer) –

Examples

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

property lumped_mass#

Allows to connect lumped_mass input to the operator.

Fieldscontainers containing the lumped mass

Parameters:: my_lumped_mass (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.lumped_mass.connect(my_lumped_mass)
>>> # or
>>> op.inputs.lumped_mass(my_lumped_mass)

property field_coordinates#

Allows to connect field_coordinates input to the operator.

Coordinates of all nodes

Parameters:: my_field_coordinates (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.field_coordinates.connect(my_field_coordinates)
>>> # or
>>> op.inputs.field_coordinates(my_field_coordinates)

property nod#

Allows to connect nod input to the operator.

Parameters:: my_nod –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.nod.connect(my_nod)
>>> # or
>>> op.inputs.nod(my_nod)

property used_node_index#

Allows to connect used_node_index input to the operator.

Parameters:: my_used_node_index –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.used_node_index.connect(my_used_node_index)
>>> # or
>>> op.inputs.used_node_index(my_used_node_index)

property eigenvalue#

Allows to connect eigenvalue input to the operator.

Parameters:: my_eigenvalue –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.eigenvalue.connect(my_eigenvalue)
>>> # or
>>> op.inputs.eigenvalue(my_eigenvalue)

property translational_mode_shape#

Allows to connect translational_mode_shape input to the operator.

Parameters:: my_translational_mode_shape –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.translational_mode_shape.connect(my_translational_mode_shape)
>>> # or
>>> op.inputs.translational_mode_shape(my_translational_mode_shape)

property rotational_mode_shape#

Allows to connect rotational_mode_shape input to the operator.

Parameters:: my_rotational_mode_shape –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.rotational_mode_shape.connect(my_rotational_mode_shape)
>>> # or
>>> op.inputs.rotational_mode_shape(my_rotational_mode_shape)

property invrt_1#

Allows to connect invrt_1 input to the operator.

Parameters:: my_invrt_1 (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_1.connect(my_invrt_1)
>>> # or
>>> op.inputs.invrt_1(my_invrt_1)

property invrt_2#

Allows to connect invrt_2 input to the operator.

Parameters:: my_invrt_2 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_2.connect(my_invrt_2)
>>> # or
>>> op.inputs.invrt_2(my_invrt_2)

property invrt_3#

Allows to connect invrt_3 input to the operator.

Parameters:: my_invrt_3 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_3.connect(my_invrt_3)
>>> # or
>>> op.inputs.invrt_3(my_invrt_3)

property invrt_4#

Allows to connect invrt_4 input to the operator.

Parameters:: my_invrt_4 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_4.connect(my_invrt_4)
>>> # or
>>> op.inputs.invrt_4(my_invrt_4)

property invrt_5#

Allows to connect invrt_5 input to the operator.

Parameters:: my_invrt_5 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_5.connect(my_invrt_5)
>>> # or
>>> op.inputs.invrt_5(my_invrt_5)

property invrt_6#

Allows to connect invrt_6 input to the operator.

Parameters:: my_invrt_6 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_6.connect(my_invrt_6)
>>> # or
>>> op.inputs.invrt_6(my_invrt_6)

property invrt_7#

Allows to connect invrt_7 input to the operator.

Parameters:: my_invrt_7 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_7.connect(my_invrt_7)
>>> # or
>>> op.inputs.invrt_7(my_invrt_7)

property invrt_8#

Allows to connect invrt_8 input to the operator.

Parameters:: my_invrt_8 –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.invrt_8.connect(my_invrt_8)
>>> # or
>>> op.inputs.invrt_8(my_invrt_8)

property dfmffile_path#

Allows to connect dfmffile_path input to the operator.

Path with motion dfmf extension where the export occurs

Parameters:: my_dfmffile_path (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.dfmffile_path.connect(my_dfmffile_path)
>>> # or
>>> op.inputs.dfmffile_path(my_dfmffile_path)

property rstfile_path#

Allows to connect rstfile_path input to the operator.

Parameters:: my_rstfile_path (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> op.inputs.rstfile_path.connect(my_rstfile_path)
>>> # or
>>> op.inputs.rstfile_path(my_rstfile_path)

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

Intermediate class used to get outputs from write_motion_dfmf_file operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> # Connect inputs : op.inputs. ...
>>> result_dfmf_data_source = op.outputs.dfmf_data_source()

property dfmf_data_source#

Allows to get dfmf_data_source output of the operator

Returns:: my_dfmf_data_source
Return type:: DataSources

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.write_motion_dfmf_file()
>>> # Connect inputs : op.inputs. ...
>>> result_dfmf_data_source = op.outputs.dfmf_data_source()