Docs: updating docs (cassiope bot)

Author: cassiope

Cassiopee/KCore/doc/source/Geom.rst

@@ -40,6 +40,7 @@ List of functions
    Geom.polyline
    Geom.circle
    Geom.naca
+   Geom.profile
    Geom.spline
    Geom.nurbs
    Geom.bezier
@@ -265,6 +266,29 @@ A polyline is defined as a C0 i-array which contains only the polyline points (w
 
 ---------------------------------------
 
+.. py:function:: Geom.profile(name=None)
+
+    Create a wing profile of given name. 
+    The name must be of type "series/profile".
+    If name is not provided, list available profiles.
+
+    :param name: profile name
+    :type name: string of type "series/profile"
+    :return: a profile
+    :rtype: one array/zone (1D STRUCT)
+
+    *Example of use:*
+
+    * `Creation of a profile (array) <Examples/Geom/profile.py>`_:
+
+    .. literalinclude:: ../build/Examples/Geom/profile.py
+
+    * `Creation of a profile (pyTree) <Examples/Geom/profilePT.py>`_:
+
+    .. literalinclude:: ../build/Examples/Geom/profilePT.py
+
+---------------------------------------
+
 .. py:function:: Geom.spline(Pts, order=3, N=100, M=100, density=-1)
 
     Create a Spline curve/surface using control points defined by Pts.

docs/doc/Converter.html

@@ -3497,7 +3497,7 @@ <h3>Array / PyTree common manipulations</h3>
 <h3>Array / PyTree analysis</h3>
 <dl class="py function">
 <dt class="sig sig-object py" id=".Converter.diffArrays">
-<span class="sig-prename descclassname"><span class="pre">Converter.</span></span><span class="sig-name descname"><span class="pre">diffArrays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removeCoordinates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">Converter.</span></span><span class="sig-name descname"><span class="pre">diffArrays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removeCoordinates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">atol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.e-11</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Given a solution in a and a solution in b, both defined on the same mesh,
 return the differences.</p>
 <dl class="field-list simple">
@@ -3506,6 +3506,8 @@ <h3>Array / PyTree analysis</h3>
 <li><p><strong>a</strong> (<em>[</em><em>list</em><em> of </em><em>arrays</em><em>] or </em><em>[</em><em>pyTree</em><em>, </em><em>base</em><em>, </em><em>zone</em><em>, </em><em>list</em><em> of </em><em>zones</em><em>]</em>) &#8211; input data 1</p></li>
 <li><p><strong>b</strong> (<em>[</em><em>list</em><em> of </em><em>arrays</em><em>] or </em><em>[</em><em>pyTree</em><em>, </em><em>base</em><em>, </em><em>zone</em><em>, </em><em>list</em><em> of </em><em>zones</em><em>]</em>) &#8211; input data 2</p></li>
 <li><p><strong>removeCoordinates</strong> (<em>boolean</em>) &#8211; if True, remove original coordinates (pyTree)</p></li>
+<li><p><strong>atol</strong> (<em>float</em>) &#8211; absolute tolerance</p></li>
+<li><p><strong>rtol</strong> (<em>float</em>) &#8211; relative tolerance</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>

docs/doc/Examples/Connector/prepAMRFull_t1.py

@@ -1,3 +1,4 @@
+# - prepAMRFull (pyTree) -
 import Converter.PyTree as C
 import Geom.IBM as D_IBM
 import Connector.AMR as X_AMR
@@ -39,9 +40,9 @@
 X_AMR.prepareAMRIBM(tb, levelMax, vmins, dim, IBM_parameters, OutputAMRMesh=True, check=False, localDir=LOCAL, fileName='tIBM.cgns')
 
 tAMR = C.convertFile2PyTree(LOCAL+'tAMRMesh.cgns')
-test.testT(tAMR,1)
+test.testT(tAMR, 1)
 del tAMR
 
 tIBM = C.convertFile2PyTree(LOCAL+'tIBM.cgns')
-test.testT(tIBM,2)
+test.testT(tIBM, 2)
 del tIBM

docs/doc/Examples/Converter/createGlobalHook_t1.py

@@ -1,6 +1,9 @@
 # - createGlobalHook (array) -
 import Converter as C
+import Generator as G
 import KCore.test as test
 
-test.stdTestA(C.createGlobalHook, 'faceCenters', 1)
-test.stdTestA(C.createGlobalHook, 'faceCenters', 0)
+a = G.cartNGon((0,0,0), (1,1,1), (10,10,10))
+b = G.cartNGon((9,0,0), (1,1,1), (10,10,10))
+hook = C.createGlobalHook([a,b], function='faceCenters')
+test.testO(hook, 1)

docs/doc/Examples/Converter/createGlobalHook_t2.py

@@ -2,5 +2,5 @@
 import Converter as C
 import KCore.test as test
 
-test.stdTestA(C.createGlobalHook, 'nodes',1)
-test.stdTestA(C.createGlobalHook, 'nodes',0)
+test.stdTestA(C.createGlobalHook, 'nodes', 1)
+test.stdTestA(C.createGlobalHook, 'nodes', 0)

docs/doc/Examples/Converter/createGlobalHook_t3.py

@@ -2,5 +2,5 @@
 import Converter as C
 import KCore.test as test
 
-test.stdTestA(C.createGlobalHook, 'elementCenters',1)
-test.stdTestA(C.createGlobalHook, 'elementCenters',0)
+test.stdTestA(C.createGlobalHook, 'elementCenters', 1)
+test.stdTestA(C.createGlobalHook, 'elementCenters', 0)

docs/doc/Examples/Converter/getValue_t3.py

@@ -0,0 +1,12 @@
+# - getValue (array) -
+import Converter as C
+import Generator.PyTree as GP
+import Converter.PyTree as CP
+import KCore.test as test
+
+# test on array3
+a = GP.cart((0,0,0), (1,1,1), (10,10,10))
+f = CP.getFields('GridCoordinates', a, api=3)[0]
+ret = C.getValue(f, 12)
+#C.setValue(f, 12, ret)
+test.testO(ret, 1)

docs/doc/Examples/Converter/setValue_t3.py

@@ -0,0 +1,12 @@
+# - setValue (array) -
+import Converter as C
+import Generator.PyTree as GP
+import Converter.PyTree as CP
+import KCore.test as test
+
+# test on array3
+a = GP.cart((0,0,0), (1,1,1), (10,10,10))
+f = CP.getFields('GridCoordinates', a, api=3)[0]
+C.setValue(f, 12, (1,2,3))
+ret = C.getValue(f, 12)
+test.testO(ret, 1)

docs/doc/Examples/Generator/getVolumeMapPT_t1.py

@@ -2,58 +2,103 @@
 import Generator.PyTree as G
 import Converter.PyTree as C
 import Geom.PyTree as D
-import KCore.test as T
+import KCore.test as test
 
-# Test 3D structure
+# --- Structured grids ---
+# 3D structured
 a = G.cart((0.,0.,0.), (0.1,0.1,0.2), (10,10,3))
 a = C.addBC2Zone(a, 'wall1','BCWall','jmin')
 a = C.addBC2Zone(a, 'match1','BCMatch','imin',a,'imax',[1,2,3])
 a = C.addBC2Zone(a, 'match2','BCMatch','imax',a,'imin',[1,2,3])
 a = C.fillEmptyBCWith(a,'overlap','BCOverlap')
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 1)
+test.testT(vol, 1)
 
