Skip to content

Commit

Permalink
update operators
Browse files Browse the repository at this point in the history
  • Loading branch information
@rlagha
rlagha authored Jun 30, 2023
1 parent 7090325 commit b7e859f
Show file tree
Hide file tree
Showing 20 changed files with 1,144 additions and 136 deletions.
18 changes: 9 additions & 9 deletions docs/source/_static/dpf_operators.html
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/field_high_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class field_high_pass(Operator):
A threshold scalar or a field containing one
value is expected.
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -91,10 +91,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -216,10 +216,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/field_high_pass_fc.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class field_high_pass_fc(Operator):
A threshold scalar or a field containing one
value is expected.
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -93,10 +93,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -220,10 +220,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/field_low_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class field_low_pass(Operator):
A threshold scalar or a field containing one
value is expected
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -91,10 +91,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -216,10 +216,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/field_low_pass_fc.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class field_low_pass_fc(Operator):
A threshold scalar or a field containing one
value is expected
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -93,10 +93,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -220,10 +220,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/field_signed_high_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class field_signed_high_pass(Operator):
A threshold scalar or a field containing one
value is expected.
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -93,10 +93,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -220,10 +220,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/scoping_high_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class scoping_high_pass(Operator):
A threshold scalar or a field containing one
value is expected.
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -91,10 +91,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -216,10 +216,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/scoping_low_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class scoping_low_pass(Operator):
A threshold scalar or a field containing one
value is expected
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -91,10 +91,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -216,10 +216,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
24 changes: 12 additions & 12 deletions src/ansys/dpf/core/operators/filter/signed_scoping_high_pass.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class signed_scoping_high_pass(Operator):
A threshold scalar or a field containing one
value is expected.
both : bool, optional
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Examples
Expand Down Expand Up @@ -93,10 +93,10 @@ def _spec():
name="both",
type_names=["bool"],
optional=True,
document="""Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.""",
document="""The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -222,10 +222,10 @@ def threshold(self):
def both(self):
"""Allows to connect both input to the operator.
Bool(optional, the default is false). if set
to true, the complement of the
filtered fields container is returned
on output pin 1.
The default is false. if set to true, the
complement of the filtered fields
container is returned on output pin
1.
Parameters
----------
Expand Down
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/math/scale.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class scale(Operator):
ponderation : float or Field
Double/field scoped on overall
boolean : bool, optional
Bool(optional, default false) if set to true,
output of scale is made dimensionless
Default is false. if set to true, output of
scale is made dimensionless
Examples
Expand Down Expand Up @@ -87,8 +87,8 @@ def _spec():
name="boolean",
type_names=["bool"],
optional=True,
document="""Bool(optional, default false) if set to true,
output of scale is made dimensionless""",
document="""Default is false. if set to true, output of
scale is made dimensionless""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -209,8 +209,8 @@ def ponderation(self):
def boolean(self):
"""Allows to connect boolean input to the operator.
Bool(optional, default false) if set to true,
output of scale is made dimensionless
Default is false. if set to true, output of
scale is made dimensionless
Parameters
----------
Expand Down
Loading

0 comments on commit b7e859f

Please sign in to comment.