members_in_compression_not_certified#
Autogenerated DPF operator classes.
- class ansys.dpf.core.operators.result.members_in_compression_not_certified.members_in_compression_not_certified(time_scoping=None, field_yield_strength=None, field_end_condition=None, streams=None, data_sources=None, manufacture=None, partial_factor=None, mesh=None, axial_force=None, fabrication_type=None, config=None, server=None)#
This operator is a non-certified example of buckling resistance verification for the compression members for Class I, 2 and 3 cross-sections. It is only provided as an example if you want to develop your own compute norm operator. The results computed by this beta operator have not been certified by ANSYS. ANSYS declines all responsibility for the use of this operator.
- Parameters:
time_scoping (Scoping or int, optional) – Time/freq set ids (use ints or scoping)
field_yield_strength (DataSources or Field) – This pin contains file csv or field of beam’s yield strength.
field_end_condition (DataSources or Field) – This pin contains file csv or field of beam’s end condition defined by the user. if no input at this pin found, it would take end condition’s value of all beams as 1.
streams (StreamsContainer, optional) – result file container allowed to be kept open to cache data.
data_sources (DataSources, optional) – Result file path container, used if no streams are set.
manufacture (bool) – Manufacturing processus:hot finished if true or cold formed if false. default value : hot finished.
partial_factor (float) – Partial safety factor for resistance of members to instability assessed by member checks. default value: 1.
mesh (MeshedRegion) – mesh containing beam’s properties defined by user
axial_force (FieldsContainer) – Fields container of axial force defined by user
fabrication_type (bool) – If there is beam i in the structure, please define its fabrication type. true: rolled section, false: welded section
- Returns:
buckling_resistance_compression_yy (FieldsContainer) – Fields container of buckling resistance factor on axis y-y in case of compression. these factors should be less than 1 and positive.
buckling_resistance_compression_zz (FieldsContainer) – Fields container of buckling resistance factor on axis z-z in case of compression. these factors should be less than 1 and positive.
Examples
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator >>> op = dpf.operators.result.members_in_compression_not_certified()
>>> # Make input connections >>> my_time_scoping = dpf.Scoping() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> my_field_yield_strength = dpf.DataSources() >>> op.inputs.field_yield_strength.connect(my_field_yield_strength) >>> my_field_end_condition = dpf.DataSources() >>> op.inputs.field_end_condition.connect(my_field_end_condition) >>> my_streams = dpf.StreamsContainer() >>> op.inputs.streams.connect(my_streams) >>> my_data_sources = dpf.DataSources() >>> op.inputs.data_sources.connect(my_data_sources) >>> my_manufacture = bool() >>> op.inputs.manufacture.connect(my_manufacture) >>> my_partial_factor = float() >>> op.inputs.partial_factor.connect(my_partial_factor) >>> my_mesh = dpf.MeshedRegion() >>> op.inputs.mesh.connect(my_mesh) >>> my_axial_force = dpf.FieldsContainer() >>> op.inputs.axial_force.connect(my_axial_force) >>> my_fabrication_type = bool() >>> op.inputs.fabrication_type.connect(my_fabrication_type)
>>> # Instantiate operator and connect inputs in one line >>> op = dpf.operators.result.members_in_compression_not_certified( ... time_scoping=my_time_scoping, ... field_yield_strength=my_field_yield_strength, ... field_end_condition=my_field_end_condition, ... streams=my_streams, ... data_sources=my_data_sources, ... manufacture=my_manufacture, ... partial_factor=my_partial_factor, ... mesh=my_mesh, ... axial_force=my_axial_force, ... fabrication_type=my_fabrication_type, ... )
>>> # Get output data >>> result_buckling_resistance_compression_yy = op.outputs.buckling_resistance_compression_yy() >>> result_buckling_resistance_compression_zz = op.outputs.buckling_resistance_compression_zz()
- static default_config(server=None)#
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.DPFServer, optional) – Server with channel connected to the remote or local instance. When
None
, attempts to use the global server.
- property inputs#
Enables to connect inputs to the operator
- Returns:
inputs
- Return type:
- property outputs#
Enables to get outputs of the operator by evaluating it
- Returns:
outputs
- Return type:
- property 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
- 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 ]]...
- connect_operator_as_input(pin, op)#
Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is
0
. :type pin: int :type op: :param op: Requested type of the output. The default isNone
. :type op:ansys.dpf.core.dpf_operator.Operator
- 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()
- 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
- static operator_specification(op_name, server=None)#
Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties
- property progress_bar: bool#
With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False
- run()#
Evaluate this operator.
- property specification#
Returns the Specification (or documentation) of this Operator
- Return type:
- class ansys.dpf.core.operators.result.members_in_compression_not_certified.InputsMembersInCompressionNotCertified(op: ansys.dpf.core.dpf_operator.Operator)#
Intermediate class used to connect user inputs to members_in_compression_not_certified operator.
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> my_time_scoping = dpf.Scoping() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> my_field_yield_strength = dpf.DataSources() >>> op.inputs.field_yield_strength.connect(my_field_yield_strength) >>> my_field_end_condition = dpf.DataSources() >>> op.inputs.field_end_condition.connect(my_field_end_condition) >>> my_streams = dpf.StreamsContainer() >>> op.inputs.streams.connect(my_streams) >>> my_data_sources = dpf.DataSources() >>> op.inputs.data_sources.connect(my_data_sources) >>> my_manufacture = bool() >>> op.inputs.manufacture.connect(my_manufacture) >>> my_partial_factor = float() >>> op.inputs.partial_factor.connect(my_partial_factor) >>> my_mesh = dpf.MeshedRegion() >>> op.inputs.mesh.connect(my_mesh) >>> my_axial_force = dpf.FieldsContainer() >>> op.inputs.axial_force.connect(my_axial_force) >>> my_fabrication_type = bool() >>> op.inputs.fabrication_type.connect(my_fabrication_type)
- property time_scoping#
Allows to connect time_scoping input to the operator.
Time/freq set ids (use ints or scoping)
- Parameters:
my_time_scoping (Scoping or int) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> # or >>> op.inputs.time_scoping(my_time_scoping)
- property field_yield_strength#
Allows to connect field_yield_strength input to the operator.
This pin contains file csv or field of beam’s yield strength.
- Parameters:
my_field_yield_strength (DataSources or Field) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.field_yield_strength.connect(my_field_yield_strength) >>> # or >>> op.inputs.field_yield_strength(my_field_yield_strength)
- property field_end_condition#
Allows to connect field_end_condition input to the operator.
This pin contains file csv or field of beam’s end condition defined by the user. if no input at this pin found, it would take end condition’s value of all beams as 1.
- Parameters:
my_field_end_condition (DataSources or Field) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.field_end_condition.connect(my_field_end_condition) >>> # or >>> op.inputs.field_end_condition(my_field_end_condition)
- property streams#
Allows to connect streams input to the operator.
result file container allowed to be kept open to cache data.
- Parameters:
my_streams (StreamsContainer) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.streams.connect(my_streams) >>> # or >>> op.inputs.streams(my_streams)
- property data_sources#
Allows to connect data_sources input to the operator.
Result file path container, used if no streams are set.
- Parameters:
my_data_sources (DataSources) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.data_sources.connect(my_data_sources) >>> # or >>> op.inputs.data_sources(my_data_sources)
- property manufacture#
Allows to connect manufacture input to the operator.
Manufacturing processus:hot finished if true or cold formed if false. default value : hot finished.
- Parameters:
my_manufacture (bool) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.manufacture.connect(my_manufacture) >>> # or >>> op.inputs.manufacture(my_manufacture)
- property partial_factor#
Allows to connect partial_factor input to the operator.
Partial safety factor for resistance of members to instability assessed by member checks. default value: 1.
- Parameters:
my_partial_factor (float) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.partial_factor.connect(my_partial_factor) >>> # or >>> op.inputs.partial_factor(my_partial_factor)
- property mesh#
Allows to connect mesh input to the operator.
mesh containing beam’s properties defined by user
- Parameters:
my_mesh (MeshedRegion) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.mesh.connect(my_mesh) >>> # or >>> op.inputs.mesh(my_mesh)
- property axial_force#
Allows to connect axial_force input to the operator.
Fields container of axial force defined by user
- Parameters:
my_axial_force (FieldsContainer) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.axial_force.connect(my_axial_force) >>> # or >>> op.inputs.axial_force(my_axial_force)
- property fabrication_type#
Allows to connect fabrication_type input to the operator.
If there is beam i in the structure, please define its fabrication type. true: rolled section, false: welded section
- Parameters:
my_fabrication_type (bool) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> op.inputs.fabrication_type.connect(my_fabrication_type) >>> # or >>> op.inputs.fabrication_type(my_fabrication_type)
- connect(inpt)#
Connect any input (an entity or an operator output) to any input pin of this operator. Searches for the input type corresponding to the output.
- Parameters:
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.
- class ansys.dpf.core.operators.result.members_in_compression_not_certified.OutputsMembersInCompressionNotCertified(op: ansys.dpf.core.dpf_operator.Operator)#
Intermediate class used to get outputs from members_in_compression_not_certified operator.
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> # Connect inputs : op.inputs. ... >>> result_buckling_resistance_compression_yy = op.outputs.buckling_resistance_compression_yy() >>> result_buckling_resistance_compression_zz = op.outputs.buckling_resistance_compression_zz()
- property buckling_resistance_compression_yy#
Allows to get buckling_resistance_compression_yy output of the operator
- Returns:
my_buckling_resistance_compression_yy
- Return type:
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> # Connect inputs : op.inputs. ... >>> result_buckling_resistance_compression_yy = op.outputs.buckling_resistance_compression_yy()
- property buckling_resistance_compression_zz#
Allows to get buckling_resistance_compression_zz output of the operator
- Returns:
my_buckling_resistance_compression_zz
- Return type:
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.members_in_compression_not_certified() >>> # Connect inputs : op.inputs. ... >>> result_buckling_resistance_compression_zz = op.outputs.buckling_resistance_compression_zz()