RegularGrid¶

class RegularGrid(*args)

Regular Grid.

Available constructors:

RegularGrid(start, step, n)

RegularGrid(mesh)

Parameters: start : float The start time stamp of the grid. step : float, positive The step between to consecutive time stamps. n : int The number of time stamps in the grid, including the start and the end time stamps. mesh : Mesh The mesh must be in , regular and sorted in the increasing order.

Notes

The time stamps of the regular grid are: where for and the step.

Examples

>>> import openturns as ot
>>> myRegularGrid = ot.RegularGrid(0.0, 0.1, 100)


Methods

 ImportFromMSHFile(fileName) Import mesh from FreeFem 2-d mesh files. checkPointInSimplexWithCoordinates(point, index) Check if a point is inside a simplex and returns its barycentric coordinates. computeP1Gram() Compute the P1 Lagrange finite element gram matrix of the mesh. computeSimplicesVolume() Compute the volume of all simplices. computeWeights() Compute an approximation of an integral defined over the mesh. draw() Draw the mesh. draw1D() Draw the mesh of dimension 1. draw2D() Draw the mesh of dimension 2. draw3D(*args) Draw the bidimensional projection of the mesh. exportToVTKFile(*args) Export the mesh to a VTK file. fixOrientation() Make all the simplices positively oriented. follows(starter) Check if the given grid follows the current one. getClassName() Accessor to the object’s name. getDescription() Get the description of the vertices. getDimension() Dimension accessor. getEnd() Accessor to the first time stamp after the last time stamp of the grid. getId() Accessor to the object’s id. getN() Accessor to the number of time stamps in the grid. getName() Accessor to the object’s name. getShadowedId() Accessor to the object’s shadowed id. getSimplex(index) Get the simplex of a given index. getSimplices() Get the simplices of the mesh. getSimplicesNumber() Get the number of simplices of the mesh. getStart() Accessor to the start time stamp. getStep() Accessor to the step. getValue(i) Accessor to the time stamps at a gien index. getValues() Accessor to all the time stamps. getVertex(index) Get the vertex of a given index. getVertices() Get the vertices of the mesh. getVerticesNumber() Get the number of vertices of the mesh. getVisibility() Accessor to the object’s visibility state. getVolume() Get the volume of the mesh. hasName() Test if the object is named. hasVisibleName() Test if the object has a distinguishable name. isEmpty() Check whether the mesh is empty. isNumericallyEmpty() Check if the mesh is numerically empty. isRegular() Check if the mesh is regular (only for 1-d meshes). isValid() Check the mesh validity. setName(name) Accessor to the object’s name. setShadowedId(id) Accessor to the object’s shadowed id. setSimplices(simplices) Set the simplices of the mesh. setVertex(index, vertex) Set a vertex of a given index. setVertices(vertices) Set the vertices of the mesh. setVisibility(visible) Accessor to the object’s visibility state. streamToVTKFormat(*args) Give a VTK representation of the mesh.
 getLowerBound getUpperBound
__init__(*args)

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

static ImportFromMSHFile(fileName)

Import mesh from FreeFem 2-d mesh files.

Parameters: MSHFile : str A MSH ASCII file. mesh : Mesh Mesh defined in the file MSHFile.
checkPointInSimplexWithCoordinates(point, index)

Check if a point is inside a simplex and returns its barycentric coordinates.

Parameters: point : sequence of float Point of dimension , the dimension of the vertices of the mesh. index : int Integer characterizes one simplex of the mesh. isInside : bool Flag telling whether point is inside the simplex of index index. coordinates : Point The barycentric coordinates of the given point wrt the vertices of the simplex .

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplex = [[0, 1, 2]]
>>> mesh2d = ot.Mesh(vertices, simplex)
>>> # Create a point A inside the simplex
>>> pointA = [0.6, 0.3]
>>> print(mesh2d.checkPointInSimplexWithCoordinates(pointA, 0))
[True, class=Point name=Unnamed dimension=3 values=[0.4,0.3,0.3]]
>>> # Create a point B outside the simplex
>>> pointB = [1.1, 0.6]
>>> print(mesh2d.checkPointInSimplexWithCoordinates(pointB, 0))
[False, class=Point name=Unnamed dimension=3 values=[-0.1,0.5,0.6]]

computeP1Gram()

Compute the P1 Lagrange finite element gram matrix of the mesh.

