From c05cca7e29b87a11bfb31c307c59199c416def9d Mon Sep 17 00:00:00 2001 From: "christophe.benoit@onera.fr" Date: Wed, 31 Jul 2024 15:56:06 +0200 Subject: [PATCH] docs: clean up doc --- Cassiopee/Converter/doc/source/Converter.rst | 12 +- .../Converter/doc/source/ConverterMpi.rst | 8 +- Cassiopee/Envs/env_Cassiopee_local | 1 + Cassiopee/Envs/sh_Cassiopee_local | 1 + Cassiopee/Generator/doc/source/Generator.rst | 4 +- Cassiopee/Initiator/doc/source/Initiator.rst | 16 +- .../Intersector/doc/source/Intersector.rst | 12 +- docs/doc/Converter.html | 17 +- docs/doc/ConverterMpi.html | 38 +-- docs/doc/Generator.html | 31 ++- docs/doc/Generator_IBM.html | 81 ++++-- docs/doc/Initiator.html | 57 ++-- docs/doc/Intersector.html | 23 +- docs/doc/genindex.html | 258 +++++++++--------- 14 files changed, 290 insertions(+), 269 deletions(-) diff --git a/Cassiopee/Converter/doc/source/Converter.rst b/Cassiopee/Converter/doc/source/Converter.rst index a4dc98fb4..bba9919ae 100644 --- a/Cassiopee/Converter/doc/source/Converter.rst +++ b/Cassiopee/Converter/doc/source/Converter.rst @@ -806,7 +806,6 @@ pyTree creation and manipulation .. literalinclude:: ../build/Examples/Converter/rmBCDataVarsPT.py - .. note:: new in version 2.7. --------------------------------------------------------------------------- @@ -1406,7 +1405,7 @@ Array / PyTree common manipulations .. literalinclude:: ../build/Examples/Converter/initVarsByEq.py - .. note:: When initializing variables using string formulas, functions correspond to the numpy library. + .. note:: When initializing variables using string formulas, function names must match the names of the numpy library. * `Init a variable to a constant value (pyTree) `_: @@ -2050,7 +2049,7 @@ Array / PyTree analysis :type a: [array, list of arrays] or [pyTree, base, zone, list of zones] :param var: variable name :type var: string - :rtype: L0 norm + :rtype: float *Example of use:* @@ -2072,7 +2071,7 @@ Array / PyTree analysis :type a: [array, list of arrays] or [pyTree, base, zone, list of zones] :param var: variable name :type var: string - :rtype: L2 norm + :rtype: float *Example of use:* @@ -2187,8 +2186,6 @@ Array / PyTree analysis .. literalinclude:: ../build/Examples/Converter/isFinitePT.py - .. note:: new in version 3.2. - .. Array / PyTree conversion .. -------------------------------- @@ -2202,7 +2199,7 @@ Array / PyTree analysis :type path: string :param t: pyTree :type t: pyTree - :return array + :return: array :rtype: Converter array *Example of use:* @@ -2286,7 +2283,6 @@ Array / PyTree input/output :param options: reading options (see ReadOptions_) :type options: keywords :return: a pyTree - :rtype: pyTree *Example of use:* diff --git a/Cassiopee/Converter/doc/source/ConverterMpi.rst b/Cassiopee/Converter/doc/source/ConverterMpi.rst index cd58fc1c7..a296ecf35 100644 --- a/Cassiopee/Converter/doc/source/ConverterMpi.rst +++ b/Cassiopee/Converter/doc/source/ConverterMpi.rst @@ -486,12 +486,12 @@ Actions :type cpu: boolean :param mem: True to write memory usage information :type mem: boolean - :param filename: name of the file to write information to or "stdout" - :type filename: string - + :param fileName: name of the file to write information to or "stdout" + :type fileName: string + *Example of use:* - * `Write a trace (pyTree) `_: + * `Write a trace (pyTree) `_: .. literalinclude:: ../build/Examples/Converter/tracePT.py diff --git a/Cassiopee/Envs/env_Cassiopee_local b/Cassiopee/Envs/env_Cassiopee_local index 9adf31f38..d2fd58845 100644 --- a/Cassiopee/Envs/env_Cassiopee_local +++ b/Cassiopee/Envs/env_Cassiopee_local @@ -662,6 +662,7 @@ else if ($MAC == "juno") then module load occt/7.6.1-gnu831 module load subversion/1.14.1-gnu831 module load emacs/27.2-gnu831 + module load texlive/2021 unsetenv I_MPI_FABRICS_LIST unsetenv I_MPI_FABRICS unsetenv I_MPI_PMI_LIBRARY diff --git a/Cassiopee/Envs/sh_Cassiopee_local b/Cassiopee/Envs/sh_Cassiopee_local index d1212b072..565d9ece4 100644 --- a/Cassiopee/Envs/sh_Cassiopee_local +++ b/Cassiopee/Envs/sh_Cassiopee_local @@ -557,6 +557,7 @@ elif [ "$MAC" = "juno" ]; then module load occt/7.6.1-gnu831 module load subversion/1.14.1-gnu831 module load emacs/27.2-gnu831 + module load texlive/2021 alias inspxe-cl="/opt/tools/intel/oneapi/inspector/2021.2.0/bin64/inspxe-cl -r result -collect mi3 -- python3 " alias inspxe-cl2="/opt/tools/intel/oneapi/inspector/2021.2.0/bin64/inspxe-cl -r result -collect ti3 -- python3 " alias inspxe-gui="/opt/tools/intel/oneapi/inspector/2021.2.0/bin64/inspxe-gui result" diff --git a/Cassiopee/Generator/doc/source/Generator.rst b/Cassiopee/Generator/doc/source/Generator.rst index cc1e579c4..6e08d4ae8 100644 --- a/Cassiopee/Generator/doc/source/Generator.rst +++ b/Cassiopee/Generator/doc/source/Generator.rst @@ -1241,7 +1241,7 @@ Operations on meshes .. literalinclude:: ../build/Examples/Generator/zip.py - * `Mesh closing (pyTree) `_: + * `Border closing (pyTree) `_: .. literalinclude:: ../build/Examples/Generator/zipPT.py @@ -2311,8 +2311,6 @@ Operations on distributions :type a: array or pyTree :param x0: I-location of the refinement point :type x0: float - :return: index of enforced point - :rtype: integer :return: modified reference copy of a :rtype: array or pyTree diff --git a/Cassiopee/Initiator/doc/source/Initiator.rst b/Cassiopee/Initiator/doc/source/Initiator.rst index 6af060886..62148f465 100644 --- a/Cassiopee/Initiator/doc/source/Initiator.rst +++ b/Cassiopee/Initiator/doc/source/Initiator.rst @@ -307,8 +307,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/adim1.py - .. note:: New in version 2.5 - --------------------------------------- .. py:function:: Initiator.Adim.adim2(MInf=0.5, alphaZ=0., alphaY=0., ReInf=1.e8, MutSMuInf=0.2, TurbLevelInf=1.e-4) @@ -337,8 +335,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/adim2.py - .. note:: New in version 2.5 - --------------------------------------- .. py:function:: Initiator.Adim.adim3(MInf=0.5, alphaZ=0., alphaY=0., ReInf=1.e8, LInf=1., MutSMuInf=0.2, TurbLevelInf=1.e-4, Mtip=None) @@ -372,8 +368,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/adim3.py - .. note:: New in version 2.5 - --------------------------------------- .. py:function:: Initiator.Adim.dim1(UInf=2.7777, TInf=298.15, PInf=101325., LInf=1., alphaZ=0., alphaY=0., MutSMuInf=0.2, TurbLevelInf=1.e-4, Mtip=None) @@ -404,8 +398,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/dim1.py - .. note:: New in version 2.5 - --------------------------------------- .. py:function:: Initiator.Adim.dim2(UInf=2.7777, TInf=298.15, RoInf=1.225, LInf=1., alphaZ=0., alphaY=0., MutSMuInf=0.2, TurbLevelInf=1.e-4, Mtip=None) @@ -437,8 +429,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/dim2.py - .. note:: New in version 2.5 - --------------------------------------- .. py:function:: Initiator.Adim.dim3(UInf=2.7777, PInf=101325., RoInf=1.225, LInf=1., alphaZ=0., alphaY=0., MutSMuInf=0.2, TurbLevelInf=1.e-4, Mtip=None) @@ -470,8 +460,6 @@ Adimensioning .. literalinclude:: ../build/Examples/Initiator/dim3.py - .. note:: New in version 2.5 - Mesh size ----------- @@ -495,6 +483,8 @@ Mesh size :type yplus: float :param algo: type of algorithm in 'Turbulent', 'TurbulentCorr', 'LaminarCorr' :type algo: string + :return: height of first cell + :rtype: float *Example of use:* @@ -502,8 +492,6 @@ Mesh size .. literalinclude:: ../build/Examples/Initiator/meshSizePT.py - .. note:: New in version 3.4 - .. toctree:: diff --git a/Cassiopee/Intersector/doc/source/Intersector.rst b/Cassiopee/Intersector/doc/source/Intersector.rst index a3ad7f7f5..c57e9766d 100644 --- a/Cassiopee/Intersector/doc/source/Intersector.rst +++ b/Cassiopee/Intersector/doc/source/Intersector.rst @@ -1015,12 +1015,12 @@ Extraction Functions Returns the cells in t1 having specified faces or cell ids. - :param a: Input mesh - :type a: [array, list of arrays] or [pyTree, base, zone, list of zones] - :param ids: face or cell ids - :type ids: numpy of ints - :param are_face_ids: Tells whether the ids are referring to faces or cells. - :type are_face_ids: boolean + :param a: Input mesh + :type a: [array, list of arrays] or [pyTree, base, zone, list of zones] + :param ids: face or cell ids + :type ids: numpy of ints + :param are_face_ids: Tells whether the ids are referring to faces or cells. + :type are_face_ids: boolean *Example of use:* diff --git a/docs/doc/Converter.html b/docs/doc/Converter.html index 01548c91a..65809703b 100644 --- a/docs/doc/Converter.html +++ b/docs/doc/Converter.html @@ -1458,10 +1458,6 @@

