Docs: updating docs (cassiope bot)

Author: cassiope

.github/workflows/version-docs.yml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mike mkdocs sphinx
+          pip install mike mkdocs #sphinx
 
       - name: Configure Git (for mike to push)
         run: |
@@ -37,9 +37,9 @@ jobs:
 
       - name: Deploy docs
         run: |
-          export CASSIOPEE=$GITHUB_WORKSPACE
-          cd $CASSIOPEE/Cassiopee
-          ./install --doc
+          #export CASSIOPEE=$GITHUB_WORKSPACE
+          #cd $CASSIOPEE/Cassiopee
+          #./install --doc
           if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
             VERSION=${GITHUB_REF#refs/tags/}
             mike deploy --push --update-aliases "$VERSION" latest

Cassiopee/KCore/doc/source/Internal.rst

@@ -248,6 +248,10 @@ List of functions
     Converter.Internal.adaptNGon42NGon3
     Converter.Internal.adaptNFace2PE
     Converter.Internal.adaptPE2NFace
+    Converter.adaptSurfaceNGon
+    Converter.Internal.adaptBCFacePL2VertexPL
+    Converter.Internal.adaptBCVertexPL2FacePL
+    
 
 Contents
 #########
@@ -1321,9 +1325,10 @@ Check nodes
 .. py:function:: Converter.Internal.getSizeOf(node) 
 
     Return the size of input node and attached nodes in octets.
+    Works also on numpy, list of numpys, dict of numpys.
 
-    :param node:  input node
-    :type  node:  pyTree node of list of pyTree nodes
+    :param node: input node
+    :type  node: pyTree node of list of pyTree nodes
     :return: size of node in octets
     :rtype: int
 
@@ -3200,6 +3205,67 @@ Adapt NGON meshes
 
 ---------------------------------------------------------------------------
 
+.. py:function:: Internal.adaptSurfaceNGon(a, rmEmptyNFaceElements=True)
+
+    Adapt a surface NGon from (A: NGON=bars, NFACE=polygon)
+    to (B: NGON=polygon, NFACE=NULL), or vice versa.
+
+    :param a: input data (NGON)
+    :type a: [array, list of arrays] or [pyTree, base, zone, list of zones]
+    :param rmEmptyNFaceElements: if True, remove all empty NFaceElements nodes from the zones.
+    :type tol: boolean
+    :rtype: Identical to input
+
+    *Example of use:*
+
+    * `NGON surface mesh adaptation (pyTree) <Examples/Converter/adaptSurfaceNGonPT.py>`_:
+
+    .. literalinclude:: ../build/Examples/Converter/adaptSurfaceNGonPT.py
+
+-----------------------------------------------------------------------------------
+
+.. py:function:: Converter.Internal.adaptBCFacePL2VertexPL(t, bcs=None, btype=None, remove=False)
+
+    Adapts face point list into vertex point list for a list of BC_t nodes. Exists also as in-place (_adaptBCFacePL2VertexPL). 
+
+    :param t:  unstructured mesh
+    :type  t:  pyTree node or list of pyTree nodes
+    :param bcs:  BC nodes on which to adapt face point list into vertex point list. If None, considers all BC nodes
+    :type  bcs:  optional pyTree node or list of pyTree nodes
+    :param btype: type of BC (BCWall, BCFarfield, FamilySpecified...) to consider. If None, does not filter `bcs` by BCType
+    :type btype: string
+    :param remove: if True, removes all BCDataset nodes found in `bcs`
+    :type check: boolean
+
+    *Example of use:*
+
+    * `Creates vertex PointList arrays (pyTree) <Examples/Converter/adaptBCFacePL2VertexPLPT.py>`_:
+
+    .. literalinclude:: ../build/Examples/Converter/adaptBCFacePL2VertexPLPT.py
+
+-----------------------------------------------------------------------------------
+
+.. py:function:: Converter.Internal.adaptBCVertexPL2FacePL(t, bcs=None, btype=None, remove=False)
+
+    Adapts vertex point list into face point list for a list of BC_t nodes. Exists also as in-place (_adaptBCVertexPL2FacePL). 
+
+    :param t:  unstructured mesh
+    :type  t:  pyTree node or list of pyTree nodes
+    :param bcs:  BC nodes on which to adapt vertex point list into face point list. If None, considers all BC nodes
+    :type  bcs:  optional pyTree node or list of pyTree nodes
+    :param btype: type of BC (BCWall, BCFarfield, FamilySpecified...) to consider. If None, does not filter `bcs` by BCType
+    :type btype: string
+    :param remove: if True, removes all BCDataset nodes found in `bcs`
+    :type check: boolean
+
+    *Example of use:*
+
+    * `Creates face PointList arrays (pyTree) <Examples/Converter/adaptBCVertexPL2FacePLPT.py>`_:
+
+    .. literalinclude:: ../build/Examples/Converter/adaptBCVertexPL2FacePLLPT.py
+    
+-----------------------------------------------------------------------------------
+
 .. toctree::
    :maxdepth: 2   
 

docs/doc/CPlot.html

@@ -6,7 +6,7 @@
     <meta charset="ASCII" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>CPlot: a light plotter for arrays/pyTree &#8212; CPlot 4.0 documentation</title>
+    <title>CPlot: a light plotter for arrays/pyTree &#8212; CPlot 4.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">CPlot 4.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">CPlot: a light plotter for arrays/pyTree</a></li> 
       </ul>
     </div>  
@@ -960,14 +960,15 @@ <h3>Set / Get functions</h3>
 <dl class="py function">
 <dt class="sig sig-object py" id=".CPlot.getActivePointIndex">
 <span class="sig-prename descclassname"><span class="pre">CPlot.</span></span><span class="sig-name descname"><span class="pre">getActivePointIndex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
-<dd><p>Return the active point index. For structured grids, return
-[ind, indc, i,j,k], where ind is the global index of the nearest node
+<dd><p>Return the active point index.
+For structured grids, return [ind, indc, i,j,k], where ind is the global index of the nearest node
 to active point, indc is the global index of the nearest center to
-active point and i,j,k are the indices of nearest node. For
-unstructured grids, return [ind, indc, no, 0, 0],
+active point and i,j,k are the indices of nearest node.
+For unstructured grids, return [ind, indc, no, 0, 0],
 where ind is the global index of nearest node, indc
 is the nearest center to the clicked point and no is the number of ind
-in the center2node connectivity of indc.</p>
+in the center2node connectivity of indc.
+If there is no active point, return [].</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>active point index</p>
@@ -1865,7 +1866,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">CPlot 4.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">CPlot: a light plotter for arrays/pyTree</a></li> 
       </ul>
     </div>

docs/doc/Compressor.html

@@ -6,7 +6,7 @@
     <meta charset="ASCII" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Compressor: Field compression module &#8212; Compressor 4.0 documentation</title>
+    <title>Compressor: Field compression module &#8212; Compressor 4.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">Compressor 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">Compressor 4.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Compressor: Field compression module</a></li> 
       </ul>
     </div>  
@@ -624,7 +624,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">Compressor 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">Compressor 4.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Compressor: Field compression module</a></li> 
       </ul>
     </div>