From bf86ca8dff8e43cef3204f97cd4fe02ea32c121e Mon Sep 17 00:00:00 2001 From: benoit128 Date: Mon, 29 Jul 2024 13:39:35 +0200 Subject: [PATCH] docs: corr. search index --- Cassiopee/Converter/doc/install | 2 + docs/doc/Converter.html | 158 ++++++++++++++++---------------- 2 files changed, 81 insertions(+), 79 deletions(-) diff --git a/Cassiopee/Converter/doc/install b/Cassiopee/Converter/doc/install index d4aa92f53..0ece41102 100755 --- a/Cassiopee/Converter/doc/install +++ b/Cassiopee/Converter/doc/install @@ -89,6 +89,8 @@ then sed -i 's/Converter\.elsAProfile\.Converter\.elsAProfile/Converter\.elsAProfile/g' build/elsAProfile.html sed -i 's/Converter\.pdf/elsAProfile\.pdf/g' build/elsAProfile.html cp build/elsAProfile.html $DEST + + sed -i 's/Converter\.Converter\.PyTree/Converter\.PyTree/g' build/Converter.html sed -i 's/Converter\.Converter/\.Converter/g' build/Converter.html cp build/Converter.html $DEST diff --git a/docs/doc/Converter.html b/docs/doc/Converter.html index a613d99f1..01548c91a 100644 --- a/docs/doc/Converter.html +++ b/docs/doc/Converter.html @@ -229,106 +229,106 @@

List of functions

– PyTree creation and manipulations

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -393,13 +393,13 @@

List of functions

- + - + - + @@ -451,10 +451,10 @@

List of functions

- + - + @@ -774,7 +774,7 @@

Array creation and manipulations

pyTree creation and manipulation

-
+
Converter.PyTree.newPyTree(args)

Create a new pyTree. You can specify base names, cell dimension in base, and attached zones eventually. See below example for all possibilities of input.

@@ -817,7 +817,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addBase2PyTree(a, baseName, cellDim=3)

Add a base named ‘baseName’ to a pyTree. Third argument specifies the cell dimension (cellDim=3 for volume meshes, cellDim=2 for surface meshes).

@@ -856,7 +856,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getNobOfBase(base, t)

Get the number of a given base in tree base list, such that t[2][nob] = base.

@@ -889,7 +889,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getNobNozOfZone(zone, t)

Get the number (nob, noz) of a given zone a tree base and zone list , such that t[2][nob][2][noz] = zone.

@@ -925,7 +925,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.breakConnectivity(a)

Break a multi-element zone (unstructured) into single type element zones. If a is a zone node, return a list of single type element zones. @@ -966,7 +966,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.mergeConnectivity(a, b, boundary=0)

Merge two zones (unstructured) into a single zone with a multiple connectivity. If boundary=1, b will be a BC connectivity in a @@ -1010,7 +1010,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.deleteEmptyZones(a)

Delete structured zones with a null ni, nj or nk, delete unstructured zones with a null number of nodes or elements.

@@ -1046,7 +1046,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addState(a, state, value)

Add a FlowEquation or a ReferenceState data.

Exists also as in place version (_addState) that modifies a and @@ -1146,7 +1146,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addChimera2Base(base, setting, value)

Add a Chimera setting to a node in base. Settings are added in a .Solver#Chimera user defined node. @@ -1190,7 +1190,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addBC2Zone(a, bndName, bndType, wrange=[], zoneDonor=[], rangeDonor=[], trirac=[1, 2, 3], rotationCenter=[], rotationAngle=[], translation=[], faceList=[], elementList=[], elementRange=[], data=None, subzone=None, faceListDonor=None, elementListDonor=None, elementRangeDonor=None, tol=1.e-12, unitAngle=None)

Add a physical boundary condition (BC) or a grid connectivity (GC) to a structured/basic element/NGON zone of a PyTree. Parameter bndName is the name of the BC or GC. Exists also as in place version (_addBC2Zone) modifying zone and returning None.

@@ -1280,7 +1280,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.fillEmptyBCWith(a, bndName, bndType, dim=3)

Fill empty boundary conditions of grids with the given boundary condition. Parameter dim can be 2 or 3.

