field#

class ansys.dpf.core.operators.utility.field.field(input=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Incrementaly merge the input.

Parameters:

input (Field)

Return type:

incremented_result

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.utility.field()
>>> # Make input connections
>>> my_input = dpf.Field()
>>> op.inputs.input.connect(my_input)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.field(
...     input=my_input,
... )
>>> # Get output data
>>> result_incremented_result = op.outputs.incremented_result()

Overview#

inputs

Enables to connect inputs to the operator

outputs

Enables to get outputs of the operator by evaluating it

default_config

Returns the default config of the operator.

Import detail#

from ansys.dpf.core.operators.utility.field import field

Property detail#

property field.inputs#

Enables to connect inputs to the operator

Returns:

inputs

Return type:

InputsField

property field.outputs#

Enables to get outputs of the operator by evaluating it

Returns:

outputs

Return type:

OutputsField

Method detail#

static field.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.