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:
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#
Connect an input on the operator using a pin number. |
|
Connect an operator as an input on a pin. |
|
Retrieve the output of the operator on the pin number. |
|
Evaluate this operator. |
|
Evaluate this operator. |
Enables to connect inputs to the operator |
|
Enables to get outputs of the operator by evaluating it |
|
Enable or disable progress bar display when requesting the operator’s output. |
|
Copy of the operator’s current configuration. |
|
Retrieve the unique identifier of the operator. |
|
Returns the Specification (or documentation) of this Operator. |
Returns the default config of the operator. |
|
Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties. |
Delete this instance. |
|
Describe the entity. |
|
Add two fields or two fields containers. |
|
Subtract two fields or two fields containers. |
|
Raise each element of a field or a fields container to power 2. |
|
Multiply two fields or two fields containers. |
|
Perform division with another operator or a scalar. |
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
- property accumulate.progress_bar: bool#
Enable or disable progress bar display when requesting the operator’s output.
With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False
- property accumulate.config#
Copy of the operator’s current configuration.
You can modify the copy of the configuration and then use
operator.config = new_config
or instantiate an operator with the new configuration as a parameter.For information on an operator’s options, see the documentation for that operator.
- Returns:
Copy of the operator’s current configuration.
- Return type:
Examples
Modify the copy of an operator’s configuration and set it as current config of the operator.
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.math.add() >>> config_add = op.config >>> config_add.set_work_by_index_option(True) >>> op.config = config_add
- property accumulate.id: int#
Retrieve the unique identifier of the operator.
This property returns the unique ID associated with the operator. This property is lazily initialized.
- Returns:
The unique identifier of the operator.
- Return type:
int
Notes
Property available with server’s version starting at 10.0.
- property accumulate.specification#
Returns the Specification (or documentation) of this Operator.
- Return type:
Attribute detail#
- accumulate.name = None#
Method detail#
- static accumulate.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) ansys.dpf.core.config.Config #
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 with channel connected to the remote or local instance. When
None
, attempts to use the global server.- Returns:
A new Config instance equivalent to the default config for this operator.
- Return type:
config
- accumulate.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[int], list[float], Field, FieldsContainer, Scoping,)
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – 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.find_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 DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...
- accumulate.connect_operator_as_input(pin, op)#
Connect an operator as an input on a pin.
- Parameters:
pin (int) – Number of the output pin. The default is
0
.op (
ansys.dpf.core.dpf_operator.Operator
) – Requested type of the output. The default isNone
.
- accumulate.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
, type, optional) – Requested type of the output. The default isNone
.
- Returns:
Output of the operator.
- Return type:
type
- accumulate.__del__()#
Delete this instance.
- accumulate.__str__()#
Describe the entity.
- Returns:
Description of the entity.
- Return type:
str
- accumulate.run()#
Evaluate this operator.
- accumulate.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:
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.find_multishells_rst()) >>> disp_op = dpf.operators.result.displacement() >>> disp_op.inputs.data_sources(data_src) >>> normfc = math.norm_fc(disp_op).eval()
- accumulate.__add__(fields_b)#
Add two fields or two fields containers.
- Returns:
add
- Return type:
operators.math.add_fc
- accumulate.__sub__(fields_b)#
Subtract two fields or two fields containers.
- Returns:
minus
- Return type:
operators.math.minus_fc
- accumulate.__pow__(value)#
Raise each element of a field or a fields container to power 2.
- accumulate.__mul__(value)#
Multiply two fields or two fields containers.
- Returns:
mul
- Return type:
operators.math.generalized_inner_product_fc
- static accumulate.operator_specification(op_name, server=None)#
Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.
- accumulate.__truediv__(inpt)#
Perform division with another operator or a scalar.
This method allows the use of the division operator (/) between an Operator instance and either another Operator or a scalar value (float).