elemental_difference_fc

class ansys.dpf.core.operators.averaging.elemental_difference_fc.elemental_difference_fc(fields_container=None, mesh=None, scoping=None, collapse_shell_layers=None, config=None, server=None)

Transform ElementalNodal or Nodal field into Elemental field. Each elemental value is the maximum difference between the unaveraged or averaged (depending on the input fields) computed result for all nodes in this element. Result is computed on a given element scoping. If the input fields are mixed shell/solid and the shells layers are not asked to be collapsed, then the fields are splitted by element shape and the output fields container has elshape label.

available inputs:
  • fields_container (FieldsContainer)

  • mesh (MeshedRegion, MeshesContainer) (optional)

  • scoping (Scoping, ScopingsContainer) (optional)

  • collapse_shell_layers (bool) (optional)

available outputs:
  • fields_container (FieldsContainer)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)
>>> my_collapse_shell_layers = bool()
>>> op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.averaging.elemental_difference_fc(fields_container=my_fields_container,mesh=my_mesh,scoping=my_scoping,collapse_shell_layers=my_collapse_shell_layers)
>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()
static default_config()

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters
  • name (str) – Name of the operator. For example ‘U’.

  • 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

InputsElementalDifferenceFc

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsElementalDifferenceFc

property config

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns

config

Return type

Config

connect(pin, inpt, pin_out=0)

Connect an input on the operator using a pin number.

Parameters

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 ]])
get_output(pin=0, output_type=None)

Returns the output of the operator on the pin number.

Parameters
  • pin (int, optional) – Number of the output pin.

  • output_type (core.type enum, optional) – The requested type of the output.

run()

Evaluate this operator

class ansys.dpf.core.operators.averaging.elemental_difference_fc.InputsElementalDifferenceFc(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to connect user inputs to elemental_difference_fc operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)
>>> my_collapse_shell_layers = bool()
>>> op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
property fields_container

Allows to connect fields_container input to the operator

Parameters

my_fields_container (FieldsContainer,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> #or
>>> op.inputs.fields_container(my_fields_container)
property mesh

Allows to connect mesh input to the operator

  • pindoc: the mesh region in this pin is used to perform the averaging, if there is no field’s support it is used

Parameters

my_mesh (MeshedRegion, MeshesContainer,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> op.inputs.mesh.connect(my_mesh)
>>> #or
>>> op.inputs.mesh(my_mesh)
property scoping

Allows to connect scoping input to the operator

  • pindoc: average only on these elements, if it is scoping container, the label must correspond to the one of the fields container

Parameters

my_scoping (Scoping, ScopingsContainer,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> op.inputs.scoping.connect(my_scoping)
>>> #or
>>> op.inputs.scoping(my_scoping)
property collapse_shell_layers

Allows to connect collapse_shell_layers input to the operator

  • pindoc: the max elemental difference is taken through the different shell layers if true (default is false)

Parameters

my_collapse_shell_layers (bool,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.averaging.elemental_difference_fc()
>>> op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
>>> #or
>>> op.inputs.collapse_shell_layers(my_collapse_shell_layers)
connect(inpt)

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters

inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – input of the operator

class ansys.dpf.core.operators.averaging.elemental_difference_fc.OutputsElementalDifferenceFc(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to get outputs from elemental_difference_fc operator .. rubric:: Examples

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