mapping_control

class ansys.systemcoupling.core.adaptor.api_24_2.mapping_control.mapping_control(name=None, parent=None)

Bases: Container

Configure controls for mapping.

Properties

stop_if_poor_intersectionbool

Controls whether to stop if the intersection is poor

poor_intersection_thresholdRealType

System Coupling terminates with an error if the intersected fractions are below this threshold (in both directions)

face_alignmentstr

Controls how face alignment is used during mapping.

Allowed values:

• “ProgramControlled” (default)

• “OppositeOrientation”

• “SameOrientation”

• “AnyOrientation”

absolute_gap_toleranceRealType

Absolute gap tolerance value.

relative_gap_toleranceRealType

Maximum gap size relative to face size.

small_weight_toleranceRealType

Relative tolerance used to control when weights are dropped.

corner_toleranceRealType

Angle [degrees] between adjacent source mesh faces above which the mapping algorithm will stop searching for mapping candidates.

halo_toleranceRealType

If a face intersects but a target node lies outside of the source face, then map the node if the projected distance to the face / sqrt(srcArea) is less than this tolerance, otherwise leave as unmapped.

conservative_reciprocity_factorRealType

Reciprocity blend factor for conservative mapping.

profile_preserving_reciprocity_factorRealType

Reciprocity blend factor for profile-preserving mapping.

conservative_intensivestr

Determines when the Intensive option is used for conservative mapping.

Allowed values:

• “ProgramControlled” (default)

• “Off”

• “On”

preserve_normalstr

Determines if the normal component of a vector is preserved.

Allowed values:

• “ProgramControlled” (default)

• “Off”

• “On”

conservation_fix_tolerance_volumeRealType

Source element overlap fraction to trigger volume mapping conservation fix.

0.0 is default. 1.0 effectively disables it.

rbf_optionstr

Controls radial basis function formulation.

Allowed values:

• “Gaussian” (default)

• “ThinPlateSpline”

rbf_shape_parameterRealType

Sets the shape parameter beta when using Gaussian radial basis functions.

rbf_linear_correctionbool

Controls whether linear polynomial augmentation is added to the RBF stencil for low order regular element types (tet, hex, pyramid, wedge).

rbf_clipping_scaleRealType

Length scale factor used to determine if source nodes are removed from RBF stencil when too close.

clippingbool

Controls whether to clip target values to the min/max of the local source values for profile-preserving transfers.

Included in:

Parent	Summary
coupling_interface_child	Configure a coupling interface.