compute_residual_and_error class

Namespace: Ans.DataProcessing.operators.math

Summary

Computes the Lp-norm of a field or a field container.

												When a second entry is provided, the residual (the difference between the first and second entry) is calculated along with the error as the Lp-norm of the difference.

												When a second input is not provided, the calculation is only completed for the first entry.

												The type of calculation performed is based on the specifications provided for pin 1, pin 2 defines the type of error norm (L1 vs L2), and

												pin 3 which entity to use as a reference

available inputs: field_or_fields_container1 (Field, FieldsContainer), normalization_type (Int32) (optional), norm_calculation_type (Int32) (optional), field_reference (Int32) (optional), field_or_fields_container2 (Field, FieldsContainer) (optional)

available outputs: residuals (Field ,FieldsContainer), error (Field ,FieldsContainer), residuals_normalization_factor (Field ,FieldsContainer), error_normalization_factor (Field ,FieldsContainer)

Example

op = compute_residual_and_error()

op = compute_residual_and_error(field_or_fields_container1=my_field_or_fields_container1,normalization_type=my_normalization_type,norm_calculation_type=my_norm_calculation_type,field_reference=my_field_reference,field_or_fields_container2=my_field_or_fields_container2)

Class Information

Property	Value
Namespace	Ans.DataProcessing.operators.math
Assembly	Ans_Dpf_Native_dll_cs
Base Class	Ans.DataProcessing.internal_objects.BaseOperator

Inputs

field_or_fields_container1

field or fields container - compulsory

Type: LinkableInput

normalization_type

Type: LinkableInput

norm_calculation_type

Type: LinkableInput

field_reference

Field reference for the normalization step, default: 0 for entry 1, 1 for residuals - optional

Type: LinkableInput

field_or_fields_container2

field or fields container of same dimensionality as entry 1 - optional

Type: LinkableInput

Outputs

residuals

0: normalized residuals (aka field 1 - field 2) as a field or field container, normalized depending on the normalization type

Type: LinkableOutput

error

1: error as a field or a field container depending on the entry's type.

Type: LinkableOutput

residuals_normalization_factor

2: factor used for residual normalization

Type: LinkableOutput

error_normalization_factor

3: factor used for error norm normalization

Type: LinkableOutput

Constructors

Constructor

compute_residual_and_error()

Constructor

compute_residual_and_error(field_or_fields_container1, normalization_type, norm_calculation_type, field_reference, field_or_fields_container2, config)

Parameters:

• field_or_fields_container1 (object)
• normalization_type (object)
• norm_calculation_type (object)
• field_reference (object)
• field_or_fields_container2 (object)
• config (OperatorConfig)

Constructor

compute_residual_and_error(config)

Parameters:

• config (OperatorConfig)

Methods

Properties

inputs

Type: InputSpec

# Get or set the property
value = obj.inputs
obj.inputs = new_value

outputs

Type: OutputSpec

# Get or set the property
value = obj.outputs
obj.outputs = new_value

defaultConfig

Type: Config

# Get the property (read-only)
value = obj.defaultConfig