`custom`#

class ansys.dpf.core.operators.result.custom.custom(time_scoping=None, mesh_scoping=None, fields_container=None, streams_container=None, data_sources=None, bool_rotate_to_global=None, mesh=None, read_cyclic=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Read/compute user defined result by calling the readers defined by the datasources.

Parameters:

time_scoping (Scoping or int or float or Field, optional) – Time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with timefreq_steps location) required in output. to specify time/freq values at specific load steps, put a field (and not a list) in input with a scoping located on “timefreq_steps”. linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.
mesh_scoping (ScopingsContainer or Scoping, optional) – Nodes or elements scoping required in output. the output fields will be scoped on these node or element ids. to figure out the ordering of the fields data, look at their scoping ids as they might not be ordered as the input scoping was. the scoping’s location indicates whether nodes or elements are asked for. using scopings container allows you to split the result fields container into domains
fields_container (FieldsContainer, optional) – Fields container already allocated modified inplace
streams_container (StreamsContainer, optional) – Result file container allowed to be kept open to cache data
data_sources (DataSources) – Result file path container, used if no streams are set
bool_rotate_to_global (bool, optional) – If true the field is rotated to global coordinate system (default true)
mesh (MeshedRegion or MeshesContainer, optional) – Prevents from reading the mesh in the result files
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)

Returns:

fields_container

Return type:

FieldsContainer

Examples

>>> from ansys.dpf import core as dpf

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

>>> # 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_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_read_cyclic = int()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.custom(
...     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,
...     mesh=my_mesh,
...     read_cyclic=my_read_cyclic,
... )

>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()

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.result.custom import custom

Property detail#

property custom.inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsCustom

property custom.outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsCustom

Method detail#

static custom.default_config(server=None)#