feat: database submodule
#3748
Open
feat: database submodule
#3748
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clatapie
requested review from
germa89 and
pyansys-ci-bot
and removed request for
a team
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
github-actions
bot
added
documentation
…mapdl into feat/database_submodule
germa89
reviewed
Feb 18, 2025
|
|
||
| APDL Command: CMDELE | ||
| .. _CMLIST_notes: |
There was a problem hiding this comment.
I believe that the references should be located above the section header. So you can reference to them using :ref:.
See: https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref
Comment on lines
70
to
73
| and for each component list the underlying entity ID's. :ref:`cmlist`, ``Name`` - List the specified | ||
| component. :ref:`cmlist`, ``Name``,EXPA - List specified component along with all underlying entity | ||
| ID's. :ref:`cmlist`, EXPA, ``Entity`` - List all selected components of specified entity | ||
| type. For each component also list the underlying entity ID's. |
There was a problem hiding this comment.
I think this format is wrong...
Comment on lines
+209
to
+210
| 0 - Component is not updated during remeshing and therefore contains only initial mesh elements | ||
| (default). 1 - Component is updated during remeshing to contain the updated elements. |
Comment on lines
+435
to
+443
| :ref:`cmplot`, ``CNAME`` - Plots the specified component (if selected). :ref:`cmplot`, ``CNAME``, | ||
| ALL - Plot component in the context of all other selected entity components of the same type as the | ||
| component. :ref:`cmplot` - Plot the first eleven selected components. :ref:`cmplot`,ALL - Plot all | ||
| selected components. :ref:`cmplot`,N or :ref:`cmplot`,P - Plot next or previous set of eleven | ||
| components. :ref:`cmplot`,ALL, ``Entity`` - Plot all selected components of type specified in | ||
| ``Entity``. :ref:`cmplot`, ``Entity`` - Plot components of type specified in ``Entity``, from the | ||
| first eleven components. :ref:`cmplot`,N, ``Entity`` - Plot components of type specified in | ||
| ``Entity``, if any, from the next set of eleven components (substitute P for N to plot from previous | ||
| set). |
Comment on lines
+94
to
+95
| edit this | ||
| set of commands. |
Comment on lines
66
to
67
| (rotations); ROT (ROTX, | ||
| ROTY, and ROTZ); DISP (U and ROT); HDSP (Hydrostatic pressure). |
Comment on lines
83
to
100
| Used only with ``Type`` = S, A, or U. Valid lables are: | ||
|
|
||
| **Structural labels** : UX, UY, or UZ (displacements); U (UX, UY, and UZ) ; ROTX, ROTY, or ROTZ | ||
| (rotations); ROT (ROTX, | ||
| ROTY, and ROTZ); DISP (U and ROT); HDSP (Hydrostatic pressure). | ||
| **Thermal labels** : TEMP, TBOT, TE2, TE3...., TTOP (temperature). | ||
| **Acoustic labels** : PRES (pressure); UX, UY, or UZ (displacements for FSI coupled elements). | ||
| **Electric labels** : VOLT (voltage); EMF (electromotive force drop); CURR (current). | ||
| **Magnetic labels** : MAG (scalar magnetic potential); AZ (vector magnetic potential); A (AZ); CURR | ||
| (current). | ||
| **Structural force labels** : FX, FY, or FZ (forces); F (FX, FY, and FZ); MX, MY, or MZ (moments); M | ||
| (MX, MY, and MZ); FORC (F | ||
| and M); DVOL (fluid mass flow rate). | ||
| **Thermal force labels** : HEAT, HBOT, HE2, HE3...., HTOP (heat flow). | ||
| **Fluid flow force label** : FLOW (fluid flow). | ||
| **Electric force labels** : AMPS (current flow); CHRG (electric charge). | ||
| **Magnetic force labels** : FLUX (scalar magnetic flux); CSGZ (magnetic current segment). | ||
| **Diffusion labels** : CONC (concentration); RATE (diffusion flow rate). |
There was a problem hiding this comment.
We are repeating the same content as dof1... what did we agree about this? To repeat or mention same as argX?
Comment on lines
348
to
350
| If ``VMIN`` = ``VMAX``, ``Toler`` = 0.005 x ``VMIN``. | ||
| If ``VMIN`` = ``VMAX`` = 0.0, ``Toler`` = 1.0E-6. | ||
| If ``VMAX`` ≠ ``VMIN``, ``Toler`` = 1.0E-8 x ( ``VMAX`` - ``VMIN`` ). |
There was a problem hiding this comment.
it might be a good idea to make this bullet points, or similar. Otherwise, sphinx will render it as just one line.
germa89
approved these changes
Feb 18, 2025
Comment on lines
+552
to
+554
| If ``VMIN`` = ``VMAX``, ``Toler`` = 0.005 x ``VMIN``. | ||
| If ``VMIN`` = ``VMAX`` = 0.0, ``Toler`` = 1.0E-6. | ||
| If ``VMAX`` ≠ ``VMIN``, ``Toler`` = 1.0E-8 x ( ``VMAX`` - ``VMIN`` ). |
There was a problem hiding this comment.
Same, better a bullet list.
Comment on lines
806
to
808
| item : str | ||
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_ESEL.html>`_ for further | ||
| information. | ||
|
|
||
| Item | ||
| Label identifying data. Valid item labels are shown in the table below. Some items also require a | ||
| component label. If Item = PICK (or simply "P"), graphical picking is enabled and all remaining | ||
| command fields are ignored (valid only in the GUI). Defaults to KP. | ||
| comp : str | ||
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_ESEL.html>`_ for further | ||
| information. | ||
|
|
||
| Comp | ||
| Component of the item (if required). Valid component labels are shown in the table below. | ||
| vmin : str | ||
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_ESEL.html>`_ for further | ||
| information. | ||
|
|
||
| VMIN | ||
| Minimum value of item range. Ranges are keypoint numbers, coordinate values, attribute numbers, | ||
| etc., as appropriate for the item. A component name (as specified on the CM (p. 338) command) |
There was a problem hiding this comment.
The description of the argument is missing in the Python function. Please, refer to the `command documentation
??
| - Element number. | ||
| * - ADJ | ||
| - | ||
| - Elements adjacent to element ``VMIN`` ( ``VMAX`` and ``VINC`` fields are ignored). Only elements (of the same dimensionality) adjacent to lateral faces are considered. Progression continues until edge of model or until more than two elements are adjacent at a face. |
There was a problem hiding this comment.
Is it possible to break the line??
Comment on lines
+1141
to
1145
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_NSEL.html>`_ for further | ||
| information. | ||
|
|
There was a problem hiding this comment.
Again missing the description of the argument... ??
Comment on lines
1603
to
1606
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_VSEL.html>`_ for further | ||
| information. |
Comment on lines
+1890
to
+1894
| item : str | ||
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_ASEL.html>`_ for further | ||
| information. |
Comment on lines
+211
to
+214
| The description of the argument is missing in the Python function. Please, refer to the `command | ||
| documentation | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_UNITS.html>`_ for further | ||
| information. |
Comment on lines
+453
to
+464
| PREP7 topic commands (and their corresponding topics) are: | ||
|
|
||
| InformalTables need to be added. | ||
| SOLUTION topic commands (and their corresponding topics) are: | ||
|
|
||
| InformalTables need to be added. | ||
| POST1 topic commands (and their corresponding topics) are: | ||
|
|
||
| InformalTables need to be added. | ||
| POST26 topic commands (and their corresponding topics) are: | ||
|
|
||
| InformalTables need to be added. |
There was a problem hiding this comment.
I hope you took note of this TODOs
|
The towncrier template has been successfully rewritten with the default template. |
github-actions
bot
added
CI/CD
github-actions
bot
removed
CI/CD
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.
This PR focus on the
databasesubmodule.Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.
Issue linked
This PR is meant to be merged within the feat/main_commands branch. The latter will gather all the submodule changes, one by one, prior to be merged to the main branch.
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)