Returns: gram : CovarianceMatrix P1 Lagrange finite element gram matrix of the mesh.

Notes

The P1 Lagrange finite element space associated to a mesh with vertices is the space of piecewise-linear functions generated by the functions , where , for and the restriction of to any simplex is an affine function. The vertices that are not included into at least one simplex are not taken into account.

The gram matrix of the mesh is defined as the symmetric positive definite matrix whose generic element is given by:

This method is used in several algorithms related to stochastic process representation such as the Karhunen-Loeve decomposition.

Examples

>>> import openturns as ot
>>> # Define the vertices of the mesh
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [1.5, 1.0]]
>>> # Define the simplices of the mesh
>>> simplices = [[0, 1, 2], [1, 2, 3]]
>>> # Create the mesh of dimension 2
>>> mesh2d = ot.Mesh(vertices, simplices)
>>> print(mesh2d.computeP1Gram())
[[ 0.0416667 0.0208333 0.0208333 0         ]
[ 0.0208333 0.0625    0.03125   0.0104167 ]
[ 0.0208333 0.03125   0.0625    0.0104167 ]
[ 0         0.0104167 0.0104167 0.0208333 ]]

computeSimplicesVolume()

Compute the volume of all simplices.

Returns: volume : Point Volume of all simplices.

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplex = [[0, 1, 2]]
>>> mesh2d = ot.Mesh(vertices, simplex)
>>> print(mesh2d.computeSimplicesVolume())
[0.5]

computeWeights()

Compute an approximation of an integral defined over the mesh.

Returns: weights : Point Weights such that an integral of a function over the mesh is a weighted sum of its values at the vertices.
draw()

Draw the mesh.

Returns: graph : Graph If the dimension of the mesh is 1, it draws the corresponding interval, using the draw1D() method; if the dimension is 2, it draws the triangular simplices, using the draw2D() method; if the dimension is 3, it projects the simplices on the plane of the two first components, using the draw3D() method with its default parameters, superposing the simplices.
draw1D()

Draw the mesh of dimension 1.

Returns: graph : Graph Draws the line linking the vertices of the mesh when the mesh is of dimension 1.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> vertices = [[0.5], [1.5], [2.1], [2.7]]
>>> simplices = [[0, 1], [1, 2], [2, 3]]
>>> mesh1d = ot.Mesh(vertices, simplices)
>>> # Create a graph
>>> aGraph = mesh1d.draw1D()
>>> # Draw the mesh
>>> View(aGraph).show()

draw2D()

Draw the mesh of dimension 2.

Returns: graph : Graph Draws the edges of each simplex, when the mesh is of dimension 2.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> 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)
>>> # Create a graph
>>> aGraph = mesh2d.draw2D()
>>> # Draw the mesh
>>> View(aGraph).show()

draw3D(*args)

Draw the bidimensional projection of the mesh.

Available usages:

draw3D(drawEdge=True, thetaX=0.0, thetaY=0.0, thetaZ=0.0, shading=False, rho=1.0)

Parameters: drawEdge : bool Tells if the edge of each simplex has to be drawn. thetaX : float Gives the value of the rotation along the X axis in radian. thetaY : float Gives the value of the rotation along the Y axis in radian. thetaZ : float Gives the value of the rotation along the Z axis in radian. rotation : SquareMatrix Operates a rotation on the mesh before its projection of the plane of the two first components. shading : bool Enables to give a visual perception of depth and orientation. rho : float, Contraction factor of the simplices. If , all the simplices are contracted and appear deconnected: some holes are created, which enables to see inside the mesh. If , the simplices keep their initial size and appear connected. If , each simplex is reduced to its gravity center. graph : Graph Draws the bidimensional projection of the mesh on the plane.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> from math import cos, sin, pi
>>> vertices = [[0.0, 0.0, 0.0], [0.0, 0.0, 1.0], [0.0, 1.0, 0.0],
...             [0.0, 1.0, 1.0], [1.0, 0.0, 0.0], [1.0, 0.0, 1.0],
...             [1.0, 1.0, 0.0], [1.0, 1.0, 1.0]]
>>> simplices = [[0, 1, 2, 4], [3, 5, 6, 7],[1, 2, 3, 6],
...              [1, 2, 4, 6], [1, 3, 5, 6], [1, 4, 5, 6]]
>>> mesh3d = ot.Mesh(vertices, simplices)
>>> # Create a graph
>>> aGraph = mesh3d.draw3D()
>>> # Draw the mesh
>>> View(aGraph).show()
>>> rotation = ot.SquareMatrix(3)
>>> rotation[0, 0] = cos(pi / 3.0)
>>> rotation[0, 1] = sin(pi / 3.0)
>>> rotation[1, 0] = -sin(pi / 3.0)
>>> rotation[1, 1] = cos(pi / 3.0)
>>> rotation[2, 2] = 1.0
>>> # Create a graph
>>> aGraph = mesh3d.draw3D(True, rotation, True, 1.0)
>>> # Draw the mesh
>>> View(aGraph).show()

