rotate_in_cylindrical_cs_fc#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.geo.rotate_in_cylindrical_cs_fc.rotate_in_cylindrical_cs_fc(field=None, coordinate_system=None, config=None, server=None)#

Rotate all the fields of a fields container (not defined with a cynlindrical coordinate system) to its corresponding values into the specified cylindrical coordinate system (corresponding to the field position). If no coordinate system is set in the coordinate_system pin, field is rotated on each node following the local polar coordinate system.

Parameters

field (Field or FieldsContainer) –
coordinate_system (Field, optional) – 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system.

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc()

>>> # Make input connections
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_coordinate_system = dpf.Field()
>>> op.inputs.coordinate_system.connect(my_coordinate_system)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc(
...     field=my_field,
...     coordinate_system=my_coordinate_system,
... )

>>> # 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: InputsRotateInCylindricalCsFc

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsRotateInCylindricalCsFc

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.geo.rotate_in_cylindrical_cs_fc.InputsRotateInCylindricalCsFc(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to rotate_in_cylindrical_cs_fc operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_coordinate_system = dpf.Field()
>>> op.inputs.coordinate_system.connect(my_coordinate_system)

property field#

Allows to connect field input to the operator.

Parameters: my_field (Field or FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

property coordinate_system#

Allows to connect coordinate_system input to the operator.

3-3 rotation matrix and origin coordinates must be set here to define a coordinate system.

Parameters: my_coordinate_system (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc()
>>> op.inputs.coordinate_system.connect(my_coordinate_system)
>>> # or
>>> op.inputs.coordinate_system(my_coordinate_system)

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.geo.rotate_in_cylindrical_cs_fc.OutputsRotateInCylindricalCsFc(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from rotate_in_cylindrical_cs_fc operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.geo.rotate_in_cylindrical_cs_fc()
>>> # 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.geo.rotate_in_cylindrical_cs_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()