@@ -1318,7 +1318,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.rmBCOfType(a, bndType)

Remove all boundaries of a given type. bndType accepts wildcards. bndType can also be a family @@ -1369,7 +1369,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.rmBCOfName(a, bndName)

Remove all boundaries of a given name. bndName accepts wildcards. @@ -1421,7 +1421,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.rmBCDataVars(a, varName)

Remove variables given by varName in all BCDataSet. a can be tree, zone or list of zones. @@ -1466,7 +1466,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.extractBCOfType(a, bndType, topTree=None, reorder=True, shift=0)

Extract all boundaries of a given type. Returns a list of zones. Each zone corresponds to one boundary condition. @@ -1509,7 +1509,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.extractBCOfName(a, bndName, reorder=True, shift=0)

Extract all boundaries of a given name. Returns a list of zones. Each zone corresponds to one boundary condition. @@ -1556,7 +1556,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getEmptyBC(a, dim=3, splitFactor=180.)

For each zone, undefined boundary conditions is a list of ranges [imin,imax,jmin,jmax,kmin,kmax] of undefined boundaries @@ -1608,7 +1608,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getBCs(t, reorder=True)

Return the BCs with their complete geometries, names and types.

@@ -1642,7 +1642,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.recoverBCs(t, (BCs, BCNames, BCTypes), tol=1.e-11)

Recover given BCs onto a NGon tree. BCs are given by a tuple of geometries, names and types has obtained by getBCs. @@ -1680,7 +1680,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.extractBCFields(a, varList=None)

Extract fields defined at BCs of a zone z. If no BCDataSet is defined then a 0th-order extrapolation from interior cells is done. If a BCDataSet is defined, it has priority on the extrapolation. List of variables can be specified by the user. If not, the variables that are extracted are those defined in the FlowSolution node located at cell centers. Currently, this function works for structured and NGON zones. It returns the list of variables that could have been extracted and the indices of the face centers of the corresponding BCs.

@@ -1734,7 +1734,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getConnectedZones(a, topTree, type='all')

Get zones connected to a given zone a by ‘BCMatch’ or ‘BCNearMatch’ or ‘all’ (defined in zone GridConnectivity).

@@ -1773,7 +1773,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addFamily2Base(a, familyName, bndType=None)

Add a family node to a base node of a tree. The family can designates a set of zone (family of zones) or @@ -1812,7 +1812,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.tagWithFamily(a, familyName, add=False)

Tag zones or a BC nodes with a family name. If a is a pyTree, base, zone or list of zones, family is supposed @@ -1858,7 +1858,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getFamilyZones(a, familyName)

Get all zones of given family (family of zones).

@@ -1897,7 +1897,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getFamilyBCs(a, familyName)

Get all BC nodes corresponding to a given familyName (family of BCs).

@@ -1938,7 +1938,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getFamilyZoneNames(a)

Return all family zone names defined in a.

@@ -1974,7 +1974,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getFamilyBCNamesOfType(a, bndType=None)

Return all family BC names of a given type. If type is None, return all family BC names.

@@ -2016,7 +2016,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getFamilyBCNamesDict(a)

Return all family BC names contained in a as a dictionary ‘familyName’, ‘BCType’. The dictionary is dict[‘familyName’] = ‘BCType’.

@@ -2055,7 +2055,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.getValue(a, var, ind)

Return the field value(s) defined in a zone a for point of index ind (for both structured and unstructured zones). @@ -2114,7 +2114,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.setValue(a, var, ind, value)

Set the values of one point of index ind in a zone a. var is the name of the field variable @@ -2157,7 +2157,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.setPartialFields(a, F, I, loc='nodes', startFrom=0)

Set the values for a given list of indices. Field values are given as a list of arrays in F (one array for each zone), indices are given as @@ -2203,7 +2203,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.addVars(a, vars)

Add given variables. Variables are added to the flow container as described by Internal.__FlowSolutionNodes__ or @@ -2243,7 +2243,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.fillMissingVariables(a)

Add missing variables and reorder variables for all zones, such that all zones have the same variables at the end.

@@ -2280,7 +2280,7 @@

pyTree creation and manipulation

