cyclic_expanded_displacement#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.result.cyclic_expanded_displacement.cyclic_expanded_displacement(time_scoping=None, mesh_scoping=None, fields_container=None, streams_container=None, data_sources=None, bool_rotate_to_global=None, sector_mesh=None, requested_location=None, read_cyclic=None, expanded_meshed_region=None, cyclic_support=None, sectors_to_expand=None, phi=None, config=None, server=None)#

Read displacements from an rst file and expand it with cyclic symmetry.

Parameters
  • time_scoping (Scoping, optional) –

  • mesh_scoping (ScopingsContainer or Scoping, optional) –

  • fields_container (FieldsContainer, optional) – Fieldscontainer already allocated modified inplace

  • streams_container (StreamsContainer or Stream, optional) – Streams containing the result file.

  • data_sources (DataSources) – Data sources containing the result file.

  • bool_rotate_to_global (bool, optional) – Default is true

  • sector_mesh (MeshedRegion or MeshesContainer, optional) – Mesh of the base sector (can be a skin).

  • requested_location (str, optional) – Location needed in output

  • read_cyclic (int, optional) – If 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)

  • expanded_meshed_region (MeshedRegion or MeshesContainer, optional) – Mesh expanded.

  • cyclic_support (CyclicSupport, optional) –

  • sectors_to_expand (Scoping or ScopingsContainer, optional) – Sectors to expand (start at 0), for multistage: use scopings container with ‘stage’ label.

  • phi (float, optional) – Angle phi (default value 0.0)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_bool_rotate_to_global = bool()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> my_sector_mesh = dpf.MeshedRegion()
>>> op.inputs.sector_mesh.connect(my_sector_mesh)
>>> my_requested_location = str()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> my_read_cyclic = int()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> my_expanded_meshed_region = dpf.MeshedRegion()
>>> op.inputs.expanded_meshed_region.connect(my_expanded_meshed_region)
>>> my_cyclic_support = dpf.CyclicSupport()
>>> op.inputs.cyclic_support.connect(my_cyclic_support)
>>> my_sectors_to_expand = dpf.Scoping()
>>> op.inputs.sectors_to_expand.connect(my_sectors_to_expand)
>>> my_phi = float()
>>> op.inputs.phi.connect(my_phi)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.cyclic_expanded_displacement(
...     time_scoping=my_time_scoping,
...     mesh_scoping=my_mesh_scoping,
...     fields_container=my_fields_container,
...     streams_container=my_streams_container,
...     data_sources=my_data_sources,
...     bool_rotate_to_global=my_bool_rotate_to_global,
...     sector_mesh=my_sector_mesh,
...     requested_location=my_requested_location,
...     read_cyclic=my_read_cyclic,
...     expanded_meshed_region=my_expanded_meshed_region,
...     cyclic_support=my_cyclic_support,
...     sectors_to_expand=my_sectors_to_expand,
...     phi=my_phi,
... )
>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()
>>> result_expanded_meshes = op.outputs.expanded_meshes()
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

InputsCyclicExpandedDisplacement

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsCyclicExpandedDisplacement

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.result.cyclic_expanded_displacement.InputsCyclicExpandedDisplacement(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to cyclic_expanded_displacement operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_bool_rotate_to_global = bool()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> my_sector_mesh = dpf.MeshedRegion()
>>> op.inputs.sector_mesh.connect(my_sector_mesh)
>>> my_requested_location = str()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> my_read_cyclic = int()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> my_expanded_meshed_region = dpf.MeshedRegion()
>>> op.inputs.expanded_meshed_region.connect(my_expanded_meshed_region)
>>> my_cyclic_support = dpf.CyclicSupport()
>>> op.inputs.cyclic_support.connect(my_cyclic_support)
>>> my_sectors_to_expand = dpf.Scoping()
>>> op.inputs.sectors_to_expand.connect(my_sectors_to_expand)
>>> my_phi = float()
>>> op.inputs.phi.connect(my_phi)
property time_scoping#

Allows to connect time_scoping input to the operator.

Parameters

my_time_scoping (Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> 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.

Parameters

my_mesh_scoping (ScopingsContainer or Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)
property fields_container#

Allows to connect fields_container input to the operator.

Fieldscontainer already allocated modified inplace

Parameters

my_fields_container (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
property streams_container#

Allows to connect streams_container input to the operator.

Streams containing the result file.

Parameters

my_streams_container (StreamsContainer or Stream) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)
property data_sources#

Allows to connect data_sources input to the operator.

Data sources containing the result file.

Parameters

my_data_sources (DataSources) –

Examples

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

Allows to connect bool_rotate_to_global input to the operator.

Default is true

Parameters

my_bool_rotate_to_global (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
property sector_mesh#

Allows to connect sector_mesh input to the operator.

Mesh of the base sector (can be a skin).

Parameters

my_sector_mesh (MeshedRegion or MeshesContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.sector_mesh.connect(my_sector_mesh)
>>> # or
>>> op.inputs.sector_mesh(my_sector_mesh)
property requested_location#

Allows to connect requested_location input to the operator.

Location needed in output

Parameters

my_requested_location (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)
property read_cyclic#

Allows to connect read_cyclic input to the operator.

If 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)

Parameters

my_read_cyclic (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)
property expanded_meshed_region#

Allows to connect expanded_meshed_region input to the operator.

Mesh expanded.

Parameters

my_expanded_meshed_region (MeshedRegion or MeshesContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.expanded_meshed_region.connect(my_expanded_meshed_region)
>>> # or
>>> op.inputs.expanded_meshed_region(my_expanded_meshed_region)
property cyclic_support#

Allows to connect cyclic_support input to the operator.

Parameters

my_cyclic_support (CyclicSupport) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.cyclic_support.connect(my_cyclic_support)
>>> # or
>>> op.inputs.cyclic_support(my_cyclic_support)
property sectors_to_expand#

Allows to connect sectors_to_expand input to the operator.

Sectors to expand (start at 0), for multistage: use scopings container with ‘stage’ label.

Parameters

my_sectors_to_expand (Scoping or ScopingsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.sectors_to_expand.connect(my_sectors_to_expand)
>>> # or
>>> op.inputs.sectors_to_expand(my_sectors_to_expand)
property phi#

Allows to connect phi input to the operator.

Angle phi (default value 0.0)

Parameters

my_phi (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> op.inputs.phi.connect(my_phi)
>>> # or
>>> op.inputs.phi(my_phi)
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.result.cyclic_expanded_displacement.OutputsCyclicExpandedDisplacement(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from cyclic_expanded_displacement operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
>>> result_expanded_meshes = op.outputs.expanded_meshes()
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.result.cyclic_expanded_displacement()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
property expanded_meshes#

Allows to get expanded_meshes output of the operator

Returns

my_expanded_meshes

Return type

MeshesContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cyclic_expanded_displacement()
>>> # Connect inputs : op.inputs. ...
>>> result_expanded_meshes = op.outputs.expanded_meshes()