All Superinterfaces:

IPlotAndImageExport, ModelEntity, PrimitiveModelEntity, SelectionContainer
```
public interface Pair
extends ModelEntity, SelectionContainer, IPlotAndImageExport
```
Pair.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`compatibleMeshesTol()`	Gets tolerance for when elementwise mapping for compatible meshes should regard the meshes as compatible.
`Pair`	`compatibleMeshesTol(java.lang.String value)`	Sets tolerance for when elementwise mapping for compatible meshes should regard the meshes as compatible.
`LocalSelection`	`destination()`	Gets destination selection.
`java.lang.String`	`dstFrame()`	Gets destination frame.
`Pair`	`dstFrame(java.lang.String frame)`	Sets destination frame.
`java.lang.String`	`elementwise()`	Gets strategy for elementwise mapping for compatible meshes.
`Pair`	`elementwise(java.lang.String value)`	Sets strategy for elementwise mapping for compatible meshes.
`java.lang.String`	`gapName(boolean src2dst)`	Gets name of geometric gap variable seen from the destination (if src2dst) or seen from the source (if !src2dst).
`boolean`	`hasAutoSelection()`	True if pair was created automatically when building geometry.
`java.lang.String`	`inContactName()`	Gets name of in-contact variable that evaluates to zero or one depending on if the pair is in contact.
`java.lang.String`	`initGapName(boolean src2dst)`	Gets name of initial geometric gap variable seen from the destination (if src2dst) or seen from the source (if !src2dst).
`boolean`	`manualDist()`	Returns `true` if manual control of search distance is enabled.
`Pair`	`manualDist(boolean manual)`	Enables or disables manual control of search distance.
`boolean`	`manualFrame()`	True if automatically created pair is in manual frame mode.
`Pair`	`manualFrame(boolean manual)`	Sets manual mode for the frames in automatic pairs.
`boolean`	`manualSelection()`	True if automatically created pair is in manual selection mode.
`Pair`	`manualSelection(boolean manualSelection)`	Sets manual mode for selections in automatic pairs.
`java.lang.String`	`mapping()`	Returns the method used for mapping in contact pairs.
`Pair`	`mapping(java.lang.String method)`	Sets the method used for mapping in contact pairs.
`java.lang.String`	`mphOpName(boolean src2dst)`	Gets name of the multiphysics operator transferring an expression from source to destination (if src2dst) or from destination to source if (!src2dst).
`java.lang.String`	`opName(boolean src2dst)`	Gets name of operator transferring an expression from source to destination (if src2dst) or from destination to source (if !src2dst).
`java.lang.String`	`pairName()`	Gets pair name.
`Pair`	`pairName(java.lang.String name)`	Sets pair name.
`java.lang.String`	`searchDist()`	Gets search distance.
`Pair`	`searchDist(java.lang.String dist)`	Sets search distance.
`java.lang.String`	`searchMethod()`	Gets search method.
`Pair`	`searchMethod(java.lang.String method)`	Sets search method.
`java.lang.String`	`searchTol()`	Gets search tolerance.
`Pair`	`searchTol(java.lang.String tol)`	Sets search tolerance.
`LocalSelection`	`source()`	Gets source selection.
`java.lang.String`	`srcFrame()`	Gets source frame.
`Pair`	`srcFrame(java.lang.String frame)`	Sets source frame.
`Pair`	`swap()`	Swap source and destination selections.
`java.lang.String`	`type()`	Gets pair type.
`Pair`	`type(java.lang.String type)`	Sets pair type.

Methods inherited from interface com.comsol.model.IPlotAndImageExport
image

Methods inherited from interface com.comsol.model.ModelEntity
active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity
getContainer, getDisplayString, resolveModelPath

- Method Detail
  - compatibleMeshesTol
```
java.lang.String compatibleMeshesTol()
```
    Gets tolerance for when elementwise mapping for compatible meshes should regard the meshes as compatible. This is a relative tolerance compared to the size of the mesh element.
    
    Returns:
    
    String representing a positive real number.
  - compatibleMeshesTol
