DomainDifference

class DomainDifference(*args)

A Domain representing the difference of two Domain.

A point is inside this domain if it is contained in left domain but not in right domain.

Available constructors:

DomainDifference(left, right)

Parameters
leftDomain

The first domain

rightDomain

The second domain

Methods

contains(self, \*args)

Check if the given point is inside of the domain.

getClassName(self)

Accessor to the object’s name.

getDimension(self)

Get the dimension of the domain.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setName(self, name)

Accessor to the object’s name.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

contains(self, \*args)

Check if the given point is inside of the domain.

Parameters
pointsequence of float

Point with the same dimension as the current domain’s dimension.

Returns
isInsidebool

Flag telling whether the point is inside this domain, which means that is is inside left domain, but not inside right domain.

Examples

>>> import openturns as ot
>>> # First domain
>>> interval2d = ot.Interval([-1.0, -1.0], [0.5, 0.5])
>>> # Second domain
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [1.5, 1.0]]
>>> simplices = [[0, 1, 2], [1, 2, 3]]
>>> mesh2d = ot.Mesh(vertices, simplices)
>>> difference = ot.DomainDifference(interval2d, mesh2d)
>>> [0.2, 0.1] in difference
False
>>> [0.1, 0.2] in difference
True
getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getDimension(self)

Get the dimension of the domain.

Returns
dimint

Dimension of the domain.

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.