pyTree creation and manipulation

-
-

Note

-

new in version 2.7.

-
@@ -2596,7 +2592,7 @@

Array / PyTree common manipulations

Note

-

When initializing variables using string formulas, functions correspond to the numpy library.

+

When initializing variables using string formulas, function names must match the names of the numpy library.

Return type:
-

L0 norm

+

float

Example of use:

@@ -3816,7 +3812,7 @@

Array / PyTree analysis

Return type:
-

L2 norm

+

float

Example of use:

@@ -4058,10 +4054,6 @@

Array / PyTree analysis

#>> True -
-

Note

-

new in version 3.2.

-
@@ -4167,9 +4159,6 @@

Array / PyTree input/output

Returns:

a pyTree

-
Return type:
-

pyTree

-

Example of use:

    diff --git a/docs/doc/ConverterMpi.html b/docs/doc/ConverterMpi.html index 334571e80..4a0cd778d 100644 --- a/docs/doc/ConverterMpi.html +++ b/docs/doc/ConverterMpi.html @@ -888,45 +888,26 @@

    Actions

    Converter.Mpi.trace(text, cpu=True, mem=True, fileName='stdout')
    -
    -

    Enable to monitor CPU usage and memory usage for each node/process. +

    Enable to monitor CPU usage and memory usage for each node/process. If fileName=”stdout”, information is written to standard output with the processor number. If fileName is another name, information is written in “filenameXXX” files, one for each process. If filename does not have a format for the process number and/or an file extension, it is appended “%03d” and “.out”, respectively. If cpu=True, time elapsed since the previous call to “trace” by this node is written. If mem=True, the current usage of memory of each process is written.

    -
    param text:
    -

    text to write

    -
    -
    type text:
    -

    string

    -
    -
    param cpu:
    -

    True to write cpu usage information

    -
    -
    type cpu:
    -

    boolean

    -
    -
    param mem:
    -

    True to write memory usage information

    -
    -
    type mem:
    -

    boolean

    -
    -
    param filename:
    -

    name of the file to write information to or “stdout”

    -
    -
    type filename:
    -

    string

    +
    Parameters:
    +
      +

    • text (string) – text to write

      • +

    • cpu (boolean) – True to write cpu usage information

      • +

    • mem (boolean) – True to write memory usage information

      • +

    • fileName (string) – name of the file to write information to or “stdout”

      • +

    Example of use:

    -
    -
    -
    # - trace (pyTree) -
