@@ -23,6 +23,8 @@ class modal_superposition(Operator):
2323
2424 Parameters
2525 ----------
26+ is_output_custom: bool, optional
27+ If true, output will be a a custom container, otherwise a reconstructed fields_container. Default is false.
2628 modal_basis: FieldsContainer
2729 One field by mode with each field representing a mode shape on nodes or elements.
2830 solution_in_modal_space: FieldsContainer
@@ -46,6 +48,8 @@ class modal_superposition(Operator):
4648 >>> op = dpf.operators.math.modal_superposition()
4749
4850 >>> # Make input connections
51+ >>> my_is_output_custom = bool()
52+ >>> op.inputs.is_output_custom.connect(my_is_output_custom)
4953 >>> my_modal_basis = dpf.FieldsContainer()
5054 >>> op.inputs.modal_basis.connect(my_modal_basis)
5155 >>> my_solution_in_modal_space = dpf.FieldsContainer()
@@ -59,6 +63,7 @@ class modal_superposition(Operator):
5963
6064 >>> # Instantiate operator and connect inputs in one line
6165 >>> op = dpf.operators.math.modal_superposition(
66+ ... is_output_custom=my_is_output_custom,
6267 ... modal_basis=my_modal_basis,
6368 ... solution_in_modal_space=my_solution_in_modal_space,
6469 ... incremental_fc=my_incremental_fc,
@@ -72,6 +77,7 @@ class modal_superposition(Operator):
7277
7378 def __init__ (
7479 self ,
80+ is_output_custom = None ,
7581 modal_basis = None ,
7682 solution_in_modal_space = None ,
7783 incremental_fc = None ,
@@ -85,6 +91,8 @@ def __init__(
8591 )
8692 self ._inputs = InputsModalSuperposition (self )
8793 self ._outputs = OutputsModalSuperposition (self )
94+ if is_output_custom is not None :
95+ self .inputs .is_output_custom .connect (is_output_custom )
8896 if modal_basis is not None :
8997 self .inputs .modal_basis .connect (modal_basis )
9098 if solution_in_modal_space is not None :
@@ -105,6 +113,12 @@ def _spec() -> Specification:
105113 spec = Specification (
106114 description = description ,
107115 map_input_pin_spec = {
116+ - 1 : PinSpecification (
117+ name = "is_output_custom" ,
118+ type_names = ["bool" ],
119+ optional = True ,
120+ document = r"""If true, output will be a a custom container, otherwise a reconstructed fields_container. Default is false.""" ,
121+ ),
108122 0 : PinSpecification (
109123 name = "modal_basis" ,
110124 type_names = ["fields_container" ],
@@ -201,6 +215,8 @@ class InputsModalSuperposition(_Inputs):
201215 --------
202216 >>> from ansys.dpf import core as dpf
203217 >>> op = dpf.operators.math.modal_superposition()
218+ >>> my_is_output_custom = bool()
219+ >>> op.inputs.is_output_custom.connect(my_is_output_custom)
204220 >>> my_modal_basis = dpf.FieldsContainer()
205221 >>> op.inputs.modal_basis.connect(my_modal_basis)
206222 >>> my_solution_in_modal_space = dpf.FieldsContainer()
@@ -215,6 +231,10 @@ class InputsModalSuperposition(_Inputs):
215231
216232 def __init__ (self , op : Operator ):
217233 super ().__init__ (modal_superposition ._spec ().inputs , op )
234+ self ._is_output_custom = Input (
235+ modal_superposition ._spec ().input_pin (- 1 ), - 1 , op , - 1
236+ )
237+ self ._inputs .append (self ._is_output_custom )
218238 self ._modal_basis = Input (modal_superposition ._spec ().input_pin (0 ), 0 , op , - 1 )
219239 self ._inputs .append (self ._modal_basis )
220240 self ._solution_in_modal_space = Input (
@@ -230,6 +250,27 @@ def __init__(self, op: Operator):
230250 self ._mesh_scoping = Input (modal_superposition ._spec ().input_pin (4 ), 4 , op , - 1 )
231251 self ._inputs .append (self ._mesh_scoping )
232252
253+ @property
254+ def is_output_custom (self ) -> Input :
255+ r"""Allows to connect is_output_custom input to the operator.
256+
257+ If true, output will be a a custom container, otherwise a reconstructed fields_container. Default is false.
258+
259+ Returns
260+ -------
261+ input:
262+ An Input instance for this pin.
263+
264+ Examples
265+ --------
266+ >>> from ansys.dpf import core as dpf
267+ >>> op = dpf.operators.math.modal_superposition()
268+ >>> op.inputs.is_output_custom.connect(my_is_output_custom)
269+ >>> # or
270+ >>> op.inputs.is_output_custom(my_is_output_custom)
271+ """
272+ return self ._is_output_custom
273+
233274 @property
234275 def modal_basis (self ) -> Input :
235276 r"""Allows to connect modal_basis input to the operator.
0 commit comments