-
+
Converter.PyTree.cpVars(a1, var1, a2, var2)

Copy a variable from zone a1, with name var1, to zone a2, with name var2. The var location must be coherent. a1 and a2 can be identical.

@@ -3348,7 +3348,7 @@

Array / PyTree common manipulations

-
+
Converter.PyTree.addGhostCells(t, b, d, adaptBCs=1, modified=[], fillCorner=1)

Add ghost cells to structured grids. if modified is given, limit add ghost cells to given field containers. Otherwise, ghost cells @@ -3398,7 +3398,7 @@

Array / PyTree common manipulations

-
+
Converter.PyTree.rmGhostCells(t, b, d, adaptBCs=1, modified=[])

Remove ghost cells to structured grids. See addGhostCells.

Exists also as in place version (_rmGhostCells) that modifies a and returns None.

@@ -3446,7 +3446,7 @@

Array / PyTree common manipulations

-
+
Converter.PyTree.signNGonFaces(t)

For NGON zones, sign the NFACE connectivity with cell external normals.

Exists also as in place version (_signNGonFaces) that modifies t and returns None.

@@ -3475,7 +3475,7 @@

Array / PyTree common manipulations

-
+
Converter.PyTree.makeParentElements(t)

For NGON zones, construct parent elements array from NFACE connectivity. Always checks the validity of input mesh. Raises error if mesh is invalid.

@@ -4150,7 +4150,7 @@

Array / PyTree input/output

-
+
Converter.PyTree.convertFile2PyTree(fileName, format=None, options)

Read a file and return a CGNS pyTree (pyTree interface). If format is not given, it is guessed from file header or extension. @@ -4189,7 +4189,7 @@

Array / PyTree input/output

-
+
Converter.PyTree.convertPyTree2File(t, fileName, format=None, options)

Write a pyTree to a file (pyTree interface). If format is not given, it is guessed from file name extension.

Converter.PyTree.newPyTree([args])

Converter.PyTree.newPyTree([args])

Create a new PyTree.

Converter.PyTree.addBase2PyTree(t, baseName)

Converter.PyTree.addBase2PyTree(t, baseName)

Add a base name to a pyTree.

Converter.PyTree.getNobOfBase(base, t)

Converter.PyTree.getNobOfBase(base, t)

Return the nob of a base in t.

Converter.PyTree.getNobNozOfZone(a, t)

Converter.PyTree.getNobNozOfZone(a, t)

Return the (nob, noz) of a in t.

Converter.PyTree.breakConnectivity(t)

Converter.PyTree.breakConnectivity(t)

Break a multi-element zone into single element zones.

Converter.PyTree.mergeConnectivity(z1[, z2, ...])

Converter.PyTree.mergeConnectivity(z1[, z2, ...])

Gather an additional zone connectivity in z1.

Converter.PyTree.deleteEmptyZones(t)

Converter.PyTree.deleteEmptyZones(t)

Delete zones with null number of points or elements.

Converter.PyTree.addState(t[, state, value, ...])

Converter.PyTree.addState(t[, state, value, ...])

Add single state value or a full reference state.

Converter.PyTree.addChimera2Base(base, ...)

Converter.PyTree.addChimera2Base(base, ...)

Add chimera setting as node in base.

Converter.PyTree.addBC2Zone(a, bndName, bndType)

Converter.PyTree.addBC2Zone(a, bndName, bndType)

Add a BC to a zone node.

Converter.PyTree.fillEmptyBCWith(t, bndName, ...)

Converter.PyTree.fillEmptyBCWith(t, bndName, ...)

Fill empty BCs with given type.

Converter.PyTree.rmBCOfType(t, bndType)

Converter.PyTree.rmBCOfType(t, bndType)

Remove BCs of given type.

Converter.PyTree.rmBCOfName(t, bndName)

Converter.PyTree.rmBCOfName(t, bndName)

Remove BCs of given name.

Converter.PyTree.rmBCDataVars(t, var)

Converter.PyTree.rmBCDataVars(t, var)

Remove variables var from t in every BCDataSet.

Converter.PyTree.extractBCOfType(t, bndType)

Converter.PyTree.extractBCOfType(t, bndType)