+
    # - trace (pyTree) -
 import Generator.PyTree as G
 import Converter.Mpi as Cmpi
 
@@ -937,7 +918,6 @@ 
    Actions
    
 #>> 0: >>> After cart [0.0060176 secs][9.2 MB]
 
    
 
    
-
    diff --git a/docs/doc/Generator.html b/docs/doc/Generator.html index 7a3b8c6e9..1a00858b8 100644 --- a/docs/doc/Generator.html +++ b/docs/doc/Generator.html @@ -2472,7 +2472,7 @@

    Operations on meshes

    # - zip (pyTree) -
 import Converter.PyTree as C
@@ -4791,12 +4791,6 @@ 
    Operations on distributions
Returns:
-

index of enforced point

-
-
Return type:
-

integer

-
-
Returns:

modified reference copy of a

Return type:
@@ -5079,4 +5073,25 @@

Quick search

} } - \ No newline at end of file + + + +
+ + + + + \ No newline at end of file diff --git a/docs/doc/Generator_IBM.html b/docs/doc/Generator_IBM.html index bdf4877f8..138aa810b 100644 --- a/docs/doc/Generator_IBM.html +++ b/docs/doc/Generator_IBM.html @@ -58,40 +58,37 @@

List of functions

Generator.IBM.generateIBMMesh(tb[, vmin, ...])

