math:svd

Version: 0.0.0

Description

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

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

fields_container (Pin 0)

• Required: Yes
• Expected type(s): fields_container

fields_container

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

s_svd (Pin 0)

• Expected type(s): fields_container

Singular values of the input data, where A=U.S.Vt

u_svd (Pin 1)

• Expected type(s): fields_container

U of the input data, where A=U.S.Vt

vt_svd (Pin 2)

• Expected type(s): fields_container

Vt of the input data, where A=U.S.Vt

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: math

Plugin: core

Scripting name: svd

Full name: math.svd

Internal name: svdOp

License: any_dpf_supported_increments

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("svdOp"); // operator instantiation
op.connect(0, my_fields_container);
ansys::dpf::FieldsContainer my_s_svd = op.getOutput<ansys::dpf::FieldsContainer>(0);
ansys::dpf::FieldsContainer my_u_svd = op.getOutput<ansys::dpf::FieldsContainer>(1);
ansys::dpf::FieldsContainer my_vt_svd = op.getOutput<ansys::dpf::FieldsContainer>(2);

import ansys.dpf.core as dpf

op = dpf.operators.math.svd() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
my_s_svd = op.outputs.s_svd()
my_u_svd = op.outputs.u_svd()
my_vt_svd = op.outputs.vt_svd()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.svd() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
my_s_svd = op.outputs.s_svd.GetData()
my_u_svd = op.outputs.u_svd.GetData()
my_vt_svd = op.outputs.vt_svd.GetData()

Changelog

• Version 0.0.0: Initial release.