Skip to main content

DPF Mechanical 2026 R1

included_fields class

Last update: 18.06.2026

Namespace: Ans.DataProcessing.operators.logic

Summary

Checks if one field belongs to another.

available inputs: fieldA (Field), fieldB (Field), double_value (double), double_tolerance (double) (optional)

available outputs: included (bool), message (string)

Example

op = included_fields()

op = included_fields(fieldA=my_fieldA,fieldB=my_fieldB,double_value=my_double_value,double_tolerance=my_double_tolerance)

Class Information

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

Inputs

fieldA

Type: LinkableInput

fieldB

Type: LinkableInput

double_value

Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14).

Type: LinkableInput

double_tolerance

Type: LinkableInput

Outputs

included

bool (true if belongs...)

Type: LinkableOutput

message

Type: LinkableOutput

Constructors

Constructor

included_fields()

Constructor

included_fields(fieldA, fieldB, double_value, double_tolerance, config)

Parameters:

  • fieldA (object)
  • fieldB (object)
  • double_value (object)
  • double_tolerance (object)
  • config (OperatorConfig)

Constructor

included_fields(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

Connect with Ansys