-

Generator.IBM.buildOctree(tb[, snears, ...])

+

Generator.IBM.buildOctree(tb[, dimPb, vmin, ...])

-

Generator.IBM.addRefinementZones(o, tb, ...)

+

Generator.IBM.octree2StructLoc__(o[, ...])

-

Generator.IBM.octree2StructLoc__(o[, ...])

+

Generator.IBM.mergeByParent__(zones, parent, ...)

-

Generator.IBM.mergeByParent__(zones, parent, ...)

+

Generator.IBM.buildParentOctrees__(o, tb[, ...])

-

Generator.IBM.buildParentOctrees__(o, tb[, ...])

+

Generator.IBMmodelHeight.getMinimumCartesianSpacing(t)

-

Generator.IBMmodelHeight.getMinimumCartesianSpacing(t)

+

Generator.IBMmodelHeight.compute_Cf(Re[, Cf_law])

-

Generator.IBMmodelHeight.compute_Cf(Re[, Cf_law])

+

Generator.IBMmodelHeight.computeYplus(Re[, ...])

-

Generator.IBMmodelHeight.computeYplus(Re[, ...])

+

Generator.IBMmodelHeight.computeModelisationHeight(Re)

-

Generator.IBMmodelHeight.computeModelisationHeight(Re)

+

Generator.IBMmodelHeight.computeBestModelisationHeight(Re, h)

-

Generator.IBMmodelHeight.computeBestModelisationHeight(Re, h)

+

Generator.IBMmodelHeight.computeYplusOpt([...])

-

Generator.IBMmodelHeight.computeYplusOpt([...])

-

- -

Generator.IBMmodelHeight.computeSnearOpt([...])

+

Generator.IBMmodelHeight.computeSnearOpt([...])

@@ -133,6 +130,7 @@

Quick search

Download pdf version +

- + + + - -