plastic_strain_principal_2#
Autogenerated DPF operator classes.
- class ansys.dpf.core.operators.result.plastic_strain_principal_2.plastic_strain_principal_2(time_scoping=None, mesh_scoping=None, fields_container=None, streams_container=None, data_sources=None, bool_rotate_to_global=None, mesh=None, requested_location=None, read_cyclic=None, config=None, server=None)#
Read/compute element nodal component plastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values.
- Parameters
time_scoping (Scoping or int or float or Field, optional) – Time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with timefreq_steps location) required in output
mesh_scoping (ScopingsContainer or Scoping, optional) – Nodes or elements scoping required in output. the scoping’s location indicates whether nodes or elements are asked. using scopings container enables to split the result fields container in domains
fields_container (FieldsContainer, optional) – Fieldscontainer already allocated modified inplace
streams_container (StreamsContainer, optional) – Result file container allowed to be kept open to cache data
data_sources (DataSources) – Result file path container, used if no streams are set
bool_rotate_to_global (bool, optional) – If true the field is rotated to global coordinate system (default true)
mesh (MeshedRegion or MeshesContainer, optional) – Prevents from reading the mesh in the result files
requested_location (str, optional) –
read_cyclic (int, optional) – If 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)
Examples
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator >>> op = dpf.operators.result.plastic_strain_principal_2()
>>> # Make input connections >>> my_time_scoping = dpf.Scoping() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> my_mesh_scoping = dpf.ScopingsContainer() >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) >>> my_fields_container = dpf.FieldsContainer() >>> op.inputs.fields_container.connect(my_fields_container) >>> my_streams_container = dpf.StreamsContainer() >>> op.inputs.streams_container.connect(my_streams_container) >>> my_data_sources = dpf.DataSources() >>> op.inputs.data_sources.connect(my_data_sources) >>> my_bool_rotate_to_global = bool() >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) >>> my_mesh = dpf.MeshedRegion() >>> op.inputs.mesh.connect(my_mesh) >>> my_requested_location = str() >>> op.inputs.requested_location.connect(my_requested_location) >>> my_read_cyclic = int() >>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # Instantiate operator and connect inputs in one line >>> op = dpf.operators.result.plastic_strain_principal_2( ... time_scoping=my_time_scoping, ... mesh_scoping=my_mesh_scoping, ... fields_container=my_fields_container, ... streams_container=my_streams_container, ... data_sources=my_data_sources, ... bool_rotate_to_global=my_bool_rotate_to_global, ... mesh=my_mesh, ... requested_location=my_requested_location, ... read_cyclic=my_read_cyclic, ... )
>>> # Get output data >>> result_fields_container = op.outputs.fields_container()
- 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 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 evaluationg 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 create an operator with the new configuration as a parameter.- Returns
Copy of the operator’s current configuration.
- Return type
- 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 of int, list of doubles,) –
- Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,
MeshesContainer, DataSources, 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.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 array([[0.59428386, 0.00201751, 0.0006032 ]])
- 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.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
, optional) – Requested type of the output. The default isNone
.
- Returns
Output of the operator.
- Return type
type
- static operator_specification(op_name, server=None)#
Put the grpc spec message in self._spec
- 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.
- class ansys.dpf.core.operators.result.plastic_strain_principal_2.InputsPlasticStrainPrincipal2(op: ansys.dpf.core.dpf_operator.Operator)#
Intermediate class used to connect user inputs to plastic_strain_principal_2 operator.
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> my_time_scoping = dpf.Scoping() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> my_mesh_scoping = dpf.ScopingsContainer() >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) >>> my_fields_container = dpf.FieldsContainer() >>> op.inputs.fields_container.connect(my_fields_container) >>> my_streams_container = dpf.StreamsContainer() >>> op.inputs.streams_container.connect(my_streams_container) >>> my_data_sources = dpf.DataSources() >>> op.inputs.data_sources.connect(my_data_sources) >>> my_bool_rotate_to_global = bool() >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) >>> my_mesh = dpf.MeshedRegion() >>> op.inputs.mesh.connect(my_mesh) >>> my_requested_location = str() >>> op.inputs.requested_location.connect(my_requested_location) >>> my_read_cyclic = int() >>> op.inputs.read_cyclic.connect(my_read_cyclic)
- property time_scoping#
Allows to connect time_scoping input to the operator.
Time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with timefreq_steps location) required in output
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.time_scoping.connect(my_time_scoping) >>> # or >>> op.inputs.time_scoping(my_time_scoping)
- property mesh_scoping#
Allows to connect mesh_scoping input to the operator.
Nodes or elements scoping required in output. the scoping’s location indicates whether nodes or elements are asked. using scopings container enables to split the result fields container in domains
- Parameters
my_mesh_scoping (ScopingsContainer or Scoping) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) >>> # or >>> op.inputs.mesh_scoping(my_mesh_scoping)
- property fields_container#
Allows to connect fields_container input to the operator.
Fieldscontainer already allocated modified inplace
- Parameters
my_fields_container (FieldsContainer) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.fields_container.connect(my_fields_container) >>> # or >>> op.inputs.fields_container(my_fields_container)
- property streams_container#
Allows to connect streams_container input to the operator.
Result file container allowed to be kept open to cache data
- Parameters
my_streams_container (StreamsContainer) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.streams_container.connect(my_streams_container) >>> # or >>> op.inputs.streams_container(my_streams_container)
- 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.plastic_strain_principal_2() >>> op.inputs.data_sources.connect(my_data_sources) >>> # or >>> op.inputs.data_sources(my_data_sources)
- property bool_rotate_to_global#
Allows to connect bool_rotate_to_global input to the operator.
If true the field is rotated to global coordinate system (default true)
- Parameters
my_bool_rotate_to_global (bool) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) >>> # or >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
- property mesh#
Allows to connect mesh input to the operator.
Prevents from reading the mesh in the result files
- Parameters
my_mesh (MeshedRegion or MeshesContainer) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.mesh.connect(my_mesh) >>> # or >>> op.inputs.mesh(my_mesh)
- property requested_location#
Allows to connect requested_location input to the operator.
- Parameters
my_requested_location (str) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.requested_location.connect(my_requested_location) >>> # or >>> op.inputs.requested_location(my_requested_location)
- property read_cyclic#
Allows to connect read_cyclic input to the operator.
If 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)
- Parameters
my_read_cyclic (int) –
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> op.inputs.read_cyclic.connect(my_read_cyclic) >>> # or >>> op.inputs.read_cyclic(my_read_cyclic)
- 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, Field, FieldsContainer, Scoping,) –
- DataSources, MeshedRegion, ScopingsContainer, CyclicSupport,
…, Output, Outputs, Operator, os.PathLike
Input of the operator.
- class ansys.dpf.core.operators.result.plastic_strain_principal_2.OutputsPlasticStrainPrincipal2(op: ansys.dpf.core.dpf_operator.Operator)#
Intermediate class used to get outputs from plastic_strain_principal_2 operator.
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> # Connect inputs : op.inputs. ... >>> result_fields_container = op.outputs.fields_container()
- property fields_container#
Allows to get fields_container output of the operator
- Returns
my_fields_container
- Return type
Examples
>>> from ansys.dpf import core as dpf >>> op = dpf.operators.result.plastic_strain_principal_2() >>> # Connect inputs : op.inputs. ... >>> result_fields_container = op.outputs.fields_container()