Extract the grid coordinates of given BC type as zones.

Converter.PyTree.extractBCOfName(t, bndName)

Converter.PyTree.extractBCOfName(t, bndName)

Extract the grid coordinates of given BC name as zones.

Converter.PyTree.getEmptyBC(a[, dim, ...])

Converter.PyTree.getEmptyBC(a[, dim, ...])

Return the range or facelist of unset boundary conditions.

Converter.PyTree.getBCs(t[, reorder, extrapFlow])

Converter.PyTree.getBCs(t[, reorder, extrapFlow])

Return geometry, names and types of boundary conditions.

Converter.PyTree.recoverBCs(a, T[, tol])

Converter.PyTree.recoverBCs(a, T[, tol])

Recover given BCs on a tree.

Converter.PyTree.extractBCFields(z[, varList])

Converter.PyTree.extractBCFields(z[, varList])

Extract fields on BCs.

Converter.PyTree.getConnectedZones(a, topTree)

Converter.PyTree.getConnectedZones(a, topTree)

Return the list of zones connected to a through match or nearMatch.

Converter.PyTree.addFamily2Base(base, familyName)

Converter.PyTree.addFamily2Base(base, familyName)

Add a family node to a base node.

Converter.PyTree.tagWithFamily(z, familyName)

Converter.PyTree.tagWithFamily(z, familyName)

Tag a zone node or a BC node with a familyName.

Converter.PyTree.getFamilyZones(t, familyName)

Converter.PyTree.getFamilyZones(t, familyName)

Return all zones that have this familyName.

Converter.PyTree.getFamilyBCs(t, familyName)

Converter.PyTree.getFamilyBCs(t, familyName)

Return all BC nodes that have this familyName.

Converter.PyTree.getFamilyZoneNames(t)

Converter.PyTree.getFamilyZoneNames(t)

Return the family zone names in a tree or a base.

Converter.PyTree.getFamilyBCNamesOfType(t[, ...])

Converter.PyTree.getFamilyBCNamesOfType(t[, ...])

Return the family BC names of a given type.

Converter.PyTree.getFamilyBCNamesDict(t)

Converter.PyTree.getFamilyBCNamesDict(t)

Return the dictionary of familyBCs.

Converter.PyTree.getValue(t, var, ind)

Converter.PyTree.getValue(t, var, ind)

Return the values for a point of index ind or (i,j,k).

Converter.PyTree.setValue(t, var, ind, val)

Converter.PyTree.setValue(t, var, ind, val)

Set the values in an array for a point of index ind or (i,j,k).

Converter.PyTree.setPartialFields(t, arrays, ...)

Converter.PyTree.setPartialFields(t, arrays, ...)

Set some field values for given indices.

Converter.PyTree.addVars(t, vars)

Converter.PyTree.addVars(t, vars)

Add variables to a pyTree.

Converter.PyTree.fillMissingVariables(t)

Converter.PyTree.fillMissingVariables(t)

Fill FlowSolution nodes with variables, such that all the zones have the same variables.

Converter.PyTree.cpVars(t1, var1, t2, var2)

Converter.PyTree.cpVars(t1, var1, t2, var2)

Copy field variables.

Converter.center2Node(array[, cellNType, ...])

Convert array defined on centers to array defined on nodes.

Converter.PyTree.addGhostCells(t, b, d[, ...])

Converter.PyTree.addGhostCells(t, b, d[, ...])

Add ghost cells to pyTree.

Converter.PyTree.rmGhostCells(t, b, d[, ...])

Converter.PyTree.rmGhostCells(t, b, d[, ...])

Remove ghost cells to a pyTree.

Converter.PyTree.signNGonFaces(t)

Converter.PyTree.signNGonFaces(t)

Sign NFACE connectivity in NGON zones.

Converter.convertArrays2File(arrays, fileName)

Write arrays to output file.

Converter.PyTree.convertFile2PyTree(fileName)

Converter.PyTree.convertFile2PyTree(fileName)

Read a file and return a pyTree containing file data.

Converter.PyTree.convertPyTree2File(t, fileName)

Converter.PyTree.convertPyTree2File(t, fileName)

Write a pyTree to a file.