1%feature("docstring") OT::P1LagrangeInterpolation
2"P1 interpolation of values between two meshes.
3
4This class is a :class:`~openturns.FieldFunction`, it first builds a projection
5matrix between two meshes, and can then interpolate a :class:`~openturns.Field` defined
6on input mesh onto a :class:`~openturns.Field` defined on output mesh.
7
8Available constructors:
9
10    P1LagrangeInterpolation(*inputMesh, outputMesh, dimension*)
11
12    P1LagrangeInterpolation(*inputMesh, outputMesh, dimension, enclosingSimplex, nearestNeighbour*)
13
14Parameters
15----------
16inputMesh : :class:`~openturns.Mesh`
17    Input mesh.
18
19outputMesh : :class:`~openturns.Mesh`
20    Output mesh.
21
22dimension : int
23    Dimension of fields to evaluate.
24
25enclosingSimplex : :class:`~openturns.EnclosingSimplexAlgorithm`
26    Algorithm used to find the enclosing simplex of each output point in
27    input mesh.  If a point is not contained in any mesh simplex, the
28    nearest point is used.
29
30nearestNeighbour : :class:`~openturns.NearestNeighbourAlgorithm`
31    Algorithm used to find nearest neighbour of an output point, when it
32    is not contained in any simplex of input mesh.
33
34Notes
35-----
36
37A :class:`~openturns.FieldFunction` is usually defined by three numbers,
38the input dimension, and dimensions of input and output fields.
39Before evaluating a :class:`~openturns.Field`, classes check that its
40dimensions are the ones which had been declared.
41
42This class is special because it can deal with fields of any dimension,
43and output field will have the same dimension as input field.  This
44dimension is passed to constructor, but method :meth:`setDimension` can
45be called to interpolate fields of different dimensions without having
46to rebuild the projection between meshes."
47
48// ---------------------------------------------------------------------
49
50%feature("docstring") OT::P1LagrangeInterpolation::getInputMesh
51"Accessor to the input mesh.
52
53Returns
54-------
55mesh : :class:`~openturns.Mesh`
56    Input mesh."
57
58// ---------------------------------------------------------------------
59
60%feature("docstring") OT::P1LagrangeInterpolation::setDimension
61"Accessor to dimension of fields which are evaluated.
62
63Parameters
64----------
65dimension : int
66    Dimension of input fields which are going to be evaluated."
67
68// ---------------------------------------------------------------------
69
70%feature("docstring") OT::P1LagrangeInterpolation::getEnclosingSimplexAlgorithm
71"Accessor to the algorithm used to find enclosing simplex.
72
73Returns
74-------
75enclosingSimplex : :class:`~openturns.EnclosingSimplexAlgorithm`
76    Enclosing simplex algorithm."
77
78// ---------------------------------------------------------------------
79
80%feature("docstring") OT::P1LagrangeInterpolation::getNearestNeighbourAlgorithm
81"Accessor to the algorithm used to find nearest neighbours.
82
83This algorithm is used only when point is not contained in any simplex.
84
85Returns
86-------
87nearestNeighbour : :class:`~openturns.NearestNeighbourAlgorithm`
88    Nearest neighbour algorithm."
89