Skip to content

Update generated code for DPF 261_rcs_fix_def on master #2464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafacanton merged 2 commits into from
Jul 23, 2025
Merged

Update generated code for DPF 261_rcs_fix_def on master #2464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72841dc
update generated code
PProfizi Jul 23, 2025
7a85263
Merge branch 'master' into maint/update_code_for_261_rcs_fix_def_on_m…
rafacanton Jul 23, 2025
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
165 changes: 83 additions & 82 deletions doc/source/_static/dpf_operators.html
View file
Open in desktop

Large diffs are not rendered by default.

51 changes: 10 additions & 41 deletions src/ansys/dpf/core/operators/metadata/real_constants_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ class real_constants_provider(Operator):

Returns
-------
real_constants1: Field
real_constants2: Field
real_constants: Field

Examples
--------
Expand All @@ -57,8 +56,7 @@ class real_constants_provider(Operator):
... )

>>> # Get output data
>>> result_real_constants1 = op.outputs.real_constants1()
>>> result_real_constants2 = op.outputs.real_constants2()
>>> result_real_constants = op.outputs.real_constants()
"""

def __init__(
Expand Down Expand Up @@ -108,13 +106,7 @@ def _spec() -> Specification:
},
map_output_pin_spec={
0: PinSpecification(
name="real_constants1",
type_names=["field"],
optional=False,
document=r"""""",
),
1: PinSpecification(
name="real_constants2",
name="real_constants",
type_names=["field"],
optional=False,
document=r"""""",
Expand Down Expand Up @@ -269,42 +261,19 @@ class OutputsRealConstantsProvider(_Outputs):
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.real_constants_provider()
>>> # Connect inputs : op.inputs. ...
>>> result_real_constants1 = op.outputs.real_constants1()
>>> result_real_constants2 = op.outputs.real_constants2()
>>> result_real_constants = op.outputs.real_constants()
"""

