MeshDomain

class MeshDomain(*args)

Adaptor to convert a Mesh to a Domain.

Parameters:
meshMesh

Underlying mesh.

enclosingSimplexEnclosingSimplexAlgorithm, optional

Algorithm to use for point location.

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)
>>> domain = ot.MeshDomain(mesh2d)
>>> x = [0.2, 0.1]
>>> inside = (x in domain)

Methods

computeDistance(*args)

Compute the Euclidean distance of a given point to the domain.

contains(*args)

Check if the given point is inside of the domain.

getClassName()

Accessor to the object's name.

getDimension()

Get the dimension of the domain.

getEnclosingSimplexAlgorithm()

Get the simplex algorithm.

getLowerBound()

Get the lower bound.

getMesh()

Get the mesh.

getName()

Accessor to the object's name.

getUpperBound()

Get the upper bound.

hasName()

Test if the object is named.

setEnclosingSimplexAlgorithm(enclosingSimplex)

Set the simplex algorithm.

setName(name)

Accessor to the object's name.

__init__(*args)
computeDistance(*args)

Compute the Euclidean distance of a given point to the domain.

Parameters:
point or samplesequence of float or 2-d sequence of float

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

Returns:
distancefloat or Sample

Euclidean distance of the point to the domain.

contains(*args)

Check if the given point is inside of the domain.

Parameters:
point or samplesequence of float or 2-d sequence of float

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

Returns:
isInsidebool or sequence of bool

Flag telling whether the given point is inside of the domain.

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getDimension()

Get the dimension of the domain.

Returns:
dimint

Dimension of the domain.

getEnclosingSimplexAlgorithm()

Get the simplex algorithm.

Returns:
algoEnclosingSimplexAlgorithm

Simplex algorithm.

getLowerBound()

Get the lower bound.

Returns:
lowerBoundPoint

Value of the lower bound.

Examples

>>> import openturns as ot
>>> interval = ot.Interval([2.0, 3.0], [4.0, 5.0], [True, False], [True, True])
>>> print(interval.getLowerBound())
[2,3]
getMesh()

Get the mesh.

Returns:
meshMesh

Underlying mesh.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getUpperBound()

Get the upper bound.

Returns:
upperBoundPoint

Value of the upper bound.

Examples

>>> import openturns as ot
>>> interval = ot.Interval([2.0, 3.0], [4.0, 5.0], [True, False], [True, True])
>>> print(interval.getUpperBound())
[4,5]
hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

setEnclosingSimplexAlgorithm(enclosingSimplex)

Set the simplex algorithm.

Parameters:
algoEnclosingSimplexAlgorithm

Simplex algorithm.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.