```
Pair compatibleMeshesTol(java.lang.String value)
```
    Sets tolerance for when elementwise mapping for compatible meshes should regard the meshes as compatible. This is a relative tolerance compared to the size of the mesh element. Used only for identity pairs.
    
    Parameters:
    
    value - String representing a positive real number.
    
    Returns:
    
    Pair.
  - destination
```
LocalSelection destination()
```
    Gets destination selection.
    
    Returns:
    
    Destination selection.
  - dstFrame
```
java.lang.String dstFrame()
```
    Gets destination frame.
    
    Returns:
    
    Destination frame.
  - dstFrame
```
Pair dstFrame(java.lang.String frame)
```
    Sets destination frame. Used only for identity pairs.
    
    Parameters:
    
    frame - Destination frame.
    
    Returns:
    
    Pair.
  - elementwise
```
java.lang.String elementwise()
```
    Gets strategy for elementwise mapping for compatible meshes. Possible values are on, off, require.
    
    Returns:
    
    String representing elementwise mapping strategy.
  - elementwise
```
Pair elementwise(java.lang.String value)
```
    Sets strategy for elementwise mapping for compatible meshes. Allowed values are on, off, require. Used only for identity pairs.
    
    Parameters:
    
    value - String representing elementwise mapping strategy.
    
    Returns:
    
    Pair.
  - gapName
```
java.lang.String gapName(boolean src2dst)
```
    Gets name of geometric gap variable seen from the destination (if src2dst) or seen from the source (if !src2dst). Used only for contact pairs.
    
    Parameters:
    
    src2dst - src2dst true to see from the destination.
    
    Returns:
    
    Name of geometric gap variable.
  - hasAutoSelection
```
boolean hasAutoSelection()
```
    True if pair was created automatically when building geometry.
    
    Returns:
    
    true if pair was created automatically.
  - inContactName
```
java.lang.String inContactName()
```
    Gets name of in-contact variable that evaluates to zero or one depending on if the pair is in contact. An identity pair is in contact whenever the source and destination side overlap. A contact pair uses the gap variable to decide the in contact condition.
    
    Returns:
    
    Name of in-contact variable.
  - initGapName
```
java.lang.String initGapName(boolean src2dst)
```
    Gets name of initial geometric gap variable seen from the destination (if src2dst) or seen from the source (if !src2dst). Used only for contact pairs.
    
    Parameters:
    
    src2dst - src2dst true to see from the destination.
    
    Returns:
    
    Name of initial geometric gap variable.
  - manualDist
```
boolean manualDist()
```
    Returns true if manual control of search distance is enabled.
    
    Returns:
    
    true for manual control.
  - manualDist
```
Pair manualDist(boolean manual)
```
    Enables or disables manual control of search distance.
    
    Parameters:
    
    manual - true to enable manual control.
    
    Returns:
    
    Pair.
  - manualFrame
```
boolean manualFrame()
```
    True if automatically created pair is in manual frame mode.
    
    Returns:
    
    true if frames are set manually.
  - manualFrame
```
Pair manualFrame(boolean manual)
```
    Sets manual mode for the frames in automatic pairs.
    
    Parameters:
    
    manual - true to set frames manually.
    
    Returns:
    
    Pair.
  - manualSelection
```
boolean manualSelection()
```
    True if automatically created pair is in manual selection mode.
    
    Returns:
    
    true if in manual selection mode.
  - manualSelection
```
Pair manualSelection(boolean manualSelection)
```
    Sets manual mode for selections in automatic pairs.
    
    Parameters:
    
    manualSelection - true if manual selections.
    
    Returns:
    
    Pair.
  - mapping
```
java.lang.String mapping()
```
    Returns the method used for mapping in contact pairs.
    
    Returns:
    
    Mapping method.
  - mapping