exportToVTKFile(*args)

Export the mesh to a VTK file.

Parameters: myVTKFile.vtk : str Name of the created file which contains the mesh and the associated random values that can be visualized with the open source software Paraview.
fixOrientation()

Make all the simplices positively oriented.

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplex = [[0, 2, 1]]
>>> mesh2d = ot.Mesh(vertices, simplex)
>>> print(mesh2d)
class=Mesh name=Unnamed dimension=2 vertices=class=Sample name=Unnamed implementation=class=SampleImplementation name=Unnamed size=3 dimension=2 data=[[0,0],[1,0],[1,1]] simplices=[[0,2,1]]
>>> mesh2d.fixOrientation()
>>> print(mesh2d)
class=Mesh name=Unnamed dimension=2 vertices=class=Sample name=Unnamed implementation=class=SampleImplementation name=Unnamed size=3 dimension=2 data=[[0,0],[1,0],[1,1]] simplices=[[2,0,1]]

follows(starter)

Check if the given grid follows the current one.

Parameters: newGrid : RegularGrid A new regular grid. answer : boolean The answer is True if the newGrid directly follows the current one.
getClassName()

Accessor to the object’s name.

Returns: class_name : str The object class name (object.__class__.__name__).
getDescription()

Get the description of the vertices.

Returns: description : str Description of the vertices.

Examples

>>> import openturns as ot
>>> mesh = ot.Mesh()
>>> vertices = ot.Sample([[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]])
>>> vertices.setDescription(['X', 'Y'])
>>> mesh.setVertices(vertices)
>>> print(mesh.getDescription())
[X,Y]

getDimension()

Dimension accessor.

Returns: dimension : int Dimension of the vertices.
getEnd()

Accessor to the first time stamp after the last time stamp of the grid.

Returns: endPoint : float The first point that follows the last point of the grid: . The end point is not in the grid.
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getN()

Accessor to the number of time stamps in the grid.

Returns: n : int The number of time stamps in the grid.
getName()

Accessor to the object’s name.

Returns: name : str The name of the object.
getShadowedId()

Accessor to the object’s shadowed id.

Returns: id : int Internal unique identifier.
getSimplex(index)

Get the simplex of a given index.

Parameters: index : int Index characterizing one simplex of the mesh. indices : Indices Indices defining the simplex of index index. The simplex relies the vertices of index in . In dimension 1, a simplex is an interval ; in dimension 2, it is a triangle .

Examples

>>> import openturns as ot
>>> 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)
>>> print(mesh2d.getSimplex(0))
[0,1,2]
>>> print(mesh2d.getSimplex(1))
[1,2,3]

getSimplices()

Get the simplices of the mesh.

Returns: indicesCollection : collection of Indices List of indices defining all the simplices. The simplex relies the vertices of index in . In dimension 1, a simplex is an interval ; in dimension 2, it is a triangle .

Examples

>>> import openturns as ot
>>> 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)
>>> print(mesh2d.getSimplices())
[[0,1,2],[1,2,3]]

getSimplicesNumber()

Get the number of simplices of the mesh.

Returns: number : int Number of simplices of the mesh.
getStart()

Accessor to the start time stamp.

Returns: start : float The start point of the grid.
getStep()

Accessor to the step.

Returns: step : float The step between two consecutive time stamps.
getValue(i)

Accessor to the time stamps at a gien index.

Parameters: k : int, . Index of a time stamp. value : float The time stamp .
getValues()

Accessor to all the time stamps.

Returns: values : Point The collection of the time stamps.
getVertex(index)

Get the vertex of a given index.

Parameters: index : int Index characterizing one vertex of the mesh. vertex : Point Coordinates in of the vertex of index index, where is the dimension of the vertices of the mesh.

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplices = [[0, 1, 2]]
>>> mesh2d = ot.Mesh(vertices, simplices)
>>> print(mesh2d.getVertex(1))
[1,0]
>>> print(mesh2d.getVertex(0))
[0,0]

getVertices()

Get the vertices of the mesh.

Returns: vertices : Sample Coordinates in of the vertices, where is the dimension of the vertices of the mesh.

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplices = [[0, 1, 2]]
>>> mesh2d = ot.Mesh(vertices, simplices)
>>> print(mesh2d.getVertices())
0 : [ 0 0 ]
1 : [ 1 0 ]
2 : [ 1 1 ]

getVerticesNumber()

Get the number of vertices of the mesh.

Returns: number : int Number of vertices of the mesh.
getVisibility()

Accessor to the object’s visibility state.

Returns: visible : bool Visibility flag.
getVolume()

Get the volume of the mesh.

Returns: volume : float Geometrical volume of the mesh which is the sum of its simplices’ volumes.

Examples

>>> import openturns as ot
>>> 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)
>>> mesh2d.getVolume()
0.75

hasName()

Test if the object is named.

Returns: hasName : bool True if the name is not empty.
hasVisibleName()

Test if the object has a distinguishable name.

Returns: hasVisibleName : bool True if the name is not empty and not the default one.
isEmpty()

Check whether the mesh is empty.

Returns: empty : bool Tells if the mesh is empty, ie if its volume is null.
isNumericallyEmpty()

Check if the mesh is numerically empty.

Returns: isEmpty : bool Flag telling whether the mesh is numerically empty, i.e. if its numerical volume is inferior or equal to (defined in the ResourceMap: = Domain-SmallVolume).

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplex = [[0, 1, 2]]
>>> mesh2d = ot.Mesh(vertices, simplex)
>>> print(mesh2d.isNumericallyEmpty())
False

isRegular()

Check if the mesh is regular (only for 1-d meshes).

Returns: isRegular : bool Tells if the mesh is regular or not.

Examples

>>> import openturns as ot
>>> vertices = [[0.5], [1.5], [2.4], [3.5]]
>>> simplices = [[0, 1], [1, 2], [2, 3]]
>>> mesh1d = ot.Mesh(vertices, simplices)
>>> print(mesh1d.isRegular())
False
>>> vertices = [[0.5], [1.5], [2.5], [3.5]]
>>> mesh1d = ot.Mesh(vertices, simplices)
>>> print(mesh1d.isRegular())
True

isValid()

Check the mesh validity.

Returns: validity : bool Tells if the mesh is valid i.e. if there is non-overlaping simplices, no unused vertex, no simplices with duplicate vertices and no coincident vertices.
setName(name)

Accessor to the object’s name.

Parameters: name : str The name of the object.
setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters: id : int Internal unique identifier.
setSimplices(simplices)

Set the simplices of the mesh.

Parameters: indices : 2-d sequence of int List of indices defining all the simplices. The simplex relies the vertices of index in . In dimension 1, a simplex is an interval ; in dimension 2, it is a triangle .

Examples

>>> import openturns as ot
>>> mesh = ot.Mesh()
>>> simplices = [[0, 1, 2], [1, 2, 3]]
>>> mesh.setSimplices(simplices)

setVertex(index, vertex)

Set a vertex of a given index.

Parameters: index : int Index of the vertex to set. vertex : sequence of float Cordinates in of the vertex of index index, where is the dimension of the vertices of the mesh.

Examples

>>> import openturns as ot
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> simplices = [[0, 1, 2]]
>>> mesh = ot.Mesh(vertices, simplices)
>>> vertex = [0.0, 0.5]
>>> mesh.setVertex(0, vertex)
>>> print(mesh.getVertices())
0 : [ 0   0.5 ]
1 : [ 1   0   ]
2 : [ 1   1   ]

setVertices(vertices)

Set the vertices of the mesh.

Parameters: vertices : 2-d sequence of float Cordinates in of the vertices, where is the dimension of the vertices of the mesh.

Examples

>>> import openturns as ot
>>> mesh = ot.Mesh()
>>> vertices = [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]]
>>> mesh.setVertices(vertices)

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters: visible : bool Visibility flag.
streamToVTKFormat(*args)

Give a VTK representation of the mesh.

Returns: stream : str VTK representation of the mesh.