`svd`#

class ansys.dpf.core.operators.math.svd.svd(fields_container=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Computes the matrix singular value decomposition (SVD) for each field in the given fields container.

Parameters:

fields_container (FieldsContainer) – fields_container

Returns:

s_svd (FieldsContainer) – Singular values of the input data, where A=U.S.Vt
u_svd (FieldsContainer) – U of the input data, where A=U.S.Vt
vt_svd (FieldsContainer) – Vt of the input data, where A=U.S.Vt

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.math.svd()

>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.svd(
...     fields_container=my_fields_container,
... )

>>> # Get output data
>>> result_s_svd = op.outputs.s_svd()
>>> result_u_svd = op.outputs.u_svd()
>>> result_vt_svd = op.outputs.vt_svd()

Overview#

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it

Static methods

default_config

Returns the default config of the operator.

Import detail#

from ansys.dpf.core.operators.math.svd import svd

Property detail#

property svd.inputs: InputsSvd#

Enables to connect inputs to the operator

Returns:: An instance of InputsSvd.
Return type:: inputs

property svd.outputs: OutputsSvd#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsSvd.
Return type:: outputs

Method detail#

static svd.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#