```
Pair mapping(java.lang.String method)
```
    Sets the method used for mapping in contact pairs.
    
    Parameters:
    
    method - Mapping method.
    
    Returns:
    
    Pair.
  - mphOpName
```
java.lang.String mphOpName(boolean src2dst)
```
    Gets name of the multiphysics operator transferring an expression from source to destination (if src2dst) or from destination to source if (!src2dst). When the test operator is applied on this operator, it does not give any contribution (reaction force) on the SME interface's degrees of freedom due to the variable point mapping. Used only for contact pairs.
    
    Parameters:
    
    src2dst - true for source to destination.
    
    Returns:
    
    Operator name.
  - opName
```
java.lang.String opName(boolean src2dst)
```
    Gets name of operator transferring an expression from source to destination (if src2dst) or from destination to source (if !src2dst).
    
    Parameters:
    
    src2dst - true for source to destination.
    
    Returns:
    
    Operator name.
  - pairName
```
java.lang.String pairName()
```
    Gets pair name.
    
    Returns:
    
    Pair name.
  - pairName
```
Pair pairName(java.lang.String name)
```
    Sets pair name. The pair name is used as a suffix in variable names and operator names.
    
    Parameters:
    
    name - Pair name.
    
    Returns:
    
    Pair.
  - searchDist
```
java.lang.String searchDist()
```
    Gets search distance.
    
    Returns:
    
    String representing search distance.
  - searchDist
```
Pair searchDist(java.lang.String dist)
```
    Sets search distance. The default unit is the geometry's length unit.
    
    Parameters:
    
    dist - String representing search distance.
    
    Returns:
    
    Pair.
  - searchMethod
```
java.lang.String searchMethod()
```
    Gets search method.
    
    Returns:
    
    Search method: hierarchical, fast or direct.
  - searchMethod
```
Pair searchMethod(java.lang.String method)
```
    Sets search method. Used only for contact pairs.
    
    Parameters:
    
    method - Search method: hierarchical, fast or direct.
    
    Returns:
    
    Pair.
  - searchTol
```
java.lang.String searchTol()
```
    Gets search tolerance.
    
    Returns:
    
    String representing search tolerance.
  - searchTol
```
Pair searchTol(java.lang.String tol)
```
    Sets search tolerance. Used only for contact pairs.
    
    Parameters:
    
    tol - String representing search tolerance.
    
    Returns:
    
    Pair.
  - source
```
LocalSelection source()
```
    Gets source selection.
    
    Returns:
    
    Source selection.
  - srcFrame
```
java.lang.String srcFrame()
```
    Gets source frame.
    
    Returns:
    
    Source frame.
  - srcFrame
```
Pair srcFrame(java.lang.String frame)
```
    Sets source frame. Used only for identity pairs.
    
    Parameters:
    
    frame - Source frame.
    
    Returns:
    
    Pair.
  - swap
```
Pair swap()
```
    Swap source and destination selections.
    
    Returns:
    
    Pair.
  - type
```
java.lang.String type()
```
    Gets pair type.
    
    Returns:
    
    Pair type: Contact or Identity.
  - type
```
Pair type(java.lang.String type)
```
    Sets pair type.
    
    Parameters:
    
    type - Pair type: Contact or Identity.
    
    Returns:
    
    Pair.

Interface Pair

Method Summary

Methods inherited from interface com.comsol.model.IPlotAndImageExport

Methods inherited from interface com.comsol.model.ModelEntity

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

Method Detail

compatibleMeshesTol

compatibleMeshesTol

destination

dstFrame

dstFrame

elementwise

elementwise

gapName

hasAutoSelection

inContactName

initGapName

manualDist

manualDist

manualFrame

manualFrame

manualSelection

manualSelection

mapping

mapping

mphOpName

opName

pairName

pairName

searchDist

searchDist

searchMethod

searchMethod

searchTol

searchTol

source

srcFrame

srcFrame

swap

type

type