`accumulate`#

class ansys.dpf.core.operators.math.accumulate.accumulate(fieldA=None, weights=None, time_scoping=None, config=None, server=None, ponderation=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Sums all the elementary data of a field to produce one elementary data point.

Parameters:

fieldA (Field or FieldsContainer) – field or fields container with only one field is expected
weights (Field, optional) – Field containing weights, one weight per entity
time_scoping (Scoping, optional) – time_scoping

Returns:

field – Field containing the (weighted) sum for each component in an elementary data

Return type:

Field

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.math.accumulate()

>>> # Make input connections
>>> my_fieldA = dpf.Field()
>>> op.inputs.fieldA.connect(my_fieldA)
>>> my_weights = dpf.Field()
>>> op.inputs.weights.connect(my_weights)
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.accumulate(
...     fieldA=my_fieldA,
...     weights=my_weights,
...     time_scoping=my_time_scoping,
... )

>>> # Get output data
>>> result_field = op.outputs.field()

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.math.accumulate import accumulate

Property detail#

property accumulate.inputs: InputsAccumulate#

Enables to connect inputs to the operator

Returns:: An instance of InputsAccumulate.
Return type:: inputs

property accumulate.outputs: OutputsAccumulate#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsAccumulate.
Return type:: outputs

Method detail#

static accumulate.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#