`transpose`#

class ansys.dpf.core.operators.scoping.transpose.transpose(mesh_scoping=None, meshed_region=None, inclusive=None, requested_location=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Transposes the input scoping or scopings container (Elemental/Faces –> Nodal, or Nodal —> Elemental/Faces), based on the input mesh region.

Parameters:

mesh_scoping (Scoping or ScopingsContainer) – Scoping or scopings container (the input type is the output type)
meshed_region (MeshedRegion or MeshesContainer)
inclusive (int, optional) – If inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included
requested_location (str, optional) – Output scoping location for meshes with nodes, faces and elements. by default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental.

Returns:

mesh_scoping – Scoping or scopings container (the input type is the output type)

Return type:

Scoping or ScopingsContainer

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.scoping.transpose()

>>> # Make input connections
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_meshed_region = dpf.MeshedRegion()
>>> op.inputs.meshed_region.connect(my_meshed_region)
>>> my_inclusive = int()
>>> op.inputs.inclusive.connect(my_inclusive)
>>> my_requested_location = str()
>>> op.inputs.requested_location.connect(my_requested_location)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.scoping.transpose(
...     mesh_scoping=my_mesh_scoping,
...     meshed_region=my_meshed_region,
...     inclusive=my_inclusive,
...     requested_location=my_requested_location,
... )

>>> # Get output data
>>> result_mesh_scoping = op.outputs.mesh_scoping()

Overview#

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it

Static methods

default_config

Returns the default config of the operator.

Import detail#

from ansys.dpf.core.operators.scoping.transpose import transpose

Property detail#

property transpose.inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsTranspose

property transpose.outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsTranspose

Method detail#

static transpose.default_config(server=None)#