def __init__(self, op: Operator):
super().__init__(real_constants_provider._spec().outputs, op)
self._real_constants1 = Output(
self._real_constants = Output(
real_constants_provider._spec().output_pin(0), 0, op
)
self._outputs.append(self._real_constants1)
self._real_constants2 = Output(
real_constants_provider._spec().output_pin(1), 1, op
)
self._outputs.append(self._real_constants2)

@property
def real_constants1(self) -> Output:
r"""Allows to get real_constants1 output of the operator

Returns
-------
output:
An Output instance for this pin.

Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.real_constants_provider()
>>> # Get the output from op.outputs. ...
>>> result_real_constants1 = op.outputs.real_constants1()
"""
return self._real_constants1
self._outputs.append(self._real_constants)

@property
def real_constants2(self) -> Output:
r"""Allows to get real_constants2 output of the operator
def real_constants(self) -> Output:
r"""Allows to get real_constants output of the operator

Returns
-------
Expand All @@ -316,6 +285,6 @@ def real_constants2(self) -> Output:
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.real_constants_provider()
>>> # Get the output from op.outputs. ...
>>> result_real_constants2 = op.outputs.real_constants2()
>>> result_real_constants = op.outputs.real_constants()
"""
return self._real_constants2
return self._real_constants
10 changes: 5 additions & 5 deletions src/ansys/dpf/core/operators/result/beam_axial_force.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


class beam_axial_force(Operator):
r"""Read Beam Axial Force (LSDyna) by calling the readers defined by the
r"""Read Beam X Axial Force by calling the readers defined by the
datasources.


Expand All @@ -31,7 +31,7 @@ class beam_axial_force(Operator):
data_sources: DataSources
result file path container, used if no streams are set
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -95,7 +95,7 @@ def __init__(

@staticmethod
def _spec() -> Specification:
description = r"""Read Beam Axial Force (LSDyna) by calling the readers defined by the
description = r"""Read Beam X Axial Force by calling the readers defined by the
datasources.
"""
spec = Specification(
Expand Down Expand Up @@ -140,7 +140,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -321,7 +321,7 @@ def data_sources(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/beam_axial_plastic_strain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class beam_axial_plastic_strain(Operator):
integration_point: int, optional
integration point where the result will be read from. Default value: 0 (first integration point).
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -154,7 +154,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -370,7 +370,7 @@ def integration_point(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
10 changes: 5 additions & 5 deletions src/ansys/dpf/core/operators/result/beam_axial_stress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


class beam_axial_stress(Operator):
r"""Read Beam Axial Stress (LSDyna) by calling the readers defined by the
r"""Read Beam X Axial Stress by calling the readers defined by the
datasources.


Expand All @@ -33,7 +33,7 @@ class beam_axial_stress(Operator):
integration_point: int, optional
integration point where the result will be read from. Default value: 0 (first integration point).
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -103,7 +103,7 @@ def __init__(

@staticmethod
def _spec() -> Specification:
description = r"""Read Beam Axial Stress (LSDyna) by calling the readers defined by the
description = r"""Read Beam X Axial Stress by calling the readers defined by the
datasources.
"""
spec = Specification(
Expand Down Expand Up @@ -154,7 +154,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -362,7 +362,7 @@ def integration_point(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
14 changes: 7 additions & 7 deletions src/ansys/dpf/core/operators/result/beam_axial_total_strain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@


class beam_axial_total_strain(Operator):
r"""Read Beam Axial Total strain (LSDyna) by calling the readers defined by
the datasources.
r"""Read Beam X Axial Total strain by calling the readers defined by the
datasources.


Parameters
Expand All @@ -33,7 +33,7 @@ class beam_axial_total_strain(Operator):
integration_point: int, optional
integration point where the result will be read from. Default value: 0 (first integration point).
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -103,8 +103,8 @@ def __init__(

@staticmethod
def _spec() -> Specification:
description = r"""Read Beam Axial Total strain (LSDyna) by calling the readers defined by
the datasources.
description = r"""Read Beam X Axial Total strain by calling the readers defined by the
datasources.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -154,7 +154,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -370,7 +370,7 @@ def integration_point(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/beam_rs_shear_stress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class beam_rs_shear_stress(Operator):
integration_point: int, optional
integration point where the result will be read from. Default value: 0 (first integration point).
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -154,7 +154,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -364,7 +364,7 @@ def integration_point(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
14 changes: 7 additions & 7 deletions src/ansys/dpf/core/operators/result/beam_s_bending_moment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@


class beam_s_bending_moment(Operator):
r"""Read Beam S Bending Moment (LSDyna) by calling the readers defined by
the datasources.
r"""Read Beam S/Y Bending Moment by calling the readers defined by the
datasources.


Parameters
Expand All @@ -31,7 +31,7 @@ class beam_s_bending_moment(Operator):
data_sources: DataSources
result file path container, used if no streams are set
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -95,8 +95,8 @@ def __init__(

@staticmethod
def _spec() -> Specification:
description = r"""Read Beam S Bending Moment (LSDyna) by calling the readers defined by
the datasources.
description = r"""Read Beam S/Y Bending Moment by calling the readers defined by the
datasources.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -140,7 +140,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -329,7 +329,7 @@ def data_sources(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
10 changes: 5 additions & 5 deletions src/ansys/dpf/core/operators/result/beam_s_shear_force.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


class beam_s_shear_force(Operator):
r"""Read Beam S Shear Force (LSDyna) by calling the readers defined by the
r"""Read Beam S/Y Shear Force by calling the readers defined by the
datasources.


Expand All @@ -31,7 +31,7 @@ class beam_s_shear_force(Operator):
data_sources: DataSources
result file path container, used if no streams are set
unit_system: int or str or UnitSystem, optional
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down Expand Up @@ -95,7 +95,7 @@ def __init__(

@staticmethod
def _spec() -> Specification:
description = r"""Read Beam S Shear Force (LSDyna) by calling the readers defined by the
description = r"""Read Beam S/Y Shear Force by calling the readers defined by the
datasources.
"""
spec = Specification(
Expand Down Expand Up @@ -140,7 +140,7 @@ def _spec() -> Specification:
"class dataProcessing::unit::CUnitSystem",
],
optional=True,
document=r"""Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
document=r"""(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -321,7 +321,7 @@ def data_sources(self) -> Input:
def unit_system(self) -> Input:
r"""Allows to connect unit_system input to the operator.

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns
-------
Expand Down
Loading
Loading