-# Test 2D structure
+# 2D structured
 a = G.cart((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 2)
+test.testT(vol, 2)
 
-# Test 1D structure
+# 1D structured
 a = G.cart((0.,0.,0.), (0.1,0.1,0.2), (1,1,10))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 7)
+test.testT(vol, 7)
 
-# Test 1d non-structure bar
+# --- BE ---
+# 1d unstructured bar
 a = D.line((0,0,0), (1,0,0),11)
 a2 = C.convertArray2Tetra(a)
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 8)
+test.testT(vol, 8)
 
-
-# Test 2d non-structure hexa
+# 2D unstructured quad
 a = G.cartHexa((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 3)
+test.testT(vol, 3)
 
-# Test 3d non-structure hexa
+# 3D unstructured hexa
 a = G.cartHexa((0.,0.,0.), (0.1,0.1,0.2), (10,10,10))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 4)
+test.testT(vol, 4)
 
-# Test 2d non-structure tetra
+# 2D unstructured tri
 a = G.cartTetra((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 5)
+test.testT(vol, 5)
 
-# Test 3d non-structure tetra
+# 3D unstructured tetra
 a = G.cartTetra((0.,0.,0.), (0.1,0.1,0.2), (10,10,10))
 a = C.initVars(a,'Density',1.); a = C.initVars(a,'centers:cellN',1.)
 vol = G.getVolumeMap(a)
-T.testT(vol, 6)
+test.testT(vol, 6)
+
+# 3D unstructured pyra
+a = G.cartPyra((0., 0., 0.), (1., 1., 1.), (5, 5, 5))
+G._getVolumeMap(a)
+test.testT(a,9)
+
+# 3D unstructured penta
+a = G.cartPenta((0., 0., 0.), (1., 1., 1.), (5, 5, 5))
+G._getVolumeMap(a)
+test.testT(a,10)
+
+"""
+# 1D unstructured ME
+a = G.cartHexa((0.,0.,0.), (0.1,0.1,0.2), (5,1,1))
+b = G.cartHexa((0.4,0.,0.), (0.1,0.1,0.2), (1,10,1))
+c = G.cartHexa((0.8,0.,0.), (0.1,0.1,0.2), (4,1,1))
+d = G.cartHexa((0.4,-0.9,0.), (0.1,0.1,0.2), (1,1,12))
+a = C.mergeConnectivity([a, b, c, d], None)
+#G._getVolumeMap(a)
+#test.testT(a,11)
+
+# --- ME ---
+# 2D unstructured ME: tri-quad-tri
+#                          |
+#                         tri
+a = G.cartTetra((0.,0.,0.), (0.1,0.1,0.2), (5,10,1))
+b = G.cartHexa((0.4,0.,0.), (0.1,0.1,0.2), (5,10,1))
+c = G.cartTetra((0.8,0.,0.), (0.1,0.1,0.2), (5,10,1))
+d = G.cartTetra((0.4,-0.9,0.), (0.1,0.1,0.2), (5,10,1))
+a = C.mergeConnectivity([a, b, c, d], None)
+#G._getVolumeMap(a)
+#test.testT(a,12)
+
+# 3D unstructured ME: tetra - pyra
+#                       |      |
+#                     penta   hexa
+a = G.cartTetra((0.,0.4,0.), (0.1,0.1,0.1), (5,5,5))
+b = G.cartPyra((0.4,0.4,0.), (0.1,0.1,0.1), (5,5,5))
+c = G.cartPenta((0.,0.,0.), (0.1,0.1,0.1), (5,5,5))
+d = G.cartHexa((0.4,0.,0.), (0.1,0.1,0.1), (5,5,5))
+a = C.mergeConnectivity([a, b, c, d], None)
+#G._getVolumeMap(a)
+#test.testT(a,13)
+"""

docs/doc/Examples/Generator/getVolumeMapPT_t2.py

@@ -3,7 +3,7 @@
 import Converter.PyTree as C
 import KCore.test as T
 
-# Test 3D structure
+# 3D structured
 a = G.cart((0.,0.,0.), (0.1,0.1,0.2), (10,10,3))
 a = C.addBC2Zone(a, 'wall1','BCWall','jmin')
 a = C.addBC2Zone(a, 'match1','BCMatch','imin',a,'imax',[1,2,3])
@@ -15,39 +15,39 @@
 t = G.getVolumeMap(t)
 T.testT(t,1)
 
-# Test 2D structure
+# 2D structured
 a = G.cart((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 t = C.newPyTree(['Base',2]); t[2][1][2].append(a)
 t[2][1] = C.addState(t[2][1], 'Mach', 0.6)
 t = C.initVars(t,'Density',2.); t = C.initVars(t,'centers:cellN',1.)
 t = G.getVolumeMap(t)
 T.testT(t,2)
 
-# Test 2d non-structure hexa
+# 2D unstructured quad
 a = G.cartHexa((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 t = C.newPyTree(['Base',2]); t[2][1][2].append(a)
 t[2][1] = C.addState(t[2][1], 'Mach', 0.6)
 t = C.initVars(t,'Density',2.); t = C.initVars(t,'centers:cellN',1.)
 t = G.getVolumeMap(t)
 T.testT(t,3)
 
-# Test 3d non-structure hexa
+# 3D unstructured hexa
 a = G.cartHexa((0.,0.,0.), (0.1,0.1,0.2), (10,10,10))
 t = C.newPyTree(['Base']); t[2][1][2].append(a)
 t[2][1] = C.addState(t[2][1], 'Mach', 0.6)
 t = C.initVars(t,'Density',2.); t = C.initVars(t,'centers:cellN',1.)
 t = G.getVolumeMap(t)
 T.testT(t,4)
 
-# Test 2d non-structure tri
+# 2D unstructured tri
 a = G.cartTetra((0.,0.,0.), (0.1,0.1,0.2), (10,10,1))
 t = C.newPyTree(['Base',2]); t[2][1][2].append(a)
 t[2][1] = C.addState(t[2][1], 'Mach', 0.6)
 t = C.initVars(t,'Density',2.); t = C.initVars(t,'centers:cellN',1.)
 t = G.getVolumeMap(t)
 T.testT(t,5)
 
-# Test 3d non-structure tetra
+# 3D unstructured tetra
 a = G.cartTetra((0.,0.,0.), (0.1,0.1,0.2), (10,10,10))
 t = C.newPyTree(['Base']); t[2][1][2].append(a)
 t[2][1] = C.addState(t[2][1], 'Mach', 0.6)