From a428b2d62b5cc18c48da630260ec25cc032f1d79 Mon Sep 17 00:00:00 2001 From: German Date: Mon, 1 Apr 2024 13:03:45 +0200 Subject: [PATCH 1/2] Some format fix --- .../core/_commands/apdl/abbreviations.py | 8 +- .../mapdl/core/_commands/apdl/array_param.py | 57 +- .../core/_commands/aux12_/radiation_mat.py | 18 +- .../core/_commands/aux12_/radiosity_solver.py | 112 +-- src/ansys/mapdl/core/_commands/aux15_.py | 56 +- .../mapdl/core/_commands/aux2_/bin_dump.py | 9 +- .../mapdl/core/_commands/aux2_/bin_manip.py | 104 +-- src/ansys/mapdl/core/_commands/aux3_.py | 14 +- src/ansys/mapdl/core/_commands/conn.py | 127 ++-- .../core/_commands/database/components.py | 275 +++++--- .../core/_commands/database/coord_sys.py | 90 ++- .../mapdl/core/_commands/database/picking.py | 37 +- .../core/_commands/database/selecting.py | 537 ++++++++++----- .../mapdl/core/_commands/database/setup.py | 30 +- .../core/_commands/database/working_plane.py | 24 +- .../mapdl/core/_commands/display_/setup.py | 104 +-- .../core/_commands/graphics_/annotation.py | 275 +++++--- .../mapdl/core/_commands/graphics_/graphs.py | 239 ++++--- .../core/_commands/graphics_/labeling.py | 645 +++++++++++------- .../mapdl/core/_commands/graphics_/scaling.py | 189 +++-- src/ansys/mapdl/core/_commands/hidden.py | 12 +- src/ansys/mapdl/core/_commands/map_cmd.py | 42 +- .../mapdl/core/_commands/post1_/load_case.py | 109 +-- .../mapdl/core/_commands/preproc/database.py | 366 ++++++---- 24 files changed, 2177 insertions(+), 1302 deletions(-) diff --git a/src/ansys/mapdl/core/_commands/apdl/abbreviations.py b/src/ansys/mapdl/core/_commands/apdl/abbreviations.py index 939048561b..bff4f124c9 100644 --- a/src/ansys/mapdl/core/_commands/apdl/abbreviations.py +++ b/src/ansys/mapdl/core/_commands/apdl/abbreviations.py @@ -77,8 +77,12 @@ def abbres(self, lab="", fname="", ext="", **kwargs): lab Label that specifies the read operation: - Replace current abbreviation set with these abbreviations (default). - Extend current abbreviation set with these abbreviations, replacing any of the - same name that already exist. + NEW + Replace current abbreviation set with these abbreviations (default). + + CHANGE + Extend current abbreviation set with these abbreviations, replacing any of the + same name that already exist. fname File name and directory path (248 characters maximum, including the diff --git a/src/ansys/mapdl/core/_commands/apdl/array_param.py b/src/ansys/mapdl/core/_commands/apdl/array_param.py index 307ca2152e..09d47f87ac 100644 --- a/src/ansys/mapdl/core/_commands/apdl/array_param.py +++ b/src/ansys/mapdl/core/_commands/apdl/array_param.py @@ -32,9 +32,13 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar oper Type of Fourier operation: - Calculate Fourier coefficients COEFF from MODE, ISYM, - THETA, and CURVE. - Evaluate the Fourier curve CURVE from - COEFF, MODE, ISYM and THETA. + FIT + Calculate Fourier coefficients COEFF from MODE, ISYM, + THETA, and CURVE. + + EVAL + Evaluate the Fourier curve CURVE from + COEFF, MODE, ISYM and THETA. coeff Name of the array parameter vector containing the Fourier @@ -50,7 +54,11 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar the corresponding Fourier terms. The vector should contain keys for each term as follows: - Symmetric (cosine) term - Antisymmetric (sine) term. + 0 or 1 + Symmetric (cosine) term + + -1 + Antisymmetric (sine) term. theta, curve Names of the array parameter vectors containing the theta vs. curve @@ -174,16 +182,22 @@ def moper( oper Matrix operations: - * `INVERT` - ``(*MOPER, ParR, Par1, INVERT)`` + * `INVERT` + ``(*MOPER, ParR, Par1, INVERT)`` Square matrix invert: Inverts the ``n`` x ``n`` matrix in ``Par1`` into ``ParR``. The matrix must be well conditioned. - **Warning**: Non-independent or ill-conditioned equations can - cause erroneous results. - For large matrices, use the + ..warning:: + + Non-independent or ill-conditioned equations can + cause erroneous results. + + For large matrices, use the APDL Math operation ``*LSFACTOR`` for efficiency (see APDL Math). - * `MULT` - ``(*MOPER, ParR, Par1, MULT, Par2)`` + * `MULT` + ``(*MOPER, ParR, Par1, MULT, Par2)`` Matrix multiply: Multiplies ``Par1`` by ``Par2``. The number of rows of ``Par2`` must equal the number of columns of ``Par1`` for the operation. If ``Par2`` is input with a number of rows @@ -192,7 +206,8 @@ def moper( number of rows of ``Par2`` equal to the number of columns of ``Par1``. - * `COVAR` - ``(*MOPER, ParR, Par1, COVAR, Par2)`` + * `COVAR` + ``(*MOPER, ParR, Par1, COVAR, Par2)`` Covariance: The measure of association between two columns of the input matrix (``Par1``). ``Par1``, of size m runs (rows) by ``n`` data (columns) is first processed to produce a row @@ -202,7 +217,8 @@ def moper( ``n`` matrix (``ParR``) of covariances (with the variances as the diagonal terms). - * `CORR` - ``(*MOPER, ParR, Par1, CORR, Par2)`` + * `CORR` + ``(*MOPER, ParR, Par1, CORR, Par2)`` Correlation: The correlation coefficient between two variables. The input matrix (``Par1``), of size m runs (rows) by n data (columns), is first processed to produce a row @@ -212,7 +228,8 @@ def moper( ``n`` matrix (``ParR``) of correlation coefficients (with a value of 1.0 for the diagonal terms). - * `SOLV` - ``(*MOPER, ParR, Par1, SOLV, Par2)`` + * `SOLV` + ``(*MOPER, ParR, Par1, SOLV, Par2)`` Solution of simultaneous equations: Solves the set of ``n`` equations of n terms of the form ``an_1 x_1 + an_2 x_2 + ... + an_n x_n = b_n`` where ``Par1`` contains the matrix of @@ -226,7 +243,8 @@ def moper( APDL Math operation ``*LSFACTOR`` for efficiency (see APDL Math). - * `SORT` - ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)`` + * `SORT` + ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)`` Matrix sort: Sorts matrix ``Par1`` according to sort vector ``Par2`` and places the result back in ``Par1``. Rows of ``Par1`` are moved to the corresponding positions indicated by the @@ -238,7 +256,8 @@ def moper( row positions (the permutation vector). Sorting ``Par1`` according to ``ParR`` should reproduce the initial ordering. - * `NNEAR` - ``(*MOPER, ParR, Par1, NNEAR, Toler)`` + * `NNEAR` + ``(*MOPER, ParR, Par1, NNEAR, Toler)`` Nearest Node: Quickly determine all the nodes within a specified tolerance of a given array. ``ParR`` is a vector of the nearest selected nodes, or 0 if no nodes are nearer @@ -246,7 +265,8 @@ def moper( locations. ``Toler`` defaults to 1 and is limited to the maximum model size. - * `ENEAR` - ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)`` + * `ENEAR` + ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)`` Nearest Element: Quickly determine the elements with centroids that are within a specified tolerance of the points in a given array. - ``ParR`` is a vector of the nearest @@ -254,7 +274,8 @@ def moper( than ``Toler``. ``Par1`` is the ``n`` x 3 array of coordinate locations. - * `MAP` - ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)`` + * `MAP` + ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)`` Maps the results from one set of points to another. For example, you can map pressures from a CFD analysis onto your model for a structural analysis. @@ -297,14 +318,16 @@ def moper( bounds. Results mapping is available from the command line only. - * `INTP` - ``(*MOPER, ParR, Par1, INTP, Par2)`` + * `INTP` + ``(*MOPER, ParR, Par1, INTP, Par2)`` Finds the elements that contain each point in the array of ``n`` x 3 points in ``Par1``. ``Par2`` will contain the set of element ID numbers and ``ParR`` will contain their ``n`` x 3 set of natural element coordinates (values between -1 and 1). ``Par1`` must be in global Cartesian coordinates. - * `SGET` - ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)`` + * `SGET` + ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)`` Gets the nodal solution item corresponding to Label and Comp (see the PLNSOL command) and interpolates it to the given element locations. ``Par1`` contains the ``n`` x 3 array of diff --git a/src/ansys/mapdl/core/_commands/aux12_/radiation_mat.py b/src/ansys/mapdl/core/_commands/aux12_/radiation_mat.py index f9f58f1b26..e82b43a7c7 100644 --- a/src/ansys/mapdl/core/_commands/aux12_/radiation_mat.py +++ b/src/ansys/mapdl/core/_commands/aux12_/radiation_mat.py @@ -58,9 +58,11 @@ def geom(self, k2d="", ndiv="", **kwargs): k2d Dimensionality key: - 0 - 3-D geometry (default) + 0 + 3-D geometry (default) - 1 - 2-D geometry (plane or axisymmetric) + 1 + 2-D geometry (plane or axisymmetric) ndiv Number of divisions in an axisymmetric model. Used only with K2D = @@ -82,9 +84,11 @@ def mprint(self, key="", **kwargs): key Print key: - 0 - Do not print matrices. + 0 + Do not print matrices. - 1 - Print matrices. + 1 + Print matrices. Notes ----- @@ -129,9 +133,11 @@ def vtype(self, nohid="", nzone="", **kwargs): nohid Type of viewing procedure: - 0 - Hidden procedure. + 0 + Hidden procedure. - 1 - Non-hidden (faster, but less general) procedure. + 1 + Non-hidden (faster, but less general) procedure. nzone Number of sampling zones for the hidden procedure (100 maximum for diff --git a/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py b/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py index 9b978d9f93..82d5955672 100644 --- a/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py +++ b/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py @@ -62,11 +62,14 @@ def radopt( solver Choice of solver for radiosity calculation: - 0 - Gauss-Seidel iterative solver (default). + 0 + Gauss-Seidel iterative solver (default). - 1 - Direct solver. + 1 + Direct solver. - 2 - Jacobi solver. + 2 + Jacobi solver. maxiter Maximum number of iterations for iterative solver (SOLVER = 0 or @@ -84,22 +87,20 @@ def radopt( Maximum number of flux iterations to be performed according to the specified solver type: - 0 - If the FULL solver is specified (THOPT,FULL), convergence criteria are - monitored and iterations are performed until convergence - occurs. If the QUASI solver is specified (THOPT,QUASI), - convergence criteria are ignored and one iteration is - performed. This value is the default. - - 1, 2, 3, ...N - If the FULL solver is specified - (THOPT,FULL), convergence criteria are - monitored and iterations are performed - until convergence occurs, or until the - specified number of iterations has been - completed, whichever comes first. If the - QUASI solver is specified (THOPT,QUASI), - convergence criteria are ignored and the - specified number of iterations are - completed. + 0 + If the FULL solver is specified (THOPT,FULL), convergence + criteria are monitored and iterations are performed until + convergence occurs. If the QUASI solver is specified + (THOPT,QUASI), convergence criteria are ignored and one + iteration is performed. This value is the default. + + 1, 2, 3, ...N + If the FULL solver is specified (THOPT,FULL), convergence + criteria are monitored and iterations are performed until + convergence occurs, or until the specified number of iterations + has been completed, whichever comes first. If the QUASI solver + is specified (THOPT,QUASI), convergence criteria are ignored and + the specified number of iterations are completed. Notes ----- @@ -232,9 +233,11 @@ def v2dopt(self, geom="", ndiv="", hidopt="", nzone="", **kwargs): geom Choice of geometry: - 0 - Planar (default). + 0 + Planar (default). - 1 - Axisymmetric + 1 + Axisymmetric ndiv Number of divisions for axisymmetric geometry (that is, the number @@ -243,9 +246,11 @@ def v2dopt(self, geom="", ndiv="", hidopt="", nzone="", **kwargs): hidopt Viewing option: - 0 - Hidden (default). + 0 + Hidden (default). - 1 - Non-hidden + 1 + Non-hidden nzone Number of zones (that is, the number of rays emanating from a @@ -266,12 +271,15 @@ def vfsm(self, action="", encl="", opt="", maxiter="", conv="", **kwargs): action Action to be performed: - Define - Define a view factor summation (default) + Define + Define a view factor summation (default) - Clear - Resets the scaling method to 0 for all - enclosures. All subsequent arguments are ignored. + Clear + Resets the scaling method to 0 for all + enclosures. All subsequent arguments are ignored. - Status - Outputs the OPT value for each enclosure in the model. + Status + Outputs the OPT value for each enclosure in the model. encl Previously defined enclosure number for the view factor adjustment. @@ -279,19 +287,24 @@ def vfsm(self, action="", encl="", opt="", maxiter="", conv="", **kwargs): opt Option key: - 0 - The view factor matrix values are not adjusted (default). + 0 + The view factor matrix values are not adjusted (default). - 1 - The view factor matrix values are adjusted so that the + 1 + The view factor matrix values are adjusted so that the row sum equals 1.0. - 2 - The view factor matrix values are adjusted so that the + 2 + The view factor matrix values are adjusted so that the row sum equals 1.0 and the reciprocity relationship is satisfied. - 3 - The view factor matrix values are adjusted so that the + 3 + The view factor matrix values are adjusted so that the original row sum is maintained. - 4 - The view factor matrix values are adjusted so that the + 4 + The view factor matrix values are adjusted so that the original row sum is maintained and the reciprocity relationship is satisfied. @@ -343,16 +356,20 @@ def vfopt( opt View factor option: - NEW - Calculate view factors and write them to a file. + NEW + Calculate view factors and write them to a file. - OFF - Do not recalculate view factors it they already exist in the database, + OFF + Do not recalculate view factors it they already exist in the database, otherwise calculate compute them. This option is the default behavior. - READ - Read view factors from a binary file. For subsequent SOLVE commands, switch to + READ + Read view factors from a binary file. For subsequent SOLVE commands, switch to the default option (OFF). - NONE - Do not write view factors to a file. + NONE + Do not write view factors to a file. fname File name for view factor matrix. Default = Jobname. @@ -367,16 +384,31 @@ def vfopt( filetype View factor file type: - BINA - Binary (default). + BINA + Binary (default). - ASCI - ASCII. + ASCI + ASCII. fileformat Format for the specified Filetype: - Binary files (Filetype = BINA): - 0 + Binary files (Filetype = BINA): - No compression. (View factor file size may be very large.) - 1 + 0 + No compression. (View factor file size may be very large.) + + 1 + Zeroes are compressed out. (Useful for large models to reduce + the view factor file size.) + + ASCII files (Filetype = ASCI): + + 0 + 10F7.4 (low precision, lower accuracy). + + 1 + 7F11.8 (high precision, higher accuracy). Notes ----- diff --git a/src/ansys/mapdl/core/_commands/aux15_.py b/src/ansys/mapdl/core/_commands/aux15_.py index 010165b90a..00c6f58792 100644 --- a/src/ansys/mapdl/core/_commands/aux15_.py +++ b/src/ansys/mapdl/core/_commands/aux15_.py @@ -90,42 +90,60 @@ def ioptn(self, lab="", val1="", **kwargs): Label identifying the import option. The meaning of VAL1 varies depending on Lab. - STAT - List overall status of import facilities, including current option values. - VAL1 is ignored. + STAT + List overall status of import facilities, including current option values. + VAL1 is ignored. - DEFA - Set default values for all import options. VAL1is ignored. + DEFA + Set default values for all import options. VAL1is ignored. - MERG - Entity merge option. VAL1 can be: + MERG + Entity merge option. VAL1 can be: - YES - Automatic merging is performed (default). + YES + Automatic merging is performed (default). - NO - No merging of entities. + NO + No merging of entities. - SOLID - Solid option. VAL1 can be: + SOLID + Solid option. VAL1 can be: - YES - Solid is created automatically (default). + YES + Solid is created automatically (default). - NO - No solid created. + NO + No solid created. - GTOLER - Entity merging tolerance. If IGES = SMOOTH, the GTOLER,VAL1 can be: + GTOLER + Entity merging tolerance. If IGES = SMOOTH, the GTOLER,VAL1 can be: - DEFA - Use system defaults (default). + DEFA + Use system defaults (default). - FILE - Use tolerance from the imported file. + FILE + Use tolerance from the imported file. - n - A user-specified tolerance value. + n + A user-specified tolerance value. - IGES - IGES import option. VAL1 can be: + IGES + IGES import option. VAL1 can be: - STAT - List status of IGES related options in the output window. + STAT + List status of IGES related options in the output window. - SMOOTH (or RV52) - Use more robust IGES revision 5.2 import function (default). + SMOOTH (or RV52) + Use more robust IGES revision 5.2 import function (default). - SMALL - Small areas option. VAL1 can be: + SMALL + Small areas option. VAL1 can be: - YES - Small areas are deleted (default). + YES + Small areas are deleted (default). - NO - Small areas are retained. + NO + Small areas are retained. val1 Additional input value as described under each Lab option. diff --git a/src/ansys/mapdl/core/_commands/aux2_/bin_dump.py b/src/ansys/mapdl/core/_commands/aux2_/bin_dump.py index b1899e48a1..8e7538ec35 100644 --- a/src/ansys/mapdl/core/_commands/aux2_/bin_dump.py +++ b/src/ansys/mapdl/core/_commands/aux2_/bin_dump.py @@ -79,11 +79,14 @@ def form(self, lab="", **kwargs): lab Format: - RECO - Basic record description only (minimum output) (default). + RECO + Basic record description only (minimum output) (default). - TEN - Same as RECO plus the first ten words of each record. + TEN + Same as RECO plus the first ten words of each record. - LONG - Same as RECO plus all words of each record. + LONG + Same as RECO plus all words of each record. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/aux2_/bin_manip.py b/src/ansys/mapdl/core/_commands/aux2_/bin_manip.py index 71c2c53285..303b1a40cb 100644 --- a/src/ansys/mapdl/core/_commands/aux2_/bin_manip.py +++ b/src/ansys/mapdl/core/_commands/aux2_/bin_manip.py @@ -33,29 +33,41 @@ def combine(self, filetype="", **kwargs): Type of solution file to combine. There is no default; if (blank), the command is ignored. - RST - Structural results file (.RST) + RST + Structural results file (.RST) - RTH - Thermal results file (.RTH) + RTH + Thermal results file (.RTH) - RMG - Magnetics results file (.RMG) + RMG + Magnetics results file (.RMG) - RSTP - Linear perturbation results file (.RSTP) + RSTP + Linear perturbation results file (.RSTP) - EMAT - Element matrix file (.EMAT). + EMAT + Element matrix file (.EMAT). - ESAV - Element saved data file (.ESAV) + ESAV + Element saved data file (.ESAV) - MODE - Modal results file (.MODE) + MODE + Modal results file (.MODE) - MLV - Modal load vector file (.MLV) + MLV + Modal load vector file (.MLV) - IST - Initial state file (.IST) + IST + Initial state file (.IST) - FULL - Full matrix file (.FULL) + FULL + Full matrix file (.FULL) - RFRQ - Reduced complex displacement file (.RFRQ) + RFRQ + Reduced complex displacement file (.RFRQ) - RDSP - Reduced displacement file (.RDSP) + RDSP + Reduced displacement file (.RDSP) Notes ----- @@ -111,39 +123,48 @@ def hbmat(self, fname="", ext="", form="", matrx="", rhs="", mapping="", **kwarg form Specifies format of output matrix file: - ASCII - Write output matrix file in ASCII form. + ASCII + Write output matrix file in ASCII form. - BIN - Write output matrix file in binary form. + BIN + Write output matrix file in binary form. matrx Specify which matrix to write to the output matrix file: - STIFF - Write stiffness matrix to output matrix file. Valid for all types of analyses - that write a .FULL file. + STIFF + Write stiffness matrix to output matrix file. Valid for all types of analyses + that write a .FULL file. - MASS - Write mass matrix to output matrix file. Valid for buckling, substructure, and - modal analyses. If .FULL file was generated in a buckling - analysis, then this label will write stress stiffening - matrix to output matrix file. + MASS + Write mass matrix to output matrix file. Valid for buckling, substructure, and + modal analyses. If .FULL file was generated in a buckling + analysis, then this label will write stress stiffening + matrix to output matrix file. - DAMP - Write damping matrix to output matrix file. Only valid for damped modal - analyses. + DAMP + Write damping matrix to output matrix file. Only valid for damped modal + analyses. rhs Specifies whether to write the right-hand side vector to output matrix file: - YES - Write right-hand side vector to output matrix file. + YES + Write right-hand side vector to output matrix file. - NO - Do not write right-hand side vector to output matrix file. + NO + Do not write right-hand side vector to output matrix file. mapping Specifies whether to write the mapping file. This file is always named Fname.MAPPING. - YES - Write the mapping file. + YES + Write the mapping file. - NO - Do not write the mapping file (default). + NO + Do not write the mapping file (default). Notes ----- @@ -232,27 +253,32 @@ def psmat(self, fname="", ext="", matrix="", color="", **kwargs): matrix Specify which matrix to write to the output postscript file: - STIFF - Write stiffness matrix to output postscript file. Valid for all types of - analyses that write a .FULL file. + STIFF + Write stiffness matrix to output postscript file. Valid for all types of + analyses that write a .FULL file. - MASS - Write mass matrix to output postscript file. Valid for buckling, substructure, - and modal analyses. If the .FULL file was generated in a - buckling analysis, then this label will write the stress - stiffening matrix to the output postscript file. + MASS + Write mass matrix to output postscript file. Valid for buckling, substructure, + and modal analyses. If the .FULL file was generated in a + buckling analysis, then this label will write the stress + stiffening matrix to the output postscript file. - DAMP - Write damping matrix to output postscript file. Only valid for damped modal - analyses. + DAMP + Write damping matrix to output postscript file. Only valid for damped modal + analyses. color Specifies whether to display the grid in black and white or in color: - BLACK - Each nonzero coefficient is symbolized by a black square (default). + BLACK + Each nonzero coefficient is symbolized by a black square (default). - COLOR - Each nonzero coefficient is symbolized by a colored square. The color depends - on the module of the coefficient; the range is from blue - for the smallest values to red for the largest values. The - color map is: + COLOR + Each nonzero coefficient is symbolized by a colored square. The color depends + on the module of the coefficient; the range is from blue + for the smallest values to red for the largest values. The + color map is: Notes ----- diff --git a/src/ansys/mapdl/core/_commands/aux3_.py b/src/ansys/mapdl/core/_commands/aux3_.py index 21ac17238a..a38a11f7a3 100644 --- a/src/ansys/mapdl/core/_commands/aux3_.py +++ b/src/ansys/mapdl/core/_commands/aux3_.py @@ -106,9 +106,11 @@ def modify( ktitle Indicates if the set title should be modified. - 0 - Keep the original title. + 0 + Keep the original title. - 1 - Change the title to the title specified with the most current /TITLE command. + 1 + Change the title to the title specified with the most current /TITLE command. Notes ----- @@ -135,10 +137,12 @@ def undelete(self, option="", nstart="", nend="", **kwargs): option Specifies which sets are to be removed from the selected sets. - SET - Specifies one or more particular sets in the results file that are to be - removed from the group of sets selected for deletion. + SET + Specifies one or more particular sets in the results file that are to be + removed from the group of sets selected for deletion. - ALL - Removes all selected sets that are currently selected for deletion. + ALL + Removes all selected sets that are currently selected for deletion. nstart The first set to be removed from the set selected for deletion. diff --git a/src/ansys/mapdl/core/_commands/conn.py b/src/ansys/mapdl/core/_commands/conn.py index 77d55d9d03..d843d95c25 100644 --- a/src/ansys/mapdl/core/_commands/conn.py +++ b/src/ansys/mapdl/core/_commands/conn.py @@ -54,33 +54,42 @@ def cat5in( entity Entity to be imported. - SOLIDS - Solids only, imported as ANSYS volumes (default). + SOLIDS + Solids only, imported as ANSYS volumes (default). - SURFACES - Surfaces only, imported as ANSYS areas. + SURFACES + Surfaces only, imported as ANSYS areas. - ALL - All entities. Use this option when the file contains different types of - entities. + ALL + All entities. Use this option when the file contains different types of + entities. fmt The format in which ANSYS will store the model. - 0 - Neutral format (default). Defeaturing after import is restricted. + 0 + Neutral format (default). Defeaturing after import is restricted. - 1 - Solid format; this allows defeaturing after import. + 1 + Solid format; this allows defeaturing after import. nocl Remove tiny objects. - 0 - Remove tiny objects without checking model validity (default). + 0 + Remove tiny objects without checking model validity (default). - 1 - Do not remove tiny objects. + 1 + Do not remove tiny objects. noan Perform an analysis of the model. - 0 - Analyze the model (default). + 0 + Analyze the model (default). - 1 - Do not analyze the model. + 1 + Do not analyze the model. Notes ----- @@ -103,7 +112,7 @@ def catiain(self, name="", extension="", path="", blank="", **kwargs): name The name of a valid CATIA model, created with CATIA 4.x or lower. The first character of the file name must be an - alphanumeric. Special characters such as & - and * and + alphanumeric. Special characters such as ``&`` ``-`` and ``*`` and spaces are not permitted in the part name. extension @@ -117,10 +126,12 @@ def catiain(self, name="", extension="", path="", blank="", **kwargs): blank Sets whether to import "blanked" entities. - 0 - Does not import "blanked" (suppressed) CATIA entities (default). + 0 + Does not import "blanked" (suppressed) CATIA entities (default). - 1 - Imports "blanked" entities. The portions of CATIA data - that were suppressed will be included in the import. + 1 + Imports "blanked" entities. The portions of CATIA data + that were suppressed will be included in the import. Notes ----- @@ -163,31 +174,39 @@ def parain( entity Entity to be imported: - SOLIDS - Solids only, imported as ANSYS volumes (default) + SOLIDS + Solids only, imported as ANSYS volumes (default) - SURFACES - Surfaces only, imported as ANSYS areas. + SURFACES + Surfaces only, imported as ANSYS areas. - WIREFRAME - Wireframe only, imported as ANSYS lines. + WIREFRAME + Wireframe only, imported as ANSYS lines. - ALL - All entities. Use this option when the file contains - more than one type of entity. + ALL + All entities. Use this option when the file contains + more than one type of entity. fmt Sets the format in which ANSYS will store the model - 0 - Neutral format (default). Defeaturing after import is + 0 + Neutral format (default). Defeaturing after import is restricted. Use this option if you need to scale a model to a specific unit of measure (other than meters). - 1 - Solid format; this allows defeaturing after import. + 1 + Solid format; this allows defeaturing after import. scale Allows scaling for the model - 0 - Do not rescale the model; retain the default Parasolid + 0 + Do not rescale the model; retain the default Parasolid setting of meters (default). - 1 - Scale the model if warranted by the model size. + 1 + Scale the model if warranted by the model size. Notes ----- @@ -207,7 +226,7 @@ def proein(self, name="", extension="", path="", proecomm="", **kwargs): name The name of the Creo Parametric part to be imported, which cannot exceed 64 characters in length and must begin with an alphanumeric - character. Special characters such as & - and * and spaces are not + character. Special characters such as ``&`` ``-`` and ``*`` and spaces are not permitted in the part name. extension @@ -253,7 +272,7 @@ def satin( name The name of a valid .SAT file, created with a supported version of ACIS. The first character of the file name must be an alphanumeric. - Special characters such as & - and * and spaces are not permitted + Special characters such as ``&`` ``-`` and ``*`` and spaces are not permitted in the part name. See File Names in the Command Reference for more information about ANSYS file naming conventions. @@ -268,35 +287,45 @@ def satin( entity Entity to be imported. - SOLIDS - Solids only, imported as ANSYS volumes (Not implemented, imports All). + SOLIDS + Solids only, imported as ANSYS volumes (Not implemented, imports All). - SURFACES - Surfaces only, imported as ANSYS areas (Not implemented, imports All). + SURFACES + Surfaces only, imported as ANSYS areas (Not implemented, imports All). - WIREFRAME - Wireframe only, imported as ANSYS lines (Not implemented, imports All). + WIREFRAME + Wireframe only, imported as ANSYS lines (Not implemented, imports All). - ALL - All entities. Use this option when the file contains different types of - entities. + ALL + All entities. Use this option when the file contains different types of + entities. fmt The format in which ANSYS will store the model. - 0 - Neutral format (default). Defeaturing after import is restricted. + 0 + Neutral format (default). Defeaturing after import is restricted. - 1 - Solid format; this allows defeaturing after import. + 1 + Solid format; this allows defeaturing after import. nocl Remove tiny objects. - 0 - Remove tiny objects without checking model validity (default). + 0 + Remove tiny objects without checking model validity (default). - 1 - Do not remove tiny objects. + 1 + Do not remove tiny objects. noan Perform an ACIS analysis of the model. - 0 - Analyze the model (default). + 0 + Analyze the model (default). - 1 - Do not analyze the model. + 1 + Do not analyze the model. Notes ----- @@ -339,17 +368,21 @@ def ugin( entity Entity to be imported. - 0 or Solid - Solids only, imported as ANSYS volumes (the - default). + 0 or Solid + Solids only, imported as ANSYS volumes (the + default). - 1 or Surface - Surfaces only, imported as ANSYS areas. + 1 or Surface + Surfaces only, imported as ANSYS areas. - 2 or Wireframe - Wireframe only, imported as ANSYS lines. + 2 or Wireframe + Wireframe only, imported as ANSYS lines. - 3 or All - All entities. Use this option when the part - contains entities that may not be attached to each - other, such as a solid in one location and a - surface in another. + 3 or All + All entities. Use this option when the part + contains entities that may not be attached to each + other, such as a solid in one location and a + surface in another. layer The number(s) assigned to the layer(s) to be imported. You can @@ -359,9 +392,11 @@ def ugin( fmt The format in which ANSYS will store the model. - 0 - Neutral format (default). Defeaturing after import is restricted. + 0 + Neutral format (default). Defeaturing after import is restricted. - 1 - Solid format; this allows defeaturing after import. + 1 + Solid format; this allows defeaturing after import. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/database/components.py b/src/ansys/mapdl/core/_commands/database/components.py index 4db5d79815..c3c341869d 100644 --- a/src/ansys/mapdl/core/_commands/database/components.py +++ b/src/ansys/mapdl/core/_commands/database/components.py @@ -50,17 +50,23 @@ def cm( entity Label identifying the type of geometry items to be grouped: - VOLU - Volumes. + VOLU + Volumes. - AREA - Areas. + AREA + Areas. - LINE - Lines. + LINE + Lines. - KP - Keypoints. + KP + Keypoints. - ELEM - Elements. + ELEM + Elements. - NODE - Nodes. + NODE + Nodes. Notes ----- @@ -154,10 +160,12 @@ def cmedit( oper Operation label: - ADD - To add more components. The level of any assembly to be added must be lower - than that of the assembly Aname (see CMGRP command). + ADD + To add more components. The level of any assembly to be added must be lower + than that of the assembly Aname (see CMGRP command). - DELE - To remove components. + DELE + To remove components. cnam1, cnam2, cnam3, . . . , cnam7 Names of components and assemblies to be added to or deleted from @@ -244,24 +252,32 @@ def cmlist( key Expansion key: - 0 - Do not list individual entities in the component. + 0 + Do not list individual entities in the component. - 1 or EXPA - List individual entities in the component. + 1 or EXPA + List individual entities in the component. entity If Name is blank, then the following entity types can be specified: - VOLU - List the volume components only. + VOLU + List the volume components only. - AREA - List the area components only. + AREA + List the area components only. - LINE - List the line components only. + LINE + List the line components only. - KP - List the keypoint components only + KP + List the keypoint components only - ELEM - List the element components only. + ELEM + List the element components only. - NODE - List the node components only. + NODE + List the node components only. Notes ----- @@ -328,38 +344,50 @@ def cmplot( label Name of the component or assembly to be plotted. - (blank) - All selected components and assemblies are plotted (default). If fewer than 11 - components are selected, then all are plotted. If more - than 11 components are selected, then only the first 11 - are plotted. + (blank) + All selected components and assemblies are plotted (default). If fewer than 11 + components are selected, then all are plotted. If more + than 11 components are selected, then only the first 11 + are plotted. - ALL - All selected components are plotted. If number of selected components is - greater than 11, then the legend showing component names will - not be shown. + ALL + All selected components are plotted. If number of selected components is + greater than 11, then the legend showing component names will + not be shown. - N - Next set of defined components and assemblies is plotted. + N + Next set of defined components and assemblies is plotted. - P - Previous set of defined components and assemblies is plotted. + P + Previous set of defined components and assemblies is plotted. - Cname - The specified component or assembly is plotted. + Cname + The specified component or assembly is plotted. - SetNo. - The specified set number is plotted. + SetNo. + The specified set number is plotted. entity If Label is BLANK or ALL, then the following entity types can be specified: - VOLU - Plot the volume components only. + VOLU + Plot the volume components only. - AREA - Plot the area components only. + AREA + Plot the area components only. - LINE - Plot the line components only. + LINE + Plot the line components only. - KP - Plot the keypoint components only. + KP + Plot the keypoint components only. - ELEM - Plot the element components only. + ELEM + Plot the element components only. - NODE - Plot the node components only. + NODE + Plot the node components only. keyword For Keyword = ALL, plot the specified component name in the Label @@ -394,20 +422,26 @@ def cmsel( Parameters ---------- - type\_ + type\\_ Label identifying the type of select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Also select all components. + ALL + Also select all components. - NONE - Unselect all components. + NONE + Unselect all components. name Name of component or assembly whose items are to be selected (valid @@ -416,17 +450,23 @@ def cmsel( entity If Name is blank, then the following entity types can be specified: - VOLU - Select the volume components only. + VOLU + Select the volume components only. - AREA - Select the area components only. + AREA + Select the area components only. - LINE - Select the line components only. + LINE + Select the line components only. - KP - Select the keypoint components only. + KP + Select the keypoint components only. - ELEM - Select the element components only. + ELEM + Select the element components only. - NODE - Select the node components only. + NODE + Select the node components only. Notes ----- @@ -471,54 +511,63 @@ def cmwrite( option Selects which data to write: - ALL - Write all appropriate geometry, material property, - load, and component data (default). Two files will - be produced. Fname.Ext will contain all data items - mentioned in "Notes", except the solid model - data. Fnamei.Exti will contain the solid model - geometry and solid model loads data in the form of - IGES commands. This option is not valid when - CDOPT,ANF is active. - - COMB - Write all data mentioned, but to a single file, - Fname.Ext. Solid model geometry data will be - written in either IGES or ANF format as specified - in the CDOPT command, followed by the remainder of - the data in the form of ANSYS commands. More - information on these (IGES/ANF) file formats is - provided in "Notes". - - DB - Write all database information except the solid model - and solid model loads to Fname.Ext in the form of - ANSYS commands. This option is not valid when - CDOPT,ANF is active. - - SOLID - Write only the solid model geometry and solid - model load data. This output will be in IGES or - ANF format, as specified in the CDOPT - command. More information on these (IGES/ANF) file - formats is provided in "Notes". - - GEOM - Write only element and nodal geometry data. Neither - solid model geometry nor element attribute data - will be written. One file, Fname.Ext, will be - produced. Use CDREAD,DB to read in a file written - with this option. Element types [ET] compatible - with the connectivity of the elements on the file - must first be defined before reading the file in - with CDREAD,DB. - - CM - Write only node and element component and geometry - data to Fname.Ext. - - MAT - Write only material property data (both linear and - nonlinear) to Fname.Ext . - - LOAD - Write only loads for current load step to - Fname.Ext. - - SECT - Write only section data to Fname.Ext. Pretension - sections are not included. + ALL + Write all appropriate geometry, material property, + load, and component data (default). Two files will + be produced. ``Fname.Ext`` will contain all data items + mentioned in "Notes", except the solid model + data. Fnamei.Exti will contain the solid model + geometry and solid model loads data in the form of + IGES commands. This option is not valid when + CDOPT,ANF is active. + + COMB + Write all data mentioned, but to a single file, + ``Fname.Ext``. Solid model geometry data will be + written in either IGES or ANF format as specified + in the CDOPT command, followed by the remainder of + the data in the form of ANSYS commands. More + information on these (IGES/ANF) file formats is + provided in "Notes". + + DB + Write all database information except the solid model + and solid model loads to ``Fname.Ext`` in the form of + ANSYS commands. This option is not valid when + CDOPT,ANF is active. + + SOLID + Write only the solid model geometry and solid + model load data. This output will be in IGES or + ANF format, as specified in the CDOPT + command. More information on these (IGES/ANF) file + formats is provided in "Notes". + + GEOM + Write only element and nodal geometry data. Neither + solid model geometry nor element attribute data + will be written. One file, ``Fname.Ext``, will be + produced. Use CDREAD,DB to read in a file written + with this option. Element types [ET] compatible + with the connectivity of the elements on the file + must first be defined before reading the file in + with CDREAD,DB. + + CM + Write only node and element component and geometry + data to ``Fname.Ext``. + + MAT + Write only material property data (both linear and + nonlinear) to ``Fname.Ext`` . + + LOAD + Write only loads for current load step to + ``Fname.Ext``. + + SECT + Write only section data to ``Fname.Ext``. Pretension + sections are not included. fname @@ -552,22 +601,24 @@ def cmwrite( fmat Format of the output file (defaults to BLOCKED). - BLOCKED - Blocked format. This format allows faster - reading of the output file. The time savings is - most significant when BLOCKED is used to read - .cdb files associated with very large models. + BLOCKED + Blocked format. This format allows faster + reading of the output file. The time savings is + most significant when BLOCKED is used to read + .cdb files associated with very large models. - UNBLOCKED - Unblocked format. + UNBLOCKED + Unblocked format. Notes ----- Load data includes the current load step only. Loads applied to the solid model (if any) are automatically transferred to - the finite element model when this command is issued. CDWRITE + the finite element model when this command is issued. ``CDWRITE`` writes out solid model loads for meshed models only. If the model is not meshed, the solid model loads cannot be saved. Component data include component definitions, but not - assembly definitions. Appropriate NUMOFF commands are included + assembly definitions. Appropriate ``NUMOFF`` commands are included at the beginning of the file; this is to avoid overlap of an existing database when the file is read in. @@ -575,34 +626,34 @@ def cmwrite( file unless you specifically change a default solution setting. - CDWRITE does not support the GSBDATA and GSGDATA commands, and + ``CDWRITE`` does not support the ``GSBDATA`` and ``GSGDATA`` commands, and these commands are not written to the file. The data may be reread (on a different machine, for example) - with the CDREAD command. Caution: When the file is read in, - the NUMOFF,MAT command may cause a mismatch between material + with the ``CDREAD`` command. Caution: When the file is read in, + the ``NUMOFF,MAT`` command may cause a mismatch between material definitions and material numbers referenced by certain loads - and element real constants. See NUMOFF for details. Also, be - aware that the files created by the CDWRITE command explicitly + and element real constants. See ``NUMOFF`` for details. Also, be + aware that the files created by the ``CDWRITE`` command explicitly set the active coordinate system to Cartesian (CSYS,0). You should generally use the blocked format (Fmat = BLOCKED) - when writing out model data with CDWRITE. This is a compressed + when writing out model data with ``CDWRITE``. This is a compressed data format that greatly reduces the time required to read large models through the CDREAD command. The blocked and unblocked formats are described in Chapter 3 of the Guide to Interfacing with ANSYS. - If you use CDWRITE in any of the derived products (ANSYS + If you use ``CDWRITE`` in any of the derived products (ANSYS Mechanical Pro, ANSYS Mechanical Premium), then before reading the file, you must edit the Jobname.cdb file to remove commands that are not available in the respective component product. - The CDWRITE command writes PART information for any ANSYS + The ``CDWRITE`` command writes PART information for any ANSYS LS-DYNA input file to the Jobname.cdb file via the EDPREAD command. (EDPREAD is not a documented command; it is written - only when the CDWRITE command is issued.) The PART information + only when the ``CDWRITE`` command is issued.) The PART information can be automatically read in via the CDREAD command; however, if more than one Jobname.cdb file is read, the PART list from the last Jobname.cdb file overwrites the existing PART list of @@ -614,7 +665,7 @@ def cmwrite( so requires that no used combination of MAT/TYPE/REAL appears more than once in the list. - The CDWRITE command does not support (for beam meshing) any + The ``CDWRITE`` command does not support (for beam meshing) any line operation that relies on solid model associativity. For example, meshing the areas adjacent to the meshed line, plotting the line that contains the orientation nodes, or diff --git a/src/ansys/mapdl/core/_commands/database/coord_sys.py b/src/ansys/mapdl/core/_commands/database/coord_sys.py index aadffd068b..7b22606fef 100644 --- a/src/ansys/mapdl/core/_commands/database/coord_sys.py +++ b/src/ansys/mapdl/core/_commands/database/coord_sys.py @@ -53,13 +53,17 @@ def clocal( kcs Coordinate system type: - 0 or CART - Cartesian + 0 or CART + Cartesian - 1 or CYLIN - Cylindrical (circular or elliptical) + 1 or CYLIN + Cylindrical (circular or elliptical) - 2 or SPHE - Spherical (or spheroidal) + 2 or SPHE + Spherical (or spheroidal) - 3 or TORO - Toroidal + 3 or TORO + Toroidal xl, yl, zl Location (in the active coordinate system) of the origin of the new @@ -129,13 +133,17 @@ def cs( kcs Coordinate system type: - 0 or CART - Cartesian + 0 or CART + Cartesian - 1 or CYLIN - Cylindrical (circular or elliptical) + 1 or CYLIN + Cylindrical (circular or elliptical) - 2 or SPHE - Spherical (or spheroidal) + 2 or SPHE + Spherical (or spheroidal) - 3 or TORO - Toroidal + 3 or TORO + Toroidal norig Node defining the origin of this coordinate system. If NORIG = P, @@ -197,16 +205,20 @@ def cscir(self, kcn="", kthet="", kphi="", **kwargs): Theta singularity location for cylindrical, spherical, and toroidal systems: - 0 - Singularity at ±180°. + 0 + Singularity at ±180°. - 1 - Singularity at 0° (360°). + 1 + Singularity at 0° (360°). kphi Phi singularity location for toroidal systems: - 0 - Singularity in phi direction at ±180°. + 0 + Singularity in phi direction at ±180°. - 1 - Singularity in phi direction at 0° (360°). + 1 + Singularity in phi direction at 0° (360°). Notes ----- @@ -262,13 +274,17 @@ def cskp( kcs Coordinate system type: - 0 or CART - Cartesian + 0 or CART + Cartesian - 1 or CYLIN - Cylindrical (circular or elliptical) + 1 or CYLIN + Cylindrical (circular or elliptical) - 2 or SPHE - Spherical (or spheroidal) + 2 or SPHE + Spherical (or spheroidal) - 3 or TORO - Toroidal + 3 or TORO + Toroidal porig Keypoint defining the origin of this coordinate system. If PORIG = @@ -349,13 +365,17 @@ def cswpla(self, kcn="", kcs="", par1="", par2="", **kwargs): kcs Coordinate system type: - 0 or CART - Cartesian + 0 or CART + Cartesian - 1 or CYLIN - Cylindrical (circular or elliptical) + 1 or CYLIN + Cylindrical (circular or elliptical) - 2 or SPHE - Spherical (or spheroidal) + 2 or SPHE + Spherical (or spheroidal) - 3 or TORO - Toroidal + 3 or TORO + Toroidal par1 Used for elliptical, spheroidal, or toroidal systems. If KCS = 1 @@ -397,17 +417,23 @@ def csys(self, kcn="", **kwargs): kcn Specifies the active coordinate system, as follows: - 0 (default) - Cartesian + 0 (default) + Cartesian - 1 - Cylindrical with global Cartesian Z as the axis of rotation + 1 + Cylindrical with global Cartesian Z as the axis of rotation - 2 - Spherical + 2 + Spherical - 4 or WP - Working Plane + 4 or WP + Working Plane - 5 - Cylindrical with global Cartesian Y as the axis of rotation + 5 + Cylindrical with global Cartesian Y as the axis of rotation - 11 or greater - Any previously defined local coordinate system + 11 or greater + Any previously defined local coordinate system Notes ----- @@ -487,13 +513,17 @@ def local( kcs Coordinate system type: - 0 or CART - Cartesian + 0 or CART + Cartesian - 1 or CYLIN - Cylindrical (circular or elliptical) + 1 or CYLIN + Cylindrical (circular or elliptical) - 2 or SPHE - Spherical (or spheroidal) + 2 or SPHE + Spherical (or spheroidal) - 3 or TORO - Toroidal + 3 or TORO + Toroidal xc, yc, zc Location (in the global Cartesian coordinate system) of the origin diff --git a/src/ansys/mapdl/core/_commands/database/picking.py b/src/ansys/mapdl/core/_commands/database/picking.py index 25fb6fd2a2..efc038ba18 100644 --- a/src/ansys/mapdl/core/_commands/database/picking.py +++ b/src/ansys/mapdl/core/_commands/database/picking.py @@ -98,32 +98,43 @@ def flst(self, nfield="", narg="", type_="", otype="", leng="", **kwargs): type\_ Type of items picked: - 1 - Node numbers + 1 + Node numbers - 2 - Element numbers + 2 + Element numbers - 3 - Keypoint numbers + 3 + Keypoint numbers - 4 - Line numbers + 4 + Line numbers - 5 - Area numbers + 5 + Area numbers - 6 - Volume numbers + 6 + Volume numbers - 7 - Trace points + 7 + Trace points - 8 - Coordinate locations (in Global Cartesian coordinates) + 8 + Coordinate locations (in Global Cartesian coordinates) - 9 - Screen picks (in X, Y screen coordinates (-1 to 1)) + 9 + Screen picks (in X, Y screen coordinates (-1 to 1)) otype Data order: - NOOR - Data is not ordered (default). + NOOR + Data is not ordered (default). - ORDER - Data is in an ordered list (such as for the E,P51X and A,P51X commands, in - which the order of the data items is significant for the - picking operation). + ORDER + Data is in an ordered list (such as for the E,P51X and A,P51X commands, in + which the order of the data items is significant for the picking + operation). leng Length of number of items describing the list (should equal NARG if diff --git a/src/ansys/mapdl/core/_commands/database/selecting.py b/src/ansys/mapdl/core/_commands/database/selecting.py index 878b309d89..36904be069 100644 --- a/src/ansys/mapdl/core/_commands/database/selecting.py +++ b/src/ansys/mapdl/core/_commands/database/selecting.py @@ -40,28 +40,37 @@ def allsel(self, labt="", entity="", **kwargs): labt Type of selection to be made: - ALL - Selects all items of the specified entity type and all - items of lower entity types (default). + ALL + Selects all items of the specified entity type and all + items of lower entity types (default). - BELOW - Selects all items directly associated with and below - the selected items of the specified entity type. + BELOW + Selects all items directly associated with and below + the selected items of the specified entity type. entity Entity type on which selection is based: - ALL - All entity types (default). + ALL + All entity types (default). - VOLU - Volumes. + VOLU + Volumes. - AREA - Areas. + AREA + Areas. - LINE - Lines. + LINE + Lines. - KP - Keypoints. + KP + Keypoints. - ELEM - Elements. + ELEM + Elements. - NODE - Nodes. + NODE + Nodes. Notes ----- @@ -102,20 +111,26 @@ def asll(self, type_="", arkey="", **kwargs): type\_ Label identifying the type of area select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. arkey Specifies whether all contained area lines must be selected [LSEL]: - 0 - Select area if any of its lines are in the selected line set. + 0 + Select area if any of its lines are in the selected line set. - 1 - Select area only if all of its lines are in the selected line set. + 1 + Select area only if all of its lines are in the selected line set. Notes ----- @@ -155,42 +170,53 @@ def asel( type\_ Label identifying the type of select: - S - Select a new set (default) + S + Select a new set (default) - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Restore the full set. + ALL + Restore the full set. - NONE - Unselect the full set. + NONE + Unselect the full set. - INVE - Invert the current set (selected becomes unselected and vice versa). + INVE + Invert the current set (selected becomes unselected and vice versa). - STAT - Display the current select status. + STAT + Display the current select status. The following fields are used only with Type = S, R, A, or U: Item - Label identifying data. Valid item labels are shown in Table 105: ASEL - Valid Item and Component - Labels (p. 185). 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 AREA. + Label identifying data. Valid item labels are shown in Table 105: + ASEL - Valid Item and Component Labels (p. 185). 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 AREA. Comp - Component of the item (if required). Valid component labels are shown in Table 105: ASEL - Valid - Item and Component Labels (p. 185). + Component of the item (if required). Valid component labels are + shown in Table 105: ASEL - Valid Item and Component Labels (p. 185). VMIN - Minimum value of item range. Ranges are area numbers, coordinate values, attribute numbers, etc., - as appropriate for the item. A component name (as specified on the CM (p. 338) command) may - also be substituted for VMIN (VMAX and VINC are ignored). If Item = MAT, TYPE, REAL, or ESYS - and if VMIN is positive, the absolute value of Item is compared against the range for selection; if - VMIN is negative, the signed value of Item is compared. See the ALIST (p. 106) command for a - discussion of signed attributes. + Minimum value of item range. Ranges are area numbers, coordinate + values, attribute numbers, etc., as appropriate for the item. A + component name (as specified on the CM (p. 338) command) may also be + substituted for VMIN (VMAX and VINC are ignored). If Item = MAT, + TYPE, REAL, or ESYS and if VMIN is positive, the absolute value of + Item is compared against the range for selection; if VMIN is + negative, the signed value of Item is compared. See the ALIST (p. + 106) command for a discussion of signed attributes. VMAX Maximum value of item range. VMAX defaults to VMIN. @@ -202,8 +228,10 @@ def asel( KSWP Specifies whether only areas are to be selected: - - `kswp = 0` - Select areas only. - - `kswp = 1` - Select areas, as well as keypoints, lines, nodes, and elements associated with selected areas. + - `kswp = 0` + Select areas only. + - `kswp = 1` + Select areas, as well as keypoints, lines, nodes, and elements associated with selected areas. Valid only with Type = S. @@ -275,13 +303,17 @@ def aslv(self, type_="", **kwargs): type\_ Label identifying the type of area select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -309,15 +341,20 @@ def dofsel( type\_ Label identifying the type of select: - S - Select a new set of labels. + S + Select a new set of labels. - A - Add labels to the current set. + A + Add labels to the current set. - U - Unselect (remove) labels from the current set. + U + Unselect (remove) labels from the current set. - ALL - Restore the full set of labels. + ALL + Restore the full set of labels. - STAT - Display the current select status. + STAT + Display the current select status. dof1, dof2, dof3, . . . , dof6 Used only with Type = S, A, or U. Valid structural labels: UX, @@ -396,15 +433,23 @@ def esel( type\_ Label identifying the type of select: - - S - Select a new set (default). - - R - Reselect a set from the current set. - - A - Additionally select a set and extend the current set. - - U - Unselect a set from the current set. - - ALL - Restore the full set. - - NONE - Unselect the full set. - - INVE - Invert the current set (selected becomes - unselected and vice versa). - - STAT - Display the current select status. + S + Select a new set (default). + R + Reselect a set from the current set. + A + Additionally select a set and extend the current set. + U + Unselect a set from the current set. + ALL + Restore the full set. + NONE + Unselect the full set. + INVE + Invert the current set (selected becomes + unselected and vice versa). + STAT + Display the current select status. item Label identifying data, see Table 110: ESEL - Valid Item @@ -443,9 +488,12 @@ def esel( kabs Absolute value key: - - `kabs = 0` - Check sign of value during selection. - - `kabs = 1` - Use absolute value during selection (sign - ignored). + `kabs = 0` + Check sign of value during selection. + + `kabs = 1` + Use absolute value during selection (sign + ignored). Notes ----- @@ -532,13 +580,17 @@ def esla(self, type_: str = "", **kwargs) -> Optional[str]: type_ Label identifying the type of element select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -560,13 +612,17 @@ def esll(self, type_: str = "", **kwargs) -> Optional[str]: type_ Label identifying the type of element select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -590,41 +646,52 @@ def esln( type_ Label identifying the type of element selected: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. ekey Node set key: - 0 - Select element if any of its nodes are in the - selected nodal set (default). + 0 + Select element if any of its nodes are in the + selected nodal set (default). - 1 - Select element only if all of its nodes are in the - selected nodal set. + 1 + Select element only if all of its nodes are in the + selected nodal set. nodetype Label identifying type of nodes to consider when selecting: - ALL - Select elements considering all of their nodes ( - default). + ALL + Select elements considering all of their nodes ( + default). - ACTIVE - Select elements considering only their active - nodes. An active node is a node - that contributes DOFs to the model. + ACTIVE + Select elements considering only their active + nodes. An active node is a node + that contributes DOFs to the model. - INACTIVE - Select elements considering only their - inactive nodes (such as orientation or - radiation nodes). + INACTIVE + Select elements considering only their + inactive nodes (such as orientation or + radiation nodes). - CORNER - Select elements considering only their corner - nodes. + CORNER + Select elements considering only their corner + nodes. - MID - Select elements considering only their midside nodes. + MID + Select elements considering only their midside nodes. Notes ----- @@ -647,13 +714,17 @@ def eslv(self, type_: str = "", **kwargs) -> Optional[str]: type_ Label identifying the type of element selected: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -750,8 +821,11 @@ def ksel( KABS Absolute value key: - - `kabs = 0` - Check sign of value during selection. - - `kabs = 1` - Use absolute value during selection (sign ignored). + `kabs = 0` + Check sign of value during selection. + + `kabs = 1` + Use absolute value during selection (sign ignored). Notes ----- @@ -811,13 +885,17 @@ def ksll(self, type_="", **kwargs): type\_ Label identifying the type of keypoint select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -836,13 +914,17 @@ def ksln(self, type_="", **kwargs): type\_ Label identifying the type of keypoint select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -886,21 +968,29 @@ def lsel( type\_ Label identifying the type of select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Restore the full set. + ALL + Restore the full set. - NONE - Unselect the full set. + NONE + Unselect the full set. - INVE - Invert the current set (selected becomes unselected and vice versa). + INVE + Invert the current set (selected becomes unselected and vice versa). - STAT - Display the current select status. + STAT + Display the current select status. The following fields are used only with Type = S, R, A, or U: @@ -938,9 +1028,12 @@ def lsel( KSWP Specifies whether only lines are to be selected: - - ``kswp=0`` - Select lines only. ``kswp=1`` - Select lines, - - as well as keypoints, nodes, and elements associated with - - selected lines. Valid only with ``type="s"``. + ``kswp=0`` + Select lines only. + + ``kswp=1`` + Select lines, as well as keypoints, nodes, and elements associated with + selected lines. Valid only with ``type="s"``. Notes ----- @@ -998,13 +1091,17 @@ def lsla(self, type_="", **kwargs): type\_ Label identifying the type of line select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -1023,21 +1120,27 @@ def lslk(self, type_="", lskey="", **kwargs): type\_ Label identifying the type of line select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. lskey Specifies whether all contained line keypoints must be selected [KSEL]: - 0 - Select line if any of its keypoints are in the selected keypoint set. + 0 + Select line if any of its keypoints are in the selected keypoint set. - 1 - Select line only if all of its keypoints are in the selected keypoint set. + 1 + Select line only if all of its keypoints are in the selected keypoint set. Notes ----- @@ -1077,21 +1180,29 @@ def nsel( type\_ Label identifying the type of select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Restore the full set. + ALL + Restore the full set. - NONE - Unselect the full set. + NONE + Unselect the full set. - INVE - Invert the current set (selected becomes unselected and vice versa). + INVE + Invert the current set (selected becomes unselected and vice versa). - STAT - Display the current select status. + STAT + Display the current select status. The following fields are used only with Type = S, R, A, or U: @@ -1238,20 +1349,26 @@ def nsla(self, type_="", nkey="", **kwargs): type\_ Label identifying the type of node select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. nkey Specifies whether only interior area nodes are to be selected: - 0 - Select only nodes interior to selected areas. + 0 + Select only nodes interior to selected areas. - 1 - Select all nodes (interior to area, interior to lines, and at keypoints) + 1 + Select all nodes (interior to area, interior to lines, and at keypoints) associated with the selected areas. Notes @@ -1285,31 +1402,42 @@ def nsle(self, type_="", nodetype="", num="", **kwargs): type\_ Label identifying the type of node select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. nodetype Label identifying type of nodes to consider when selecting: - ALL - Select all nodes of the selected elements (default). + ALL + Select all nodes of the selected elements (default). - ACTIVE - Select only the active nodes. An active node is a node that contributes DOFs to + ACTIVE + Select only the active nodes. An active node is a node that contributes DOFs to the model. - INACTIVE - Select only inactive nodes (such as orientation or radiation). + INACTIVE + Select only inactive nodes (such as orientation or radiation). - CORNER - Select only corner nodes. + CORNER + Select only corner nodes. - MID - Select only midside nodes. + MID + Select only midside nodes. - POS - Select nodes in position Num. + POS + Select nodes in position Num. - FACE - Select nodes on face Num. + FACE + Select nodes on face Num. num Position or face number for NodeType = POS or FACE. @@ -1348,13 +1476,17 @@ def nslk(self, type_="", **kwargs): type\_ Label identifying the type of node select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. Notes ----- @@ -1377,20 +1509,26 @@ def nsll(self, type_="", nkey="", **kwargs): type\_ Label identifying the type of node select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. nkey Specifies whether only interior line nodes are to be selected: - 0 - Select only nodes interior to selected lines. + 0 + Select only nodes interior to selected lines. - 1 - Select all nodes (interior to line and at keypoints) + 1 + Select all nodes (interior to line and at keypoints) associated with the selected lines. Notes @@ -1414,13 +1552,17 @@ def nslv(self, type_="", nkey="", **kwargs): type\_ Label identifying the type of node select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. nkey Specifies whether only interior volume nodes are to be selected: @@ -1451,19 +1593,26 @@ def partsel(self, type_="", pmin="", pmax="", pinc="", **kwargs): Label identifying type of select. Because PARTSEL is a command macro, the label must be enclosed in single quotes. - 'S' - Select a new set (default). + 'S' + Select a new set (default). - 'R' - Reselect a set from the current set. + 'R' + Reselect a set from the current set. - 'A' - Additionally select a set and extend the current set. + 'A' + Additionally select a set and extend the current set. - 'U' - Unselect a set from the current set. + 'U' + Unselect a set from the current set. - 'ALL' - Select all parts. + 'ALL' + Select all parts. - 'NONE' - Unselect all parts. + 'NONE' + Unselect all parts. - 'INVE' - Invert the current selected set. + 'INVE' + Invert the current selected set. Notes ----- @@ -1539,21 +1688,29 @@ def vsel( type\_ Label identifying the type of volume select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Restore the full set. + ALL + Restore the full set. - NONE - Unselect the full set. + NONE + Unselect the full set. - INVE - Invert the current set (selected becomes unselected and vice versa). + INVE + Invert the current set (selected becomes unselected and vice versa). - STAT - Display the current select status. + STAT + Display the current select status. item : str, optional Label identifying data. Valid item labels are shown in the table @@ -1583,10 +1740,12 @@ def vsel( kswp : int, optional Specifies whether only volumes are to be selected: - - ``kswp=0`` - Select volumes only. - - ``kswp=1`` - Select volumes, as well as keypoints, lines, areas, - nodes, and elements associated with selected volumes. Valid only - with Type = S. + ``kswp=0`` + Select volumes only. + ``kswp=1`` + Select volumes, as well as keypoints, lines, areas, + nodes, and elements associated with selected volumes. Valid only + with Type = S. Notes ----- @@ -1636,21 +1795,27 @@ def vsla(self, type_="", vlkey="", **kwargs): type\_ Label identifying the type of volume select: - S - Select a new set (default). + S + Select a new set (default). - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. vlkey Specifies whether all contained volume areas must be selected [ASEL]: - 0 - Select volume if any of its areas are in the selected area set. + 0 + Select volume if any of its areas are in the selected area set. - 1 - Select volume only if all of its areas are in the selected area set. + 1 + Select volume only if all of its areas are in the selected area set. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/database/setup.py b/src/ansys/mapdl/core/_commands/database/setup.py index 7f8b5064b3..3d47be41e8 100644 --- a/src/ansys/mapdl/core/_commands/database/setup.py +++ b/src/ansys/mapdl/core/_commands/database/setup.py @@ -47,11 +47,13 @@ def resume(self, fname="", ext="", nopar="", knoplot="", **kwargs): nopar Parameter resume key: - 0 - All data in the database, including the scalar + 0 + All data in the database, including the scalar parameters, are replaced with the data saved on File.DB (default). - 1 - All data in the database, except the scalar + 1 + All data in the database, except the scalar parameters, are replaced with the data saved on File.DB. @@ -299,21 +301,29 @@ def units( label Label to denote the system of units used in this job: - USER - User-defined system (default). + USER + User-defined system (default). - SI - International system (m, kg, s, K). + SI + International system (m, kg, s, K). - MKS - MKS system (m, kg, s, °C). + MKS + MKS system (m, kg, s, °C). - uMKS - μMKS system (μm, kg, s, °C). + uMKS + μMKS system (μm, kg, s, °C). - CGS - CGS system (cm, g, s, °C). + CGS + CGS system (cm, g, s, °C). - MPA - MPA system (mm, Mg, s, °C). + MPA + MPA system (mm, Mg, s, °C). - BFT - U. S. Customary system using feet (ft, slug, s, °F). + BFT + U. S. Customary system using feet (ft, slug, s, °F). - BIN - U. S. Customary system using inches (in, lbf*s2/in, s, °F). + BIN + U. S. Customary system using inches (in, lbf*s2/in, s, °F). Notes ----- diff --git a/src/ansys/mapdl/core/_commands/database/working_plane.py b/src/ansys/mapdl/core/_commands/database/working_plane.py index 9676822881..345e5844fb 100644 --- a/src/ansys/mapdl/core/_commands/database/working_plane.py +++ b/src/ansys/mapdl/core/_commands/database/working_plane.py @@ -443,30 +443,38 @@ def wpstyl( wpctyp Working plane coordinate system type: - 0 - Cartesian (default). If working plane tracking is on [CSYS,4], the updated + 0 + Cartesian (default). If working plane tracking is on [CSYS,4], the updated active coordinate system will also be Cartesian. - 1 - Polar. If working plane tracking is on, the updated active coordinate system + 1 + Polar. If working plane tracking is on, the updated active coordinate system will be cylindrical. - 2 - Polar. If working plane tracking is on, the updated active coordinate system + 2 + Polar. If working plane tracking is on, the updated active coordinate system will be spherical. grtype Grid type: - 0 - Grid and WP triad. + 0 + Grid and WP triad. - 1 - Grid only. + 1 + Grid only. - 2 - WP triad only (default). + 2 + WP triad only (default). wpvis Grid visibility: - 0 - Do not show GRTYPE entities (grid and/or triad) (default). + 0 + Do not show GRTYPE entities (grid and/or triad) (default). - 1 - Show GRTYPE entities. Cartesian working planes will be displayed with a + 1 + Show GRTYPE entities. Cartesian working planes will be displayed with a Cartesian grid, polar with a polar grid. snapang diff --git a/src/ansys/mapdl/core/_commands/display_/setup.py b/src/ansys/mapdl/core/_commands/display_/setup.py index b3aa5aab99..3c48c32f37 100644 --- a/src/ansys/mapdl/core/_commands/display_/setup.py +++ b/src/ansys/mapdl/core/_commands/display_/setup.py @@ -42,13 +42,16 @@ def cmap(self, fname="", ext="", kywrd="", ncntr="", **kwargs): kywrd Keyword indicating the disposition of the color map file. - (blank) - Loads existing color map file. + (blank) + Loads existing color map file. - CREATE - Starts the CMAP utility and modifies or creates - the specified file. + CREATE + Starts the CMAP utility and modifies or creates + the specified file. - SAVE - Writes the active color map to the specified file, - which can be imported into future sessions. + SAVE + Writes the active color map to the specified file, + which can be imported into future sessions. ncntr Number of contours to be defined. Default = 9 (even if an existing @@ -87,33 +90,39 @@ def devdisp(self, label="", key="", **kwargs): label Device function label: - BBOX - Disables display information sorting for PowerGraphics displays. When activated - (KEY = 1 or ON), model rotations and replots are performed - without recalculating edge and surface data. This will speed - up the rotation (especially for 2-D displays) of large - models, although the display information will not be - resolved as quickly (you will see a bounding box instead of - the model during dynamic rotations). The default is OFF (KEY - = 0). - - DITHER - Dithering. When turned on (default), dithering smooths transitions in color - intensity. Applies only to Z-buffered displays. - - FONT - Font selection for the ANSYS graphics window. When Label = FONT, the command - format is: /DEVDISP,FONT,KEY,Val1,Val2,Val3,VAL4,Val5,Val6, - where KEY determines the type of font being controlled, and - values 1 through 6 control various font parameters. Note - that these values are device specific; using the same - command input file [/INPUT] on different machines may yield - different results.The following KEY values determine the - font information that will be supplied to the appropriate - driver (e.g., Postscript, X11, Win32, JPEG, ...): - - KEY = 1 - The command controls the LEGEND (documentation column) font. - - KEY = 2 - The command controls the ENTITY (node and keypoint number) font. - - KEY = 3 - The command controls the ANNOTATION/GRAPH font. + BBOX + Disables display information sorting for PowerGraphics displays. When activated + (KEY = 1 or ON), model rotations and replots are performed + without recalculating edge and surface data. This will speed + up the rotation (especially for 2-D displays) of large + models, although the display information will not be + resolved as quickly (you will see a bounding box instead of + the model during dynamic rotations). The default is OFF (KEY + = 0). + + DITHER + Dithering. When turned on (default), dithering smooths transitions in color + intensity. Applies only to Z-buffered displays. + + FONT + Font selection for the ANSYS graphics window. When Label = FONT, the command + format is: /DEVDISP,FONT,KEY,Val1,Val2,Val3,VAL4,Val5,Val6, + where KEY determines the type of font being controlled, and + values 1 through 6 control various font parameters. Note + that these values are device specific; using the same + command input file [/INPUT] on different machines may yield + different results.The following KEY values determine the + font information that will be supplied to the appropriate + driver (e.g., Postscript, X11, Win32, JPEG, ...): + + KEY = 1 + The command controls the LEGEND (documentation column) font. + + KEY = 2 + The command controls the ENTITY (node and keypoint number) font. + + KEY = 3 + The command controls the ANNOTATION/GRAPH font. Linux: Values 1 through 4 are used to find a match in the X11 database of font strings. Values 1, 2, and 3 are character strings; value 4 is a nonzero integer: - Val1 @@ -201,11 +210,14 @@ def nocolor(self, key="", **kwargs): key Color key: - 0 - Color the displays. + 0 + Color the displays. - 1 - Do not color the displays. + 1 + Do not color the displays. - 2 - Do not shade the displays. + 2 + Do not shade the displays. """ command = f"NOCOLOR,{key}" return self.run(command, **kwargs) @@ -221,19 +233,25 @@ def showdisp(self, dname="", ncpl="", **kwargs): Valid driver name (see Getting Started with Graphics in the Basic Analysis Guide for details): - - Any linked terminal driver (such as X11, TEKTRONIX, etc.) + + Any linked terminal driver (such as X11, TEKTRONIX, etc.) - HPGL - Hewlett-Packard Graphics Language + HPGL + Hewlett-Packard Graphics Language - HPGL2 - Hewlett-Packard Graphics Language with enhanced - color. (See the HPGL command for options.) - Ignores the NCPL field. + HPGL2 + Hewlett-Packard Graphics Language with enhanced + color. (See the HPGL command for options.) + Ignores the NCPL field. - INTERLEAF - Interleaf ASCII Format, OPS Version 5.0 + INTERLEAF + Interleaf ASCII Format, OPS Version 5.0 - POSTSCRIPT - PostScript, Version 1.0 Minimally Conforming + POSTSCRIPT + PostScript, Version 1.0 Minimally Conforming - DUMP - ASCII Text Dump + DUMP + ASCII Text Dump ncpl Number of color planes (4 to 8). Default is device-dependent. diff --git a/src/ansys/mapdl/core/_commands/graphics_/annotation.py b/src/ansys/mapdl/core/_commands/graphics_/annotation.py index 8f2bf3052e..c3bd64a5e9 100644 --- a/src/ansys/mapdl/core/_commands/graphics_/annotation.py +++ b/src/ansys/mapdl/core/_commands/graphics_/annotation.py @@ -86,36 +86,48 @@ def annot(self, lab="", val1="", val2="", **kwargs): lab Annotation control key: - OFF - Turns off annotation for each subsequent display (default). + OFF + Turns off annotation for each subsequent display (default). - ON - Turns on annotation for each subsequent display. + ON + Turns on annotation for each subsequent display. - DELE - Deletes all annotation. + DELE + Deletes all annotation. - SAVE - Saves annotation on a file. Use VAL1 for file name (defaults to Jobname) and - VAL2 for the extension (defaults to ANO). + SAVE + Saves annotation on a file. Use VAL1 for file name (defaults to Jobname) and + VAL2 for the extension (defaults to ANO). - SCALE - Sets annotation scale factor (direct input only). Use VAL1 for value (0.1 to - 10.0) (defaults to 1.0). + SCALE + Sets annotation scale factor (direct input only). Use VAL1 for value (0.1 to + 10.0) (defaults to 1.0). - XORIG - Sets the annotation x origin (direct input only). Use VAL1 for value (-3.0 to - 3.0). + XORIG + Sets the annotation x origin (direct input only). Use VAL1 for value (-3.0 to + 3.0). - YORIG - Sets annotation y origin (direct input only). Use VAL1 for value (-3.0 to - 3.0). + YORIG + Sets annotation y origin (direct input only). Use VAL1 for value (-3.0 to + 3.0). - SNAP - Sets annotation snap (menu button input only). Use VAL1 for value (0.002 to - 0.2) (defaults to 0.002). + SNAP + Sets annotation snap (menu button input only). Use VAL1 for value (0.002 to + 0.2) (defaults to 0.002). - STAT - Displays current annotation status. + STAT + Displays current annotation status. - DEFA - Sets annotation specifications to the default values. + DEFA + Sets annotation specifications to the default values. - REFR - Redisplays annotation graphics. + REFR + Redisplays annotation graphics. - TMOD - Sets the annotation text mode. If VAL1 = 1, annotation text will be drawn in - scalable bitmap fonts (default). If VAL1 = 0, annotation - text will be drawn with stroke text. + TMOD + Sets the annotation text mode. If VAL1 = 1, annotation text will be drawn in + scalable bitmap fonts (default). If VAL1 = 0, annotation + text will be drawn with stroke text. val1 Value (or file name) as noted with label above. @@ -163,29 +175,41 @@ def anum(self, num="", type_="", xhot="", yhot="", **kwargs): Annotation internal type number. If TYPE = DELE, delete annotation NUM. - 1 - Text + 1 + Text - 2 - Block text (not available in GUI) + 2 + Block text (not available in GUI) - 3 - Dimensions + 3 + Dimensions - 4 - Lines + 4 + Lines - 5 - Rectangles + 5 + Rectangles - 6 - Circles + 6 + Circles - 7 - Polygons + 7 + Polygons - 8 - Arcs + 8 + Arcs - 9 - Wedges, pies + 9 + Wedges, pies - 11 - Symbols + 11 + Symbols - 12 - Arrows + 12 + Arrows - 13 - Bitmap + 13 + Bitmap xhot X hot spot (-1.0 < X < 2.0). Used for menu button item delete. @@ -290,44 +314,62 @@ def lspec(self, lcolor="", linstl="", xlnwid="", **kwargs): lcolor Line color: - 0 - Black + 0 + Black - 1 - Red-Magenta + 1 + Red-Magenta - 2 - Magenta + 2 + Magenta - 3 - Blue-Magenta + 3 + Blue-Magenta - 4 - Blue + 4 + Blue - 5 - Cyan-Blue + 5 + Cyan-Blue - 6 - Cyan + 6 + Cyan - 7 - Green-Cyan + 7 + Green-Cyan - 8 - Green + 8 + Green - 9 - Yellow-Green + 9 + Yellow-Green - 10 - Yellow + 10 + Yellow - 11 - Orange + 11 + Orange - 12 - Red + 12 + Red - 13 - Dark Gray + 13 + Dark Gray - 14 - Light Gray + 14 + Light Gray - 15 - White + 15 + White linstl Line style: - 0 - Solid line. + 0 + Solid line. - 1 - Dashed line. + 1 + Dashed line. xlnwid Line width multiplier (1.0 to 20.0). Defaults to 1.0. @@ -366,15 +408,20 @@ def lsymbol(self, x="", y="", symang="", symtyp="", symsiz="", keybmp="", **kwar symtyp Symbol type: - 1 - Arrow. + 1 + Arrow. - 2 - Tee. + 2 + Tee. - 3 - Circle. + 3 + Circle. - 4 - Triangle. + 4 + Triangle. - 5 - Star. + 5 + Star. symsiz Symbol size multiplier (0.1 to 20.0). Defaults to 1.0. @@ -568,51 +615,71 @@ def pspec(self, pcolor="", kfill="", kbordr="", **kwargs): pcolor Polygon color (0 PCOLOR 15): - 0 - Black. + 0 + Black. - 1 - Red-Magenta. + 1 + Red-Magenta. - 2 - Magenta. + 2 + Magenta. - 3 - Blue-Magenta. + 3 + Blue-Magenta. - 4 - Blue. + 4 + Blue. - 5 - Cyan-Blue. + 5 + Cyan-Blue. - 6 - Cyan. + 6 + Cyan. - 7 - Green-Cyan. + 7 + Green-Cyan. - 8 - Green. + 8 + Green. - 9 - Yellow-Green. + 9 + Yellow-Green. - 10 - Yellow. + 10 + Yellow. - 11 - Orange. + 11 + Orange. - 12 - Red. + 12 + Red. - 13 - Dark Gray. + 13 + Dark Gray. - 14 - Light Gray. + 14 + Light Gray. - 15 - White. + 15 + White. kfill Polygon fill key: - 0 - Hollow polygon. + 0 + Hollow polygon. - 1 - Filled polygon. + 1 + Filled polygon. kbordr Polygon border key: - 0 - No border. + 0 + No border. - 1 - Border. + 1 + Border. Notes ----- @@ -716,37 +783,53 @@ def tspec(self, tcolor="", tsize="", txthic="", pangle="", iangle="", **kwargs): tcolor Text color (0 TCOLOR 15): - 0 - Black. + 0 + Black. - 1 - Red-Magenta. + 1 + Red-Magenta. - 2 - Magenta. + 2 + Magenta. - 3 - Blue-Magenta. + 3 + Blue-Magenta. - 4 - Blue. + 4 + Blue. - 5 - Cyan-Blue. + 5 + Cyan-Blue. - 6 - Cyan. + 6 + Cyan. - 7 - Green-Cyan. + 7 + Green-Cyan. - 8 - Green. + 8 + Green. - 9 - Yellow-Green. + 9 + Yellow-Green. - 10 - Yellow. + 10 + Yellow. - 11 - Orange. + 11 + Orange. - 12 - Red. + 12 + Red. - 13 - Dark Gray. + 13 + Dark Gray. - 14 - Light Gray. + 14 + Light Gray. - 15 - White. + 15 + White. tsize Text size factor. @@ -754,13 +837,17 @@ def tspec(self, tcolor="", tsize="", txthic="", pangle="", iangle="", **kwargs): txthic Text thickness key: - 1 - normal. + 1 + normal. - 2 - twice as thick. + 2 + twice as thick. - 3 - three times as thick. + 3 + three times as thick. - 4 - four times as thick. + 4 + four times as thick. pangle Text path angle (0.0 < angle < 360.0). diff --git a/src/ansys/mapdl/core/_commands/graphics_/graphs.py b/src/ansys/mapdl/core/_commands/graphics_/graphs.py index 98fe904503..777d33825f 100644 --- a/src/ansys/mapdl/core/_commands/graphics_/graphs.py +++ b/src/ansys/mapdl/core/_commands/graphics_/graphs.py @@ -32,9 +32,11 @@ def axlab(self, axis="", lab="", **kwargs): axis Axis specifier: - X - Apply label to X axis. + X + Apply label to X axis. - Y - Apply label to Y axis. + Y + Apply label to Y axis. lab Axis label (user defined text up to 30 characters long). Leave @@ -57,13 +59,17 @@ def grid(self, key="", **kwargs): key Grid key: - 0 (OFF) - No grid. + 0 (OFF) + No grid. - 1 (ON) - Full grid (X and Y grid lines). + 1 (ON) + Full grid (X and Y grid lines). - 2 (X) - Partial grid (X grid lines only). + 2 (X) + Partial grid (X grid lines only). - 3 (Y) - Partial grid (Y grid lines only) + 3 (Y) + Partial grid (Y grid lines only) Notes ----- @@ -88,97 +94,123 @@ def gropt(self, lab="", key="", **kwargs): lab Apply display style as selected from the following labels: - AXDV - Axis division (tick) marks (defaults to KEY = ON). - - AXNM - Axis scale numbers (defaults to KEY = ON, which puts numbers at the back plane - of the graph). If KEY = FRONT, numbers are on the front - plane of the graph. - - AXNSC - Axis number size scale factor. Input the scale value for KEY (defaults to - 1.0). - - ASCAL - Automatic scaling of additional Y-axes for multi-curve [/GRTYP, 2 or 3] graphs - (defaults to KEY = ON). If KEY = OFF, use base Y-axis - scaling (see the /YRANGE command). - - LOGX - Log X scale (defaults to KEY = OFF (linear)). - - LOGY - Log Y scale (applies only to the base Y axis) (defaults to KEY = OFF (linear)). - - FILL - Color fill areas under curves (defaults to KEY = OFF). - - CGRID - Superimpose background grid [/GRID] over areas under filled curves (defaults to - KEY = OFF). - - DIG1 - Number of significant digits before decimal point for axis values. Input the - value for KEY (defaults to 4). - - DIG2 - Number of significant digits after decimal point for axis values. Input the - value for KEY (defaults to 3). - - VIEW - View key for graph displays (defaults to KEY = OFF, in which case the view is - (0,0,1) for 2-D graph displays or (1,2,3) for 3-D graph - displays). If KEY = ON, the view settings for graph - displays are the same as the view settings for the model. - - REVX - Plots the values on the X-axis in reverse order. - - REVY - Plots the values on the Y-axis in reverse order. - - DIVX - Determines the number of divisions (grid markers) that will be plotted on the X - axis. - - DIVY - Determines the number of divisions (grid markers) that will be plotted on the Y - axis. - - LTYP - Determines whether ANSYS generated (KEY = 1) or system derived (KEY = 0) fonts - will be used for the axis labels. - - CURL - Determines the position of the curve labels. If (KEY = 1), the curve label will - be plotted in the legend column, and the label will be - displayed in the same color as the curve. If (KEY = 0) the - curve labels will be plotted near the curve. (default). - - XAXO - When you use this label, the subsequent KEY value will determine an offset - amount from the default (along the bottom) location for the - X axis. If KEY = 1.0, a full offset occurs (the X axis is - moved to the top of the graph). If KEY = 0.5, the axis is - offset to the midpoint of the graph, and if KEY = 0 the axis - remains in the original position, along the bottom of the - graph. For any offset, a grey copy of the original axis - (containing the axis numbering) remains at the original - location. - - YAXO - When you use this label, the subsequent KEY value will determine an offset - amount from the default (along the left side of the graph) - location for the Y axis. If KEY = 1.0, a full offset occurs - (the Y axis is moved to the right side of the graph). If KEY - = 0.5, the axis is offset to the midpoint of the graph, and - if KEY = 0 the axis remains in the original position, along - the left side of the graph. For any offset, a gray copy of - the original axis (containing the axis numbering) remains at - the original location. + AXDV + Axis division (tick) marks (defaults to KEY = ON). + + AXNM + Axis scale numbers (defaults to KEY = ON, which puts numbers at the back plane + of the graph). If KEY = FRONT, numbers are on the front + plane of the graph. + + AXNSC + Axis number size scale factor. Input the scale value for KEY (defaults to + 1.0). + + ASCAL + Automatic scaling of additional Y-axes for multi-curve [/GRTYP, 2 or 3] graphs + (defaults to KEY = ON). If KEY = OFF, use base Y-axis + scaling (see the /YRANGE command). + + LOGX + Log X scale (defaults to KEY = OFF (linear)). + + LOGY + Log Y scale (applies only to the base Y axis) (defaults to KEY = OFF (linear)). + + FILL + Color fill areas under curves (defaults to KEY = OFF). + + CGRID + Superimpose background grid [/GRID] over areas under filled curves (defaults to + KEY = OFF). + + DIG1 + Number of significant digits before decimal point for axis values. Input the + value for KEY (defaults to 4). + + DIG2 + Number of significant digits after decimal point for axis values. Input the + value for KEY (defaults to 3). + + VIEW + View key for graph displays (defaults to KEY = OFF, in which case the view is + (0,0,1) for 2-D graph displays or (1,2,3) for 3-D graph + displays). If KEY = ON, the view settings for graph + displays are the same as the view settings for the model. + + REVX + Plots the values on the X-axis in reverse order. + + REVY + Plots the values on the Y-axis in reverse order. + + DIVX + Determines the number of divisions (grid markers) that will be plotted on the X + axis. + + DIVY + Determines the number of divisions (grid markers) that will be plotted on the Y + axis. + + LTYP + Determines whether ANSYS generated (KEY = 1) or system derived (KEY = 0) fonts + will be used for the axis labels. + + CURL + Determines the position of the curve labels. If (KEY = 1), the curve label will + be plotted in the legend column, and the label will be + displayed in the same color as the curve. If (KEY = 0) the + curve labels will be plotted near the curve. (default). + + XAXO + When you use this label, the subsequent KEY value will determine an offset + amount from the default (along the bottom) location for the + X axis. If KEY = 1.0, a full offset occurs (the X axis is + moved to the top of the graph). If KEY = 0.5, the axis is + offset to the midpoint of the graph, and if KEY = 0 the axis + remains in the original position, along the bottom of the + graph. For any offset, a grey copy of the original axis + (containing the axis numbering) remains at the original + location. + + YAXO + When you use this label, the subsequent KEY value will determine an offset + amount from the default (along the left side of the graph) + location for the Y axis. If KEY = 1.0, a full offset occurs + (the Y axis is moved to the right side of the graph). If KEY + = 0.5, the axis is offset to the midpoint of the graph, and + if KEY = 0 the axis remains in the original position, along + the left side of the graph. For any offset, a gray copy of + the original axis (containing the axis numbering) remains at + the original location. key Option values: - OFF (0) - Do not apply selected style. + OFF (0) + Do not apply selected style. - ON (1) - Apply selected style. + ON (1) + Apply selected style. - nnnn - If Lab is DIG1 or DIG2, input the number of digits. + nnnn + If Lab is DIG1 or DIG2, input the number of digits. - nn - If Lab is AXNSC, input the scale factor. + nn + If Lab is AXNSC, input the scale factor. - FRONT - If Lab is AXNM, FRONT may also be input. + FRONT + If Lab is AXNM, FRONT may also be input. - Ndiv - If Lab is DIVX or DIVY, determines the number of divisions (1-99) that will be - applied to the axis. + Ndiv + If Lab is DIVX or DIVY, determines the number of divisions (1-99) that will be + applied to the axis. - Kfont - If Lab is LTYP, Kfont is ON (1) or OFF(0). ON will use ANSYS generated fonts - for the axis labels, while OFF will use SYSTEM (Windows, - X-system, etc.) fonts. The default value is ON (ANSYS - fonts). + Kfont + If Lab is LTYP, Kfont is ON (1) or OFF(0). ON will use ANSYS generated fonts + for the axis labels, while OFF will use SYSTEM (Windows, + X-system, etc.) fonts. The default value is ON (ANSYS + fonts). Notes ----- @@ -208,12 +240,15 @@ def grtyp(self, kaxis="", **kwargs): kaxis Axis selection key: - 0 or 1 - Single Y-axis. Up to 10 curves scaled to a single Y-axis. + 0 or 1 + Single Y-axis. Up to 10 curves scaled to a single Y-axis. - 2 - Additional Y-axes (one for each curve) (3 curves maximum). Allows better + 2 + Additional Y-axes (one for each curve) (3 curves maximum). Allows better scaling of curves with widely differing numbering ranges. - 3 - Same as 2 but with additional Y-axis and curves projected out of the plane (6 + 3 + Same as 2 but with additional Y-axis and curves projected out of the plane (6 curves maximum). Allows clearer display with an isometric view. The default view when KAXIS = 3 is View,1,1,2,3. @@ -242,24 +277,32 @@ def gthk(self, label="", thick="", **kwargs): label Apply thicknesses as selected from the following labels: - AXIS - Modify thickness of ordinate and abscissa axes on graph displays. + AXIS + Modify thickness of ordinate and abscissa axes on graph displays. - GRID - Modify thickness of grid lines on graph displays. + GRID + Modify thickness of grid lines on graph displays. - CURVE - Modify thickness of curve lines (when no area fill [/GROPT]). + CURVE + Modify thickness of curve lines (when no area fill [/GROPT]). thick Thickness ratio (whole numbers only, from -1 to 10): - -1 - Do not draw the curve, but show only the markers specified by /GMARKER. + -1 + Do not draw the curve, but show only the markers specified by /GMARKER. - 0 or 1 - Thin lines. + 0 or 1 + Thin lines. - 2 - The default thickness. + 2 + The default thickness. - 3 - 1.5 times the default thickness. + 3 + 1.5 times the default thickness. - etc. - (up to 10) + etc. + (up to 10) Notes ----- diff --git a/src/ansys/mapdl/core/_commands/graphics_/labeling.py b/src/ansys/mapdl/core/_commands/graphics_/labeling.py index a691ab08ca..e3223c7114 100644 --- a/src/ansys/mapdl/core/_commands/graphics_/labeling.py +++ b/src/ansys/mapdl/core/_commands/graphics_/labeling.py @@ -81,11 +81,14 @@ def clabel(self, wn="", key="", **kwargs): key Labeling key: - 0 or 1 - Label contours with legend or color (default). + 0 or 1 + Label contours with legend or color (default). - -1 - No contour labeling. + -1 + No contour labeling. - N - Same as 1 except show alphabetic legend only on every Nth element. + N + Same as 1 except show alphabetic legend only on every Nth element. Notes ----- @@ -219,11 +222,14 @@ def gformat(self, ftype="", nwidth="", dsignf="", **kwargs): FORTRAN format types (G is the default if this field is left blank.) - G - Gxx.yy. xx and yy are described below. + G + Gxx.yy. xx and yy are described below. - F - Fxx.yy + F + Fxx.yy - E - Exx.yy + E + Exx.yy nwidth Total width (12 maximum) of the field (the xx in Ftype). Defaults @@ -333,76 +339,109 @@ def pbc(self, item="", key="", min_="", max_="", abs_="", **kwargs): item Label identifying the item: - U - Applied translational constraints (UX, UY, UZ). + U + Applied translational constraints (UX, UY, UZ). - ROT - Applied rotational constraints (ROTX, ROTY, ROTZ). + ROT + Applied rotational constraints (ROTX, ROTY, ROTZ). - TEMP - Applied temperatures (TEMP, TBOT, TE2, TE3, . . ., TTOP). + TEMP + Applied temperatures (TEMP, TBOT, TE2, TE3, . . ., TTOP). - PRES - Applied fluid pressures. + PRES + Applied fluid pressures. - V - Applied flow velocities (VX, VY, VZ). + V + Applied flow velocities (VX, VY, VZ). - VOLT - Applied voltages. + VOLT + Applied voltages. - MAG - Applied scalar magnetic potentials. + MAG + Applied scalar magnetic potentials. - A - Applied vector magnetic potentials. + A + Applied vector magnetic potentials. - CONC - Concentration. + CONC + Concentration. - CHRG - Applied electric charge. + CHRG + Applied electric charge. - F or FORC - Applied structural forces (FX, FY, FZ). + F or FORC + Applied structural forces (FX, FY, FZ). - M or MOME - Applied structural moments (MX, MY, MZ). + M or MOME + Applied structural moments (MX, MY, MZ). - HEAT - Applied heat flows (HEAT, HBOT, HE2, HE3, . . ., HTOP). + HEAT + Applied heat flows (HEAT, HBOT, HE2, HE3, . . ., HTOP). - FLOW - Applied fluid flow. + FLOW + Applied fluid flow. - AMPS - Applied current flow. + AMPS + Applied current flow. - FLUX - Applied magnetic flux. + FLUX + Applied magnetic flux. - CSG - Applied magnetic current segments. + CSG + Applied magnetic current segments. - RATE - Diffusion flow rate. + RATE + Diffusion flow rate. - MAST - Master degrees of freedom. + MAST + Master degrees of freedom. - CP - Coupled nodes. + CP + Coupled nodes. - CE - Nodes in constraint equations. + CE + Nodes in constraint equations. - NFOR - POST1 nodal forces. + NFOR + POST1 nodal forces. - NMOM - POST1 nodal moments + NMOM + POST1 nodal moments - RFOR - POST1 reaction forces. + RFOR + POST1 reaction forces. - RMOM - POST1 reaction moments (MX, MY, MZ). + RMOM + POST1 reaction moments (MX, MY, MZ). - PATH - Path geometry (undistorted) associated with the PATH command after a PDEF or - PVECT command has been issued. + PATH + Path geometry (undistorted) associated with the PATH command after a PDEF or + PVECT command has been issued. - ACEL - Global acceleration (ACELX, ACELY, ACELZ vector). + ACEL + Global acceleration (ACELX, ACELY, ACELZ vector). - OMEG - Global angular velocity (OMEGX, OMEGY, OMEGZ vector) and acceleration (DOMEGX, - DOMEGY, DOMEGZ vector). + OMEG + Global angular velocity (OMEGX, OMEGY, OMEGZ vector) and acceleration (DOMEGX, + DOMEGY, DOMEGZ vector). - WELD - Applied spotwelds (ANSYS LS-DYNA). + WELD + Applied spotwelds (ANSYS LS-DYNA). - ALL - Represents all appropriate labels. + ALL + Represents all appropriate labels. key Symbol key: - 0 - Do not show symbol. + 0 + Do not show symbol. - 1 - Show symbol. + 1 + Show symbol. - 2 - Plot value next to symbol. + 2 + Plot value next to symbol. min\_ Minimum value in a range of values plotted on screen. @@ -481,36 +520,50 @@ def pbf(self, item="", key="", **kwargs): item Label identifying the item: - TEMP - Applied temperatures. + TEMP + Applied temperatures. - FLUE - Applied fluences. + FLUE + Applied fluences. - HGEN - Applied heat generation rates. + HGEN + Applied heat generation rates. - JS - Applied current density magnitude. + JS + Applied current density magnitude. - JSX - X-component of current density. + JSX + X-component of current density. - JSY - Y-component of current density. + JSY + Y-component of current density. - JSZ - Z-component of current density. + JSZ + Z-component of current density. - PHASE - Phase angle of applied load. + PHASE + Phase angle of applied load. - MVDI - Applied magnetic virtual displacements flag. + MVDI + Applied magnetic virtual displacements flag. - CHRGD - Applied electric charge density. + CHRGD + Applied electric charge density. - VLTG - Applied voltage drop. + VLTG + Applied voltage drop. key Symbol key: - 0 - Do not show body force load contours. + 0 + Do not show body force load contours. - 1 - Show body force load contours. + 1 + Show body force load contours. - 2 - Show current density as a vector (not a contour). + 2 + Show current density as a vector (not a contour). Notes ----- @@ -557,63 +610,79 @@ def plopts(self, label="", key="", **kwargs): label Apply display items as selected from the following labels: - INFO - Controls the display of the legend (ON or OFF) and allows the choice of preset - or Multi-legend placement. Control is provided by the KEY - values. (Defaults to KEY=3 when the GUI is on. Defaults to - KEY= 2 otherwise.) - - LEG1 - Header portion of legend column (defaults to ON). - - LEG2 - View portion of legend column (defaults to ON (except off with contour - displays)). - - LEG3 - View the contour section of the legend column (defaults to ON). - - FRAME - Frame border lines around windows (defaults to ON). - - TITLE - Title (bottom left text) (defaults to ON). - - MINM - Min-Max symbols on contour displays (defaults to ON). - - LOGO - ANSYS logo (defaults to OFF (displayed as text at top of legend column)). If - KEY = ON, the text is removed from legend column but the - logo symbol is displayed in whichever active window is - either in the uppermost right corner and on top, or if there - is no window in that location, then in the window to the - furthest right of the screen. Version information remains - in the legend column. - - WINS - Controls whether graphics windows automatically stretch or shrink to adjust to - screen size as the legend column is turned off or on - [/PLOPTS,INFO] (defaults to ON). If WINS is on and the - legend column is changed from off to on, all windows are - shrunk regardless of what their correct size is. - - WP - Working plane (defaults to OFF). The working plane is drawn as part of the - display (not just an overlaid image as in WPSTYL). This - option is best used in combination with a hidden-line - technique [/TYPE]. - - DATE - Controls the display of the date and time in your legend. Subsequent KEY values - control the display as follows: - - FILE - Controls the display of the ANSYS jobname in your legend. Subsequent KEY values - control the display as follows: + INFO + Controls the display of the legend (ON or OFF) and allows the choice of preset + or Multi-legend placement. Control is provided by the KEY + values. (Defaults to KEY=3 when the GUI is on. Defaults to + KEY= 2 otherwise.) + + LEG1 + Header portion of legend column (defaults to ON). + + LEG2 + View portion of legend column (defaults to ON (except off with contour + displays)). + + LEG3 + View the contour section of the legend column (defaults to ON). + + FRAME + Frame border lines around windows (defaults to ON). + + TITLE + Title (bottom left text) (defaults to ON). + + MINM + Min-Max symbols on contour displays (defaults to ON). + + LOGO + ANSYS logo (defaults to OFF (displayed as text at top of legend column)). If + KEY = ON, the text is removed from legend column but the + logo symbol is displayed in whichever active window is + either in the uppermost right corner and on top, or if there + is no window in that location, then in the window to the + furthest right of the screen. Version information remains + in the legend column. + + WINS + Controls whether graphics windows automatically stretch or shrink to adjust to + screen size as the legend column is turned off or on + [/PLOPTS,INFO] (defaults to ON). If WINS is on and the + legend column is changed from off to on, all windows are + shrunk regardless of what their correct size is. + + WP + Working plane (defaults to OFF). The working plane is drawn as part of the + display (not just an overlaid image as in WPSTYL). This + option is best used in combination with a hidden-line + technique [/TYPE]. + + DATE + Controls the display of the date and time in your legend. Subsequent KEY values + control the display as follows: + + FILE + Controls the display of the ANSYS jobname in your legend. Subsequent KEY values + control the display as follows: key Switch: - OFF or 0 - Do not apply this display item. For Label = DATE, no time or date are - displayed. + OFF or 0 + Do not apply this display item. For Label = DATE, no time or date are + displayed. - ON or 1 - Apply this display item. For Label = DATE, show only the date. + ON or 1 + Apply this display item. For Label = DATE, show only the date. - AUTO or 2 - For Label = INFO, initiate Auto-legend mode. If the display has contours, the - legend is ON; if the display has no contours, the - legend is OFF. For Label = DATE, display both the date - and time. + AUTO or 2 + For Label = INFO, initiate Auto-legend mode. If the display has contours, the + legend is ON; if the display has no contours, the + legend is OFF. For Label = DATE, display both the date + and time. - 3 - For Label = INFO , switch to Multi-legend mode. See the /UDOC command for the + 3 + For Label = INFO , switch to Multi-legend mode. See the /UDOC command for the available legend configurations. Notes @@ -647,52 +716,79 @@ def pnum(self, label="", key="", **kwargs): label Type of numbering/coloring: - NODE - Node numbers on node and element plots. + NODE + Node numbers on node and element plots. - ELEM - Element numbers and colors on element plots. + ELEM + Element numbers and colors on element plots. - SEC - Section numbers and colors on element and solid model plots (see "Notes"). + SEC + Section numbers and colors on element and solid model plots (see "Notes"). - MAT - Material set numbers and colors on element and solid model plots (see - "Notes"). + MAT + Material set numbers and colors on element and solid model plots (see + "Notes"). - TYPE - Element type reference numbers and colors on element and solid model plots (see - "Notes"). + TYPE + Element type reference numbers and colors on element and solid model plots (see + "Notes"). - REAL - Real constant set numbers and colors on element and solid model plots (see - "Notes"). + REAL + Real constant set numbers and colors on element and solid model plots (see + "Notes"). - ESYS - Element coordinate system numbers on element and solid model plots (see - "Notes"). + ESYS + Element coordinate system numbers on element and solid model plots (see + "Notes"). - PART - Element part numbers and colors on element plots (applicable to ANSYS LS-DYNA - only). + PART + Element part numbers and colors on element plots (applicable to ANSYS LS-DYNA + only). - LOC - Location numbers/colors of the element in matrix assembly order on element - plots. + LOC + Location numbers/colors of the element in matrix assembly order on element + plots. - Note:LOC and ELEM numbers will be the same unless the model has been reordered. - KP + .. note:: ``LOC`` and ``ELEM`` numbers will be the same unless the model has been reordered. - Keypoint numbers on solid model plots. - LINE + KP + Keypoint numbers on solid model plots. - Line numbers on solid model plots (both numbers and colors on line plots). - AREA + LINE + Line numbers on solid model plots (both numbers and colors on line plots). - Area numbers on solid model plots (both numbers and colors on area plots). - VOLU + AREA + Area numbers on solid model plots (both numbers and colors on area plots). - Volume numbers on solid model plots (both numbers and colors on volume plots). - SVAL + VOLU + Volume numbers on solid model plots (both numbers and colors on volume plots). - Stress (or any contour) values on postprocessing plots, and surface load values and colors on model plots (when surface load symbols are on [/PSF]). For tabular boundary conditions, the table-evaluated values will be displayed on node, element, or contour displays in POST1 when load symbols (/PBF, /PSF, /PBC) are on and TABNAM is OFF. - TABNAM + SVAL + Stress (or any contour) values on postprocessing plots, and + surface load values and colors on model plots (when surface load + symbols are on [/PSF]). For tabular boundary conditions, the + table-evaluated values will be displayed on node, element, or + contour displays in POST1 when load symbols (/PBF, /PSF, /PBC) + are on and TABNAM is OFF. - Table names for tabular boundary conditions. If this label is turned on, the table name appears next to the appropriate symbol, arrow, face outline, or contour as dictated by the /PSF, /PBC, and /PBF commands. - STAT + TABNAM + Table names for tabular boundary conditions. If this label is + turned on, the table name appears next to the appropriate + symbol, arrow, face outline, or contour as dictated by the /PSF, + /PBC, and /PBF commands. - Shows current settings for /PNUM. - DEFA + STAT + Shows current settings for /PNUM. - key + DEFA + key Switch: - 0 - Turns OFF numbers/colors for specified label. + 0 + Turns OFF numbers/colors for specified label. - 1 - Turns ON numbers/colors for specified label. + 1 + Turns ON numbers/colors for specified label. Notes ----- @@ -731,35 +827,43 @@ def psf(self, item="", comp="", key="", kshell="", color="", **kwargs): ---------- item, comp Labels identifying the surface load to be shown; see - Table 227: /PSF - Valid Item and Component Labels. + Table 227: /PSF Valid Item and Component Labels. key Key to turn surface load symbols on or off: - 0 - Off (default). + 0 + Off (default). - 1 - On, shown as face outlines. Line surface loads (SFL) on solid model plots are + 1 + On, shown as face outlines. Line surface loads (SFL) on solid model plots are shown as arrows. - 2 - On, shown as arrows. + 2 + On, shown as arrows. - 3 - On, shown as color filled surfaces. Line and area surface loads (SFL and SFA) + 3 + On, shown as color filled surfaces. Line and area surface loads (SFL and SFA) on solid model plots are shown as arrows. kshell Visibility key for shell elements. - 0 - Off (default), surface load symbols are displayed only on visible load faces. + 0 + Off (default), surface load symbols are displayed only on visible load faces. - 1 - On, surface load symbols are displayed even if load face is not visible. + 1 + On, surface load symbols are displayed even if load face is not visible. color Visibility key for contour legend. - ON - The symbols (arrows or face outlines) will show up in color with the legend + ON + The symbols (arrows or face outlines) will show up in color with the legend showing the corresponding color labels (default). - OFF - The contour legend will not be displayed. The symbols (arrows or face outlines) + OFF + The contour legend will not be displayed. The symbols (arrows or face outlines) will show up in grey. The size of the arrows will be proportional to the applied load. @@ -811,7 +915,8 @@ def psf(self, item="", comp="", key="", kshell="", color="", **kwargs): This command is valid in any processor. - Table: 227:: : /PSF - Valid Item and Component Labels + Table: 227:: : /PSF + Valid Item and Component Labels Pressure loads apply to the element coordinate system (KEYOPT(2) = 0). Adjust appropriately for a local coordinate system (KEYOPT(2) = 1). See @@ -840,76 +945,93 @@ def psymb(self, label="", key="", **kwargs): label Show symbols as selected from the following labels: - CS - Local coordinate systems. + CS + Local coordinate systems. - NDIR - Nodal coordinate systems (on rotated nodes only). + NDIR + Nodal coordinate systems (on rotated nodes only). - ESYS - Element coordinate systems (element displays only). + ESYS + Element coordinate systems (element displays only). - LDIR - Line directions (line displays only). + LDIR + Line directions (line displays only). - LDIV - Controls the display of element divisions on lines. + LDIV + Controls the display of element divisions on lines. - ADIR - Area direction symbol (for keypoint, line, area and volume plots). + ADIR + Area direction symbol (for keypoint, line, area and volume plots). - LAYR - Layer orientations (relative to the projected element x-axis) or fiber - orientations in smeared reinforcing elements. Used only - within an element display. Use KEY to specify the layer - number. + LAYR + Layer orientations (relative to the projected element x-axis) or fiber + orientations in smeared reinforcing elements. Used only + within an element display. Use KEY to specify the layer + number. - ECON - Element mesh symbols on keypoints and lines. + ECON + Element mesh symbols on keypoints and lines. - DOT - Larger symbols displayed for node and keypoint locations. When Label = DOT, - KEY = 1 by default. + DOT + Larger symbols displayed for node and keypoint locations. When Label = DOT, + KEY = 1 by default. - XNOD - Extra node of surface or circuit elements. + XNOD + Extra node of surface or circuit elements. - FBCS - Force boundary condition scaling. Subsequent KEY value determines whether or - not to scale the applied and derived forces/moments to the - same maximum value. + FBCS + Force boundary condition scaling. Subsequent KEY value determines whether or + not to scale the applied and derived forces/moments to the + same maximum value. - DEFA - Resets the symbol keys so that ANSYS displays none of the symbols controlled by - the /PSYMB command. The value of the KEY field is ignored. + DEFA + Resets the symbol keys so that ANSYS displays none of the symbols controlled by + the /PSYMB command. The value of the KEY field is ignored. - STAT - Prints the status of the settings of the symbol - keys controlled by the /PSYMB command. The KEY - field is ignored. + STAT + Prints the status of the settings of the symbol + keys controlled by the /PSYMB command. The KEY + field is ignored. key Symbol key: - ``-1`` - Effective only if Label = LAYR and solid shape - element display (/ESHAPE) is active. Orientation of - all layers appears with the solid shape element - display. - - 0 - No symbol (default). If Label = LDIV, then KEY= 0 - indicates that the displayed element divisions will - correspond to the existing mesh (the word MESHED or - EXISTING can also be substituted). Also, for Label = - LDIV, if you execute any meshing command (such as - AMESH or VMESH), KEY is set to 0 (MESHED) - automatically. If Label = FBCS, then KEY= 0 indicates - that boundary condition scaling will not be - common. The applied and derived forces/moments will - be scaled to their respective maximum values. - - 1 - Include symbol. If Label = LDIV, then KEY = 1 - indicates that the displayed line divisions will - correspond to the value assigned by LESIZE (the word - LESIZE can also be substituted). Also, for Label = - LDIV, if you execute the LESIZE command, KEY is set - to 1 (LESIZE) automatically. If Label = FBCS, then - KEY= 1 indicates that boundary condition scaling will - be common. The applied and derived forces/moments - will be scaled to the same maximum value. - - N - If Label = LAYR, then N is equal to the layer - number. If Label = DOT, then N can be equal to - 0,1,.....15, indicating the dot size. If Label = - LDIV, then KEY = -1, indicates that no element - divisions will be displayed (the word OFF can also be - substituted). + ``-1`` + Effective only if Label = LAYR and solid shape + element display (/ESHAPE) is active. Orientation of + all layers appears with the solid shape element + display. + + 0 + No symbol (default). If Label = LDIV, then KEY= 0 + indicates that the displayed element divisions will + correspond to the existing mesh (the word MESHED or + EXISTING can also be substituted). Also, for Label = + LDIV, if you execute any meshing command (such as + AMESH or VMESH), KEY is set to 0 (MESHED) + automatically. If Label = FBCS, then KEY= 0 indicates + that boundary condition scaling will not be + common. The applied and derived forces/moments will + be scaled to their respective maximum values. + + 1 + Include symbol. If Label = LDIV, then KEY = 1 + indicates that the displayed line divisions will + correspond to the value assigned by LESIZE (the word + LESIZE can also be substituted). Also, for Label = + LDIV, if you execute the LESIZE command, KEY is set + to 1 (LESIZE) automatically. If Label = FBCS, then + KEY= 1 indicates that boundary condition scaling will + be common. The applied and derived forces/moments + will be scaled to the same maximum value. + + N + If Label = LAYR, then N is equal to the layer + number. If Label = DOT, then N can be equal to + 0,1,.....15, indicating the dot size. If Label = + LDIV, then KEY = -1, indicates that no element + divisions will be displayed (the word OFF can also be + substituted). Notes ----- @@ -955,17 +1077,23 @@ def triad(self, lab="", **kwargs): lab Display triad as follows: - ORIG - Display triad at global origin (default). + ORIG + Display triad at global origin (default). - OFF - Turn off triad display. + OFF + Turn off triad display. - LBOT - Display triad in lower left screen corner. + LBOT + Display triad in lower left screen corner. - RBOT - Display triad in lower right screen corner. + RBOT + Display triad in lower right screen corner. - LTOP - Display triad in upper left screen corner. + LTOP + Display triad in upper left screen corner. - RTOP - Display triad in upper right screen corner. + RTOP + Display triad in upper right screen corner. Notes ----- @@ -997,57 +1125,70 @@ def udoc(self, wind="", cl_ass="", key="", **kwargs): class The type (and relative importance) of legend item being displayed: - CNTR - Contour legend. This legend item is controlled separately from the other legend - items (see note below). - - DATE - The items in the DATE class include the date and time, or the ANSYS graphical - logo (/PLOPTS,LOGO,1). This item is shown by default in all - plots. - - GWIN - The items in the GWIN class include the entity acronyms that appear in the - legend of a multiplot of entities (Nodes, Elements, - Keypoints, Lines, Areas, Volumes). GWIN items are shown by - default for all GPLOT displays. - - TYPE - Items in the TYPE class include the plot type (e.g. ELEMENTS, MATERIALS, NODAL - SOLUTIONS, etc.). TYPE items are shown by default in all - plots. - - TYP2 - Items in the TYP2 class include supplementary type information, such as DMAX - and SMAX for nodal solutions. TYP2 items are shown by - default in all plots. - - INUM - Items in the INUM class include the number labels generated by the /PNUM - command. This class is displayed by default in all plots - that contain /PNUM information. - - BCDC - The items in the BCDC class include labels created by the /PBC command. This - class is shown by default in all plots which contain /PBC - information. - - VECT - Items in the VECT class include labels created by the PLVECT command. This - class is shown by default for all PLVECT plots. - - SURF - The items in the SURF class include labels from the /PSF legend. This class is - shown by default on all plots of surface boundary - conditions. - - BODY - Items from the BODY class include labels from the /PBF legend. This class is - shown by default in all plots of body forces. - - PSTA - Items from the PSTA class include stress scaling statistics, such as the - /SSCALE setting. This class is not shown as the default for - any type of plot, and must be specifically referenced to - display the included data. - - VIEW - The items in the VIEW class include view statistics. This class is not shown as - the default for any type of plot, and must be specifically - referenced to display the included data. - - MISC - The items in the MISC class include supplementary labels like /EXPANDED and - Stress Section Cross Section. This class is not shown as the - default for any type of plot, and must be specifically - referenced to display the included data. + CNTR + Contour legend. This legend item is controlled separately from the other legend + items (see note below). + + DATE + The items in the DATE class include the date and time, or the ANSYS graphical + logo (/PLOPTS,LOGO,1). This item is shown by default in all + plots. + + GWIN + The items in the GWIN class include the entity acronyms that appear in the + legend of a multiplot of entities (Nodes, Elements, + Keypoints, Lines, Areas, Volumes). GWIN items are shown by + default for all GPLOT displays. + + TYPE + Items in the TYPE class include the plot type (e.g. ELEMENTS, MATERIALS, NODAL + SOLUTIONS, etc.). TYPE items are shown by default in all + plots. + + TYP2 + Items in the TYP2 class include supplementary type information, such as DMAX + and SMAX for nodal solutions. TYP2 items are shown by + default in all plots. + + INUM + Items in the INUM class include the number labels generated by the /PNUM + command. This class is displayed by default in all plots + that contain /PNUM information. + + BCDC + The items in the BCDC class include labels created by the /PBC command. This + class is shown by default in all plots which contain /PBC + information. + + VECT + Items in the VECT class include labels created by the PLVECT command. This + class is shown by default for all PLVECT plots. + + SURF + The items in the SURF class include labels from the /PSF legend. This class is + shown by default on all plots of surface boundary + conditions. + + BODY + Items from the BODY class include labels from the /PBF legend. This class is + shown by default in all plots of body forces. + + PSTA + Items from the PSTA class include stress scaling statistics, such as the + /SSCALE setting. This class is not shown as the default for + any type of plot, and must be specifically referenced to + display the included data. + + VIEW + The items in the VIEW class include view statistics. This class is not shown as + the default for any type of plot, and must be specifically + referenced to display the included data. + + MISC + The items in the MISC class include supplementary labels like /EXPANDED and + Stress Section Cross Section. This class is not shown as the + default for any type of plot, and must be specifically + referenced to display the included data. key Switch: diff --git a/src/ansys/mapdl/core/_commands/graphics_/scaling.py b/src/ansys/mapdl/core/_commands/graphics_/scaling.py index 86ef0f1d28..3759120d55 100644 --- a/src/ansys/mapdl/core/_commands/graphics_/scaling.py +++ b/src/ansys/mapdl/core/_commands/graphics_/scaling.py @@ -228,112 +228,155 @@ def txtre(self, lab="", num="", n1="", n2="", ninc="", **kwargs): lab You can apply texture according to the following labels: - ELEM - Apply texture to elements N1 through N2 in steps of NINC. - - AREA - Apply texture to areas N1 through N2 in steps of NINC. - - VOLU - Apply texture to volumes N1 through N2 in steps of NINC. - - CM - Apply texture to the component named in N1. N2 and - NINC are ignored. - - ON, OFF - Sets the specified texture display on or - off. All other fields are ignored. - - File - If Lab = File, the command format is /TXTRE, File, - Key_Index, Fname, Fext, --, Format (This variant of - the command is applicable to 2-D drivers). - - Key_Index - The texture index associated with the file. If - the number fifty-one (51) is used, the - imported bitmap will be used as the window's - logo. - - Fname - File name and directory path (248 characters - maximum, including the characters needed for the - directory path). An unspecified directory path - defaults to the working directory; in this case, - you can use all 248 characters for the file name. - - Fext - Filename extension (eight-character maximum). - - Format - The file format. If Format = 0, the file is a - pixmap (Linux) or Bitmap (PC). The file cannot - contain a compressed image, and the PC file must - be 8 or 24 bit BI_RGB format. If Format = 1 or - JPEG, then the file is in JPEG (Joint - Photographic Experts Group) format. If Format = 2 - or PNG, then the file is in PNG (Portable Network - Graphics) format. + ELEM + Apply texture to elements N1 through N2 in steps of NINC. + + AREA + Apply texture to areas N1 through N2 in steps of NINC. + + VOLU + Apply texture to volumes N1 through N2 in steps of NINC. + + CM + Apply texture to the component named in N1. N2 and + NINC are ignored. + + ON, OFF + Sets the specified texture display on or + off. All other fields are ignored. + + File + If Lab = File, the command format is /TXTRE, File, + Key_Index, Fname, Fext, --, Format (This variant of + the command is applicable to 2-D drivers). + + Key_Index + The texture index associated with the file. If + the number fifty-one (51) is used, the + imported bitmap will be used as the window's + logo. + + Fname + File name and directory path (248 characters + maximum, including the characters needed for the + directory path). An unspecified directory path + defaults to the working directory; in this case, + you can use all 248 characters for the file name. + + Fext + Filename extension (eight-character maximum). + + Format + The file format. If Format = 0, the file is a + pixmap (Linux) or Bitmap (PC). The file cannot + contain a compressed image, and the PC file must + be 8 or 24 bit BI_RGB format. If Format = 1 or + JPEG, then the file is in JPEG (Joint + Photographic Experts Group) format. If Format = 2 + or PNG, then the file is in PNG (Portable Network + Graphics) format. num Select the texture index number from the following list: - 0 - No Texturing + 0 + No Texturing - 1 - Aluminum + 1 + Aluminum - 2 - Aluminum, Brushed + 2 + Aluminum, Brushed - 3 - Steel With Bumps + 3 + Steel With Bumps - 4 - Steel, Embossed + 4 + Steel, Embossed - 5 - Iron + 5 + Iron - 6 - Steel, Pattern + 6 + Steel, Pattern - 7 - Steel, Riveted + 7 + Steel, Riveted - 8 - Steel, Scratched + 8 + Steel, Scratched - 9 - Tin + 9 + Tin - 10 - Metal + 10 + Metal - 11 - Steel, Etched + 11 + Steel, Etched - 12 - Metal, Hot + 12 + Metal, Hot - 13 - Iron, Grainy + 13 + Iron, Grainy - 14 - Metal, Rusty + 14 + Metal, Rusty - 15 - Brick + 15 + Brick - 16 - Block + 16 + Block - 17 - Wood + 17 + Wood - 18 - Wood, Light + 18 + Wood, Light - 19 - Wood, Walnut + 19 + Wood, Walnut - 20 - Plastic, Hard Blue + 20 + Plastic, Hard Blue - 21 - Plastic, Light Blue + 21 + Plastic, Light Blue - 22 - Plastic, Hard Red + 22 + Plastic, Hard Red - 31 - Gold + 31 + Gold - 32 - Brass + 32 + Brass - 33 - Silver + 33 + Silver - 34 - Plastic, Black + 34 + Plastic, Black - 35 - Plastic, Ivory + 35 + Plastic, Ivory - 36 - Plastic, Blue + 36 + Plastic, Blue - 37 - Plastic, Red + 37 + Plastic, Red - 38 - Plastic, Yellow + 38 + Plastic, Yellow - 39 - Plastic, Green + 39 + Plastic, Green - 40 - Plastic, Brown + 40 + Plastic, Brown n1, n2, ninc Apply texture to Lab items numbered N1 through N2 in steps of NINC @@ -385,9 +428,11 @@ def vscale(self, wn="", vratio="", key="", **kwargs): key Relative scaling key: - 0 - Use relative length scaling among vectors based on magnitudes. + 0 + Use relative length scaling among vectors based on magnitudes. - 1 - Use uniform length scaling for all vector lengths. + 1 + Use uniform length scaling for all vector lengths. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/hidden.py b/src/ansys/mapdl/core/_commands/hidden.py index 71382dd191..dbbcd8c3d7 100644 --- a/src/ansys/mapdl/core/_commands/hidden.py +++ b/src/ansys/mapdl/core/_commands/hidden.py @@ -37,9 +37,11 @@ def _batch(self, lab="", **kwargs): lab Specifies listing mode during a batch run: - LIST - The batch output will include a listing of the input file. + LIST + The batch output will include a listing of the input file. - (blank) - Suppress input data listing. + (blank) + Suppress input data listing. Notes ----- @@ -86,9 +88,11 @@ def _output(self, fname="", ext="", loc="", **kwargs): loc Location within a file to which output will be written: - (blank) - Output is written starting at the top of the file (default). + (blank) + Output is written starting at the top of the file (default). - APPEND - Output is appended to the existing file. + APPEND + Output is appended to the existing file. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/map_cmd.py b/src/ansys/mapdl/core/_commands/map_cmd.py index 9352fd218a..6fda23c27b 100644 --- a/src/ansys/mapdl/core/_commands/map_cmd.py +++ b/src/ansys/mapdl/core/_commands/map_cmd.py @@ -34,20 +34,26 @@ def ftype(self, filetype="", prestype="", **kwargs): Type of file from which the pressure data will be retrieved (no default): - CFXTBR - File from a CFX Transient Blade Row (TBR) analysis export. + CFXTBR + File from a CFX Transient Blade Row (TBR) analysis export. - CFDPOST - File from a CFD-Post BC Profile export. + CFDPOST + File from a CFD-Post BC Profile export. - FORMATTED - Formatted file. + FORMATTED + Formatted file. - CSV - Comma-Separated Values file. + CSV + Comma-Separated Values file. prestype Type of pressure data contained in the file: - 0 - Only real-valued pressures are on the file. + 0 + Only real-valued pressures are on the file. - 1 - Real-valued and imaginary-valued pressures are on the file (default). + 1 + Real-valued and imaginary-valued pressures are on the file (default). Notes ----- @@ -117,11 +123,14 @@ def plgeom(self, item="", nodekey="", **kwargs): item Items to plot: - BOTH - Plot both target and source geometries (default). + BOTH + Plot both target and source geometries (default). - TARGET - Plot only the target geometry. + TARGET + Plot only the target geometry. - SOURCE - Plot only the source geometry. + SOURCE + Plot only the source geometry. nodekey If the source data contains faces (that is, surface elements were @@ -148,11 +157,14 @@ def plmap(self, item="", nodekey="", imagkey="", **kwargs): item Items to plot: - BOTH - Plot both target and source pressures (default). + BOTH + Plot both target and source pressures (default). - TARGET - Plot only the target pressures. + TARGET + Plot only the target pressures. - SOURCE - Plot only the source pressures. + SOURCE + Plot only the source pressures. nodekey If the source data contains faces (that is, surface @@ -161,9 +173,11 @@ def plmap(self, item="", nodekey="", imagkey="", **kwargs): nodes and the elements. imagkey - 1 - Plot the real pressures (default). + 1 + Plot the real pressures (default). - 0 - Plot the imaginary pressures. + 0 + Plot the imaginary pressures. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/post1_/load_case.py b/src/ansys/mapdl/core/_commands/post1_/load_case.py index b2217a1640..73bf4735e6 100644 --- a/src/ansys/mapdl/core/_commands/post1_/load_case.py +++ b/src/ansys/mapdl/core/_commands/post1_/load_case.py @@ -36,9 +36,11 @@ def lcabs(self, lcno="", kabs="", **kwargs): kabs Absolute value key: - 0 - Use algebraic values of load case LCNO in operations. + 0 + Use algebraic values of load case LCNO in operations. - 1 - Use absolute values of load case LCNO in operations. + 1 + Use absolute values of load case LCNO in operations. Notes ----- @@ -91,9 +93,11 @@ def lcdef(self, lcno="", lstep="", sbstep="", kimg="", **kwargs): kimg Used only with results from complex analyses: - 0 - Use real part of complex solution + 0 + Use real part of complex solution - 1 - Use imaginary part. + 1 + Use imaginary part. Notes ----- @@ -183,31 +187,42 @@ def lcoper(self, oper="", lcase1="", oper2="", lcase2="", **kwargs): oper Valid operations are: - ZERO - Zero results portion of database (LCASE1 ignored). + ZERO + Zero results portion of database (LCASE1 ignored). - SQUA - Square database values (LCASE1 ignored). + SQUA + Square database values (LCASE1 ignored). - SQRT - Square root of database (absolute) values (LCASE1 ignored). + SQRT + Square root of database (absolute) values (LCASE1 ignored). - LPRIN - Recalculate line element principal stresses (LCASE1 ignored). Stresses are as - shown for the NMISC items of the ETABLE command for the - specific line element type. + LPRIN + Recalculate line element principal stresses (LCASE1 ignored). Stresses are as + shown for the NMISC items of the ETABLE command for the + specific line element type. - ADD - Add LCASE1 to database values. + ADD + Add LCASE1 to database values. - SUB - Subtract LCASE1 from database values. + SUB + Subtract LCASE1 from database values. - SRSS - Square root of the sum of the squares of database and LCASE1. + SRSS + Square root of the sum of the squares of database and LCASE1. - MIN - Compare and save in database the algebraic minimum of database and LCASE1. + MIN + Compare and save in database the algebraic minimum of database and LCASE1. - MAX - Compare and save in database the algebraic maximum of database and LCASE1. + MAX + Compare and save in database the algebraic maximum of database and LCASE1. - ABMN - Compare and save in database the absolute minimum of database and LCASE1 (based - on magnitudes, then apply the corresponding sign). + ABMN + Compare and save in database the absolute minimum of database and LCASE1 (based + on magnitudes, then apply the corresponding sign). - ABMX - Compare and save in database the absolute maximum of database and LCASE1 (based - on magnitudes, then apply the corresponding sign). + ABMX + Compare and save in database the absolute maximum of database and LCASE1 (based + on magnitudes, then apply the corresponding sign). lcase1 First load case in the operation (if any). See LCNO of the LCDEF @@ -217,18 +232,20 @@ def lcoper(self, oper="", lcase1="", oper2="", lcase2="", **kwargs): oper2 Valid operations are: - MULT - Multiplication: ``LCASE1*LCASE2`` - - CPXMAX - This option does a phase angle sweep to calculate the maximum of derived - stresses and equivalent strain for a complex solution - where LCASE1 is the real part and LCASE2 is the imaginary - part. The Oper field is not applicable with this option. - Also, the LCABS and SUMTYPE commands have no effect on - this option. The value of S3 will be a minimum. This - option does not apply to derived displacement amplitude - (USUM). Load case writing (LCWRITE) is not supported. See - POST1 and POST26 – Complex Results Postprocessing in the - Mechanical APDL Theory Reference for more information. + MULT + Multiplication: ``LCASE1*LCASE2`` + + CPXMAX + This option does a phase angle sweep to calculate the maximum of derived + stresses and equivalent strain for a complex solution + where LCASE1 is the real part and LCASE2 is the imaginary + part. The Oper field is not applicable with this option. + Also, the LCABS and SUMTYPE commands have no effect on + this option. The value of S3 will be a minimum. This + option does not apply to derived displacement amplitude + (USUM). Load case writing (LCWRITE) is not supported. See + POST1 and POST26 – Complex Results Postprocessing in the + Mechanical APDL Theory Reference for more information. lcase2 Second load case. Used only with Oper2 operations. @@ -275,21 +292,29 @@ def lcsel(self, type_="", lcmin="", lcmax="", lcinc="", **kwargs): type\_ Label identifying the type of select: - S - Select a new set. + S + Select a new set. - R - Reselect a set from the current set. + R + Reselect a set from the current set. - A - Additionally select a set and extend the current set. + A + Additionally select a set and extend the current set. - U - Unselect a set from the current set. + U + Unselect a set from the current set. - ALL - Restore the full set. + ALL + Restore the full set. - NONE - Unselect the full set. + NONE + Unselect the full set. - INVE - Invert the current set (selected becomes unselected and vice versa). + INVE + Invert the current set (selected becomes unselected and vice versa). - STAT - Display the current select status. + STAT + Display the current select status. lcmin Minimum value of load case pointer range. @@ -324,9 +349,11 @@ def lcsum(self, lab="", **kwargs): lab Combination option - (blank) - Only combine summable items [default]. + (blank) + Only combine summable items [default]. - ALL - Combine all items including non summable items. + ALL + Combine all items including non summable items. Notes ----- diff --git a/src/ansys/mapdl/core/_commands/preproc/database.py b/src/ansys/mapdl/core/_commands/preproc/database.py index 08ae368cc2..c914f684c3 100644 --- a/src/ansys/mapdl/core/_commands/preproc/database.py +++ b/src/ansys/mapdl/core/_commands/preproc/database.py @@ -138,54 +138,63 @@ def cdwrite( option Selects which data to write: - ALL - Write all appropriate geometry, material property, - load, and component data (default). Two files will - be produced. Fname.Ext will contain all data items - mentioned in "Notes", except the solid model - data. Fnamei.Exti will contain the solid model - geometry and solid model loads data in the form of - IGES commands. This option is not valid when - CDOPT,ANF is active. - - COMB - Write all data mentioned, but to a single file, - Fname.Ext. Solid model geometry data will be - written in either IGES or ANF format as specified - in the CDOPT command, followed by the remainder of - the data in the form of ANSYS commands. More - information on these (IGES/ANF) file formats is - provided in "Notes". - - DB - Write all database information except the solid model - and solid model loads to Fname.Ext in the form of - ANSYS commands. This option is not valid when - CDOPT,ANF is active. - - SOLID - Write only the solid model geometry and solid - model load data. This output will be in IGES or - ANF format, as specified in the CDOPT - command. More information on these (IGES/ANF) file - formats is provided in "Notes". - - GEOM - Write only element and nodal geometry data. Neither - solid model geometry nor element attribute data - will be written. One file, Fname.Ext, will be - produced. Use CDREAD,DB to read in a file written - with this option. Element types [ET] compatible - with the connectivity of the elements on the file - must first be defined before reading the file in - with CDREAD,DB. - - CM - Write only node and element component and geometry - data to Fname.Ext. - - MAT - Write only material property data (both linear and - nonlinear) to Fname.Ext. - - LOAD - Write only loads for current load step to - Fname.Ext. - - SECT - Write only section data to Fname.Ext. Pretension - sections are not included. + ALL + Write all appropriate geometry, material property, + load, and component data (default). Two files will + be produced. ``Fname.Ext`` will contain all data items + mentioned in "Notes", except the solid model + data. ``Fnamei.Exti`` will contain the solid model + geometry and solid model loads data in the form of + ``IGES`` commands. This option is not valid when + ``CDOPT,ANF`` is active. + + COMB + Write all data mentioned, but to a single file, + ``Fname.Ext``. Solid model geometry data will be + written in either ``IGES`` or ``ANF`` format as specified + in the ``CDOPT`` command, followed by the remainder of + the data in the form of ANSYS commands. More + information on these (IGES/ANF) file formats is + provided in "Notes". + + DB + Write all database information except the solid model + and solid model loads to ``Fname.Ext`` in the form of + ANSYS commands. This option is not valid when + ``CDOPT,ANF`` is active. + + SOLID + Write only the solid model geometry and solid + model load data. This output will be in IGES or + ANF format, as specified in the ``CDOPT`` + command. More information on these (``IGES/ANF``) file + formats is provided in "Notes". + + GEOM + Write only element and nodal geometry data. Neither + solid model geometry nor element attribute data + will be written. One file, ``Fname.Ext``, will be + produced. Use ``CDREAD,DB`` to read in a file written + with this option. Element types [``ET``] compatible + with the connectivity of the elements on the file + must first be defined before reading the file in + with ``CDREAD,DB``. + + CM + Write only node and element component and geometry + data to ``Fname.Ext``. + + MAT + Write only material property data (both linear and + nonlinear) to ``Fname.Ext``. + + LOAD + Write only loads for current load step to + ``Fname.Ext``. + + SECT + Write only section data to ``Fname.Ext``. Pretension + sections are not included. fname File name and directory path (248 characters maximum, @@ -210,12 +219,14 @@ def cdwrite( fmat Format of the output file (defaults to BLOCKED). - BLOCKED - Blocked format. This format allows faster - reading of the output file. The time savings is - most significant when BLOCKED is used to read - .cdb files associated with very large models. + BLOCKED + Blocked format. This format allows faster + reading of the output file. The time savings is + most significant when BLOCKED is used to read + .cdb files associated with very large models. - UNBLOCKED - Unblocked format. + UNBLOCKED + Unblocked format. Returns ------- @@ -230,7 +241,7 @@ def cdwrite( writes out solid model loads for meshed models only. If the model is not meshed, the solid model loads cannot be saved. Component data include component definitions, but not - assembly definitions. Appropriate NUMOFF commands are included + assembly definitions. Appropriate ``NUMOFF`` commands are included at the beginning of the file; this is to avoid overlap of an existing database when the file is read in. @@ -241,16 +252,16 @@ def cdwrite( file unless you specifically change a default solution setting. - CDWRITE does not support the GSBDATA and GSGDATA commands, and + ``CDWRITE`` does not support the ``GSBDATA`` and ``GSGDATA`` commands, and these commands are not written to the file. The data may be reread (on a different machine, for example) - with the CDREAD command. Caution: When the file is read in, - the NUMOFF,MAT command may cause a mismatch between material + with the ``CDREAD`` command. Caution: When the file is read in, + the ``NUMOFF,MAT`` command may cause a mismatch between material definitions and material numbers referenced by certain loads - and element real constants. See NUMOFF for details. Also, be + and element real constants. See ``NUMOFF`` for details. Also, be aware that the files created by the CDWRITE command explicitly - set the active coordinate system to Cartesian (CSYS,0). + set the active coordinate system to Cartesian (``CSYS,0``). You should generally use the blocked format (Fmat = BLOCKED) when writing out model data with CDWRITE. This is a compressed @@ -259,27 +270,27 @@ def cdwrite( unblocked formats are described in Chapter 3 of the Guide to Interfacing with ANSYS. - If you use CDWRITE in any of the derived products (ANSYS Emag, + If you use ``CDWRITE`` in any of the derived products (ANSYS Emag, ANSYS Professional), then before reading the file, you must - edit the Jobname.cdb file to remove commands that are not + edit the ``Jobname.cdb`` file to remove commands that are not available in the respective component product. - The CDWRITE command writes PART information for any ANSYS - LS-DYNA input file to the Jobname.cdb file via the EDPREAD - command. (EDPREAD is not a documented command; it is written - only when the CDWRITE command is issued.) The PART information - can be automatically read in via the CDREAD command; however, - if more than one Jobname.cdb file is read, the PART list from - the last Jobname.cdb file overwrites the existing PART list of + The ``CDWRITE`` command writes PART information for any ANSYS + LS-DYNA input file to the ``Jobname.cdb`` file via the ``EDPREAD`` + command. (``EDPREAD`` is not a documented command; it is written + only when the ``CDWRITE`` command is issued.) The PART information + can be automatically read in via the ``CDREAD`` command; however, + if more than one ``Jobname.cdb`` file is read, the PART list from + the last ``Jobname.cdb`` file overwrites the existing PART list of the total model. This behavior affects all PART-related - commands contained in the Jobname.cdb file. You can join + commands contained in the ``Jobname.cdb`` file. You can join models, but not PART-related inputs, which you must modify using the newly-created PART numbers. In limited cases, an - update of the PART list (EDWRITE,PUPDATE) is possible; doing - so requires that no used combination of MAT/TYPE/REAL appears + update of the PART list (``EDWRITE,PUPDATE``) is possible; doing + so requires that no used combination of ``MAT/TYPE/REAL`` appears more than once in the list. - The CDWRITE command does not support (for beam meshing) any + The ``CDWRITE`` command does not support (for beam meshing) any line operation that relies on solid model associativity. For example, meshing the areas adjacent to the meshed line, plotting the line that contains the orientation nodes, or @@ -291,11 +302,11 @@ def cdwrite( IGES and ANF File Formats for Solid Model Geometry Information The format used for solid model geometry information is - determined by the current CDOPT command setting. The default - format is IGES. + determined by the current ``CDOPT`` command setting. The default + format is ``IGES``. - IGES option (default) to write solid model information (CDOPT, - IGS): + IGES option (default) to write solid model information (``CDOPT, + IGS``): Before writing solid model entities, select all corresponding lower level entities (ALLSEL,BELOW,ALL). @@ -346,11 +357,14 @@ def cdopt(self, option="", **kwargs): option IGES - IGES - Write solid model geometry information using IGES format (default). + IGES + Write solid model geometry information using IGES format (default). - ANF - Write solid model geometry information using ANSYS Neutral File format. + ANF + Write solid model geometry information using ANSYS Neutral File format. - STAT - Print out the current format setting. + STAT + Print out the current format setting. Notes ----- @@ -373,11 +387,14 @@ def cecheck(self, itemlab="", tolerance="", dof="", **kwargs): itemlab Item indicating what is to be checked: - CE - Check constraint equations only + CE + Check constraint equations only - CP - Check couplings only + CP + Check couplings only - ALL - Check both CE and CP + ALL + Check both CE and CP tolerance Allowed amount of out-of-balance for any constraint equation or @@ -414,21 +431,25 @@ def check(self, sele="", levl="", **kwargs): sele Specifies which elements are to be checked: - (blank) - Check all data. + (blank) + Check all data. - ESEL - Check only elements in the selected set and unselect any elements not producing - geometry check messages. The remaining elements (those - producing check messages) can then be displayed and - corrected. A null set results if no elements produce a - message. Issue ESEL,ALL to select all elements before - proceeding. + ESEL + Check only elements in the selected set and unselect any elements not producing + geometry check messages. The remaining elements (those + producing check messages) can then be displayed and + corrected. A null set results if no elements produce a + message. Issue ESEL,ALL to select all elements before + proceeding. levl Used only with Sele = ESEL: - WARN - Select elements producing warning and error messages. + WARN + Select elements producing warning and error messages. - ERR - Select only elements producing error messages (default). + ERR + Select only elements producing error messages (default). Notes ----- @@ -468,10 +489,12 @@ def igesout(self, fname="", ext="", att="", **kwargs): att Attribute key: - 0 - Do not write assigned numbers and attributes of the + 0 + Do not write assigned numbers and attributes of the solid model entities to the IGES file (default). - 1 - Write assigned numbers and attributes of solid model + 1 + Write assigned numbers and attributes of solid model entities (keypoints, lines, areas, volumes) to the IGES file. Attributes include MAT, TYPE, REAL, and ESYS specifications as well as associated solid model @@ -531,8 +554,9 @@ def mfimport(self, fnumb="", option="", fname="", ext="", **kwargs): option Selects data to read. - DB - Reads a CDB file. The CDB file name and extension are specified by Fname and - Ext. + DB + Reads a CDB file. The CDB file name and extension are specified by Fname and + Ext. fname File name and directory path (248 characters maximum, including the @@ -618,31 +642,44 @@ def numcmp(self, label="", **kwargs): label Items to be compressed: - NODE - Node numbers + NODE + Node numbers - ELEM - Element numbers + ELEM + Element numbers - KP - Keypoint numbers + KP + Keypoint numbers - LINE - Line numbers + LINE + Line numbers - AREA - Area numbers + AREA + Area numbers - VOLU - Volume numbers + VOLU + Volume numbers - MAT - Material numbers + MAT + Material numbers - TYPE - Element type numbers + TYPE + Element type numbers - REAL - Real constant numbers + REAL + Real constant numbers - CP - Coupled set numbers + CP + Coupled set numbers - SECN - Section numbers + SECN + Section numbers - CE - Constraint equation numbers + CE + Constraint equation numbers - ALL - All item numbers + ALL + All item numbers Notes ----- @@ -681,23 +718,32 @@ def nummrg(self, label="", toler="", gtoler="", action="", switch="", **kwargs): label Items to be merged: - NODE - Nodes + NODE + Nodes - ELEM - Elements + ELEM + Elements - KP - Keypoints (will also merge lines, areas, and volumes) + KP + Keypoints (will also merge lines, areas, and volumes) - MAT - Materials + MAT + Materials - TYPE - Element types + TYPE + Element types - REAL - Real constants + REAL + Real constants - CP - Coupled sets + CP + Coupled sets - CE - Constraint equations + CE + Constraint equations - ALL - All items + ALL + All items toler Range of coincidence. For Label = NODE and KP, defaults to 1.0E-4 @@ -717,10 +763,12 @@ def nummrg(self, label="", toler="", gtoler="", action="", switch="", **kwargs): action Specifies whether to merge or select coincident items. - SELE - Select coincident items but do not merge. Action = SELE is only valid for Label - = NODE. + SELE + Select coincident items but do not merge. Action = SELE is only valid for Label + = NODE. - (Blank) - Merge the coincident items (default). + (Blank) + Merge the coincident items (default). switch Specifies whether the lowest or highest numbered coincident item is @@ -728,10 +776,12 @@ def nummrg(self, label="", toler="", gtoler="", action="", switch="", **kwargs): to keypoints; i.e., for Label = KP, the lowest numbered keypoint is retained regardless of the Switch setting. - LOW - Retain the lowest numbered coincident item after the merging operation + LOW + Retain the lowest numbered coincident item after the merging operation (default). - HIGH - Retain the highest numbered coincident item after the merging operation. + HIGH + Retain the highest numbered coincident item after the merging operation. Notes ----- @@ -846,31 +896,44 @@ def numoff(self, label="", value="", **kwargs): label Apply offset number to one of the following sets of items: - NODE - Nodes + NODE + Nodes - ELEM - Elements + ELEM + Elements - KP - Keypoints + KP + Keypoints - LINE - Lines + LINE + Lines - AREA - Areas + AREA + Areas - VOLU - Volumes + VOLU + Volumes - MAT - Materials + MAT + Materials - TYPE - Element types + TYPE + Element types - REAL - Real constants + REAL + Real constants - CP - Coupled sets + CP + Coupled sets - SECN - Section numbers + SECN + Section numbers - CE - Constraint equations + CE + Constraint equations - CSYS - Coordinate systems + CSYS + Coordinate systems value Offset number value (cannot be negative). @@ -907,25 +970,32 @@ def numstr(self, label="", value="", **kwargs): label Apply starting number to one of the following sets of items: - NODE - Node numbers. Value defaults (and is continually reset) to 1 + maximum node - number in model. Cannot be reset lower. + NODE + Node numbers. Value defaults (and is continually reset) to 1 + maximum node + number in model. Cannot be reset lower. - ELEM - Element numbers. Value defaults (and is continually reset) to 1 + maximum - element number in model. Cannot be reset lower. + ELEM + Element numbers. Value defaults (and is continually reset) to 1 + maximum + element number in model. Cannot be reset lower. - KP - Keypoint numbers. Value defaults to 1. Only undefined numbers are used. - Existing keypoints are not overwritten. + KP + Keypoint numbers. Value defaults to 1. Only undefined numbers are used. + Existing keypoints are not overwritten. - LINE - Line numbers. Value defaults to 1. Only undefined numbers are used. Existing - lines are not overwritten. + LINE + Line numbers. Value defaults to 1. Only undefined numbers are used. Existing + lines are not overwritten. - AREA - Area numbers. Value defaults to 1. Only undefined numbers are used. Existing - areas are not overwritten. + AREA + Area numbers. Value defaults to 1. Only undefined numbers are used. Existing + areas are not overwritten. - VOLU - Volume numbers. Value defaults to 1. Only undefined numbers are used. - Existing volumes are not overwritten. + VOLU + Volume numbers. Value defaults to 1. Only undefined numbers are used. + Existing volumes are not overwritten. - DEFA - Default. Returns all starting numbers to their default values. + DEFA + Default. Returns all starting numbers to their default values. value Starting number value. From af04ae466198837dda9095b1c8ac511059e1681c Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Mon, 1 Apr 2024 13:09:44 +0200 Subject: [PATCH 2/2] Apply suggestions from code review --- src/ansys/mapdl/core/_commands/apdl/array_param.py | 8 ++++---- src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/ansys/mapdl/core/_commands/apdl/array_param.py b/src/ansys/mapdl/core/_commands/apdl/array_param.py index 09d47f87ac..7cde12b856 100644 --- a/src/ansys/mapdl/core/_commands/apdl/array_param.py +++ b/src/ansys/mapdl/core/_commands/apdl/array_param.py @@ -34,7 +34,7 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar FIT Calculate Fourier coefficients COEFF from MODE, ISYM, - THETA, and CURVE. + THETA, and CURVE. EVAL Evaluate the Fourier curve CURVE from @@ -187,10 +187,10 @@ def moper( Square matrix invert: Inverts the ``n`` x ``n`` matrix in ``Par1`` into ``ParR``. The matrix must be well conditioned. - ..warning:: + .. warning:: - Non-independent or ill-conditioned equations can - cause erroneous results. + Non-independent or ill-conditioned equations can + cause erroneous results. For large matrices, use the APDL Math operation ``*LSFACTOR`` for efficiency (see APDL diff --git a/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py b/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py index 82d5955672..2c0e7dce10 100644 --- a/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py +++ b/src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py @@ -88,18 +88,18 @@ def radopt( specified solver type: 0 - If the FULL solver is specified (THOPT,FULL), convergence + If the FULL solver is specified (``THOPT,FULL``), convergence criteria are monitored and iterations are performed until convergence occurs. If the QUASI solver is specified - (THOPT,QUASI), convergence criteria are ignored and one + (``THOPT,QUASI``), convergence criteria are ignored and one iteration is performed. This value is the default. 1, 2, 3, ...N - If the FULL solver is specified (THOPT,FULL), convergence + If the FULL solver is specified (``THOPT,FULL``), convergence criteria are monitored and iterations are performed until convergence occurs, or until the specified number of iterations has been completed, whichever comes first. If the QUASI solver - is specified (THOPT,QUASI), convergence criteria are ignored and + is specified (``THOPT,QUASI``), convergence criteria are ignored and the specified number of iterations are completed. Notes