Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/source/_static/dpf_operators.html

Large diffs are not rendered by default.

55 changes: 54 additions & 1 deletion src/ansys/dpf/core/operators/filter/abc_weightings.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ class abc_weightings(Operator):
computed, 1 the b-weigting is
computed and 2 the c-weightings is
computed.
shape_by_tf_scoping : bool
If this pin is set to true, each field of the
input fields container is defined by
time freq scoping and not by ids.
default is false


Examples
Expand All @@ -36,19 +41,27 @@ class abc_weightings(Operator):
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_weighting_type = int()
>>> op.inputs.weighting_type.connect(my_weighting_type)
>>> my_shape_by_tf_scoping = bool()
>>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.filter.abc_weightings(
... fields_container=my_fields_container,
... weighting_type=my_weighting_type,
... shape_by_tf_scoping=my_shape_by_tf_scoping,
... )

>>> # Get output data
>>> result_weightings = op.outputs.weightings()
"""

def __init__(
self, fields_container=None, weighting_type=None, config=None, server=None
self,
fields_container=None,
weighting_type=None,
shape_by_tf_scoping=None,
config=None,
server=None,
):
super().__init__(name="abc_weightings", config=config, server=server)
self._inputs = InputsAbcWeightings(self)
Expand All @@ -57,6 +70,8 @@ def __init__(
self.inputs.fields_container.connect(fields_container)
if weighting_type is not None:
self.inputs.weighting_type.connect(weighting_type)
if shape_by_tf_scoping is not None:
self.inputs.shape_by_tf_scoping.connect(shape_by_tf_scoping)

@staticmethod
def _spec():
Expand All @@ -81,6 +96,15 @@ def _spec():
computed and 2 the c-weightings is
computed.""",
),
2: PinSpecification(
name="shape_by_tf_scoping",
type_names=["bool"],
optional=False,
document="""If this pin is set to true, each field of the
input fields container is defined by
time freq scoping and not by ids.
default is false""",
),
},
map_output_pin_spec={
0: PinSpecification(
Expand Down Expand Up @@ -142,6 +166,8 @@ class InputsAbcWeightings(_Inputs):
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_weighting_type = int()
>>> op.inputs.weighting_type.connect(my_weighting_type)
>>> my_shape_by_tf_scoping = bool()
>>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
"""

def __init__(self, op: Operator):
Expand All @@ -150,6 +176,10 @@ def __init__(self, op: Operator):
self._inputs.append(self._fields_container)
self._weighting_type = Input(abc_weightings._spec().input_pin(1), 1, op, -1)
self._inputs.append(self._weighting_type)
self._shape_by_tf_scoping = Input(
abc_weightings._spec().input_pin(2), 2, op, -1
)
self._inputs.append(self._shape_by_tf_scoping)

@property
def fields_container(self):
Expand Down Expand Up @@ -194,6 +224,29 @@ def weighting_type(self):
"""
return self._weighting_type

@property
def shape_by_tf_scoping(self):
"""Allows to connect shape_by_tf_scoping input to the operator.

If this pin is set to true, each field of the
input fields container is defined by
time freq scoping and not by ids.
default is false

Parameters
----------
my_shape_by_tf_scoping : bool

Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.filter.abc_weightings()
>>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
>>> # or
>>> op.inputs.shape_by_tf_scoping(my_shape_by_tf_scoping)
"""
return self._shape_by_tf_scoping


class OutputsAbcWeightings(_Outputs):
"""Intermediate class used to get outputs from
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/acceleration.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ class acceleration(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -163,11 +163,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -340,11 +340,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/acceleration_X.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ class acceleration_X(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -164,11 +164,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -341,11 +341,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/acceleration_Y.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ class acceleration_Y(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -164,11 +164,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -341,11 +341,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/acceleration_Z.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ class acceleration_Z(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -164,11 +164,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -341,11 +341,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ class accu_eqv_creep_strain(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -197,11 +197,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -428,11 +428,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ class accu_eqv_plastic_strain(Operator):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -197,11 +197,11 @@ def _spec():
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down Expand Up @@ -428,11 +428,11 @@ def time_scoping(self):
time/freq set ids (use ints or
scoping) or time/freq step ids (use
scoping with timefreq_steps location)
required in output.to specify
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
"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
Expand Down
Loading