/usr/include/openturns/swig/LevelSetMesher_doc.i is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | %feature("docstring") OT::LevelSetMesher
"Creation of mesh of box type.
Available constructor:
LevelSetMesher(*discretization*)
Parameters
----------
discretization : sequence of int, of dimension :math:`\\\\leq 3`.
Discretization of the level set bounding box.
solver : :class:`~openturns.OptimizationAlgorithm`
Optimization solver used to project the vertices onto the level set.
It must be able to solve nearest point problems.
Default is :class:`~openturns.AbdoRackwitz`.
Notes
-----
The meshing algorithm is based on the :class:`~openturns.IntervalMesher` class.
First, the bounding box of the level set (provided by the user or automatically
computed) is meshed. Then, all the simplices with all vertices outside of the
level set are rejected, while the simplices with all vertices inside of the level
set are kept. The remaining simplices are adapted the following way :
* The mean point of the vertices inside of the level set is computed
* Each vertex outside of the level set is projected onto the level set using
a linear interpolation
* If the *project* flag is *True*, then the projection is refined using an
optimization solver.
Examples
--------
Create a mesh:
>>> import openturns as ot
>>> mesher = ot.LevelSetMesher([5, 10])
>>> level = 1.0
>>> function = ot.SymbolicFunction(['x0', 'x1'], ['x0^2+x1^2'])
>>> levelSet = ot.LevelSet(function, level)
>>> mesh = mesher.build(levelSet)"
// ---------------------------------------------------------------------
%feature("docstring") OT::LevelSetMesher::build
"Build the mesh of level set type.
Parameters
----------
levelSet : :class:`~openturns.LevelSet`
The level set to be meshed, of dimension equal to the dimension
of `discretization`.
boundingBox : :class:`~openturns.Interval`
The bounding box used to mesh the level set. By default it is automatically computed from the elements of the given level set.
project : bool
Flag to tell if the vertices outside of the level set of a simplex partially included into the level set have to be projected onto the level set. Default is *True*.
Returns
-------
mesh : :class:`~openturns.Mesh`
The mesh built."
// ---------------------------------------------------------------------
%feature("docstring") OT::LevelSetMesher::getDiscretization
"Accessor to the discretization.
Returns
-------
discretization : :class:`~openturns.Indices`
Discretization of the bounding box of the level sets."
// ---------------------------------------------------------------------
%feature("docstring") OT::LevelSetMesher::setDiscretization
"Accessor to the discretization.
Parameters
----------
discretization : sequence of int
Discretization of the bounding box of the level sets."
// ---------------------------------------------------------------------
%feature("docstring") OT::LevelSetMesher::getOptimizationAlgorithm
"Accessor to the optimization solver.
Returns
-------
solver : :class:`~openturns.OptimizationAlgorithm`
The optimization solver used to project vertices onto the level set."
// ---------------------------------------------------------------------
%feature("docstring") OT::LevelSetMesher::setOptimizationAlgorithm
"Accessor to the optimization solver.
Parameters
----------
solver : :class:`~openturns.OptimizationAlgorithm`
The optimization solver used to project vertices onto the level set."
|