Skip to content

Commit

Permalink
fixing other scaped chars
Browse files Browse the repository at this point in the history
  • Loading branch information
germa89 committed Apr 1, 2024
1 parent 9a9f374 commit 278ecde
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 35 deletions.
7 changes: 4 additions & 3 deletions src/ansys/mapdl/core/_commands/apdl/array_param.py
Original file line number Diff line number Diff line change
Expand Up @@ -1155,7 +1155,8 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
Second derivative:
.. math::
\dfrac{\mathrm{d}^2(\mathrm{Par1})}{\mathrm{d}(\mathrm{Par2})^2}
\\dfrac{\\mathrm{d}^2(\\mathrm{Par1})}{\\mathrm{d}(\\mathrm{Par2})^2}
See also ``DER1``.
Expand All @@ -1164,7 +1165,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
.. math::
\int Par1 \, d(Par2)
\\int Par1 \\, d(Par2)
where ``CON1`` is the integration constant.
The integral at a point is
Expand All @@ -1176,7 +1177,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
.. math::
\iint Par1 \, d(Par2)
\\iint Par1 \\, d(Par2)
where ``CON1`` is the integration constant of the first
integral and ``CON2`` is the integration constant
Expand Down
4 changes: 2 additions & 2 deletions src/ansys/mapdl/core/_commands/apdl/parameter_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def dim(
Name of parameter to be dimensioned. See ``*SET`` for name
restrictions.
type\_
type\\_
Array type:
Arrays are similar to standard FORTRAN arrays (indices are
Expand Down Expand Up @@ -261,7 +261,7 @@ def get(
Parameters
----------
par : str, optional
The name of the resulting parameter. See \*SET for name
The name of the resulting parameter. See \\*SET for name
restrictions.
entity
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/mapdl/core/_commands/database/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ def cmsel(
Parameters
----------
type\_
type_
Label identifying the type of select:
S - Select a new set (default).
Expand Down
8 changes: 4 additions & 4 deletions src/ansys/mapdl/core/_commands/inq_func.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ def elmiqr(self, ielem, key, pname="__tmpvar__", **kwargs):
* 1 - double precision
* 2 - real
* 3 - complex
* 4 - character\*8
* 4 - character\\*8
* 7 - index
* 19 - return virtual type of file.
Expand Down Expand Up @@ -233,7 +233,7 @@ def kpinqr(self, knmi, key, pname="__tmpvar__", **kwargs):
* 1 - double precision
* 2 - real
* 3 - complex
* 4 - character\*8
* 4 - character\\*8
* 7 - index
* 19 - return virtual type of file.
Expand Down Expand Up @@ -501,7 +501,7 @@ def vlinqr(self, vnmi, key, pname="__tmpvar__", **kwargs):
* -6, number of elements.
* -7, pointer to volume in foreign db
* -8, element shape.
* -9, (``section id``)\*10 + 2
* -9, (``section id``)\\*10 + 2
* -10, element coordinate system.
* -11, KZ2 - 2nd kpt for elem Z
* -12, color and transparency packed
Expand Down Expand Up @@ -750,7 +750,7 @@ def cpinqr(self, ncp, key, pname="__tmpvar__", **kwargs):
* 5 - return number of values stored for ncp
* 11 - return void percent (integer)
* 16 - return location of next record
* \-1 - return master node for this eqn (this is currently only used by solution DB object)
* -1 - return master node for this eqn (this is currently only used by solution DB object)
pname : str
Name of the variable where the queried value is stored.
Expand Down
4 changes: 2 additions & 2 deletions src/ansys/mapdl/core/_commands/preproc/elements.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ def egen(
Generate elements from selected pattern beginning with
IEL1 to IEL2 (defaults to IEL1) in steps of IEINC (
defaults to 1). If IEL1 is negative, IEL2 and IEINC are
ignored and the last \|IEL1\| elements
ignored and the last \\|IEL1\\| elements
(in sequence backward from the maximum element number)
are used as the pattern to be repeated. If IEL1 = ALL,
IEL2 and IEINC are ignored and use all selected elements
Expand Down Expand Up @@ -1083,7 +1083,7 @@ def engen(
Generate elements from the pattern that begins with IEL1
to IEL2 (defaults to IEL1) in steps of IEINC (defaults to
1). If IEL1 is negative, IEL2 and IEINC are ignored and
use the last \|IEL1\| elements (in sequence backward from
use the last \\|IEL1\\| elements (in sequence backward from
the maximum element number) as the pattern to be
repeated. If IEL1 = ALL, IEL2 and IEINC are ignored and
all selected elements [ESEL] are used as the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1139,7 +1139,7 @@ def rescontrol(
maxfiles
Maximum number of ``.Xnnn`` files to save for Ldstep.
\-1
\\-1
Overwrite existing ``.Xnnn`` files (default). The total maximum number of ``.Xnnn``
files for one run is 999. If this number is reached before the analysis is complete,
the program will reset the ``.Xnnn`` file numbering back to 1 and continue to write
Expand Down
34 changes: 17 additions & 17 deletions src/ansys/mapdl/core/launcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -1302,96 +1302,96 @@ def launch_mapdl(
running MAPDL as a service via gRPC. Excluded switches such as
``"-j"`` either not applicable or are set via keyword arguments.
\-acc <device>
\\-acc <device>
Enables the use of GPU hardware. See GPU
Accelerator Capability in the Parallel Processing Guide for more
information.
\-amfg
\\-amfg
Enables the additive manufacturing capability. Requires
an additive manufacturing license. For general information about
this feature, see AM Process Simulation in ANSYS Workbench.
\-ansexe <executable>
\\-ansexe <executable>
Activates a custom mechanical APDL executable.
In the ANSYS Workbench environment, activates a custom
Mechanical APDL executable.
\-custom <executable>
\\-custom <executable>
Calls a custom Mechanical APDL executable
See Running Your Custom Executable in the Programmer's Reference
for more information.
\-db value
\\-db value
Initial memory allocation
Defines the portion of workspace (memory) to be used as the
initial allocation for the database. The default is 1024
MB. Specify a negative number to force a fixed size throughout
the run; useful on small memory systems.
\-dis
\\-dis
Enables Distributed ANSYS
See the Parallel Processing Guide for more information.
\-dvt
\\-dvt
Enables ANSYS DesignXplorer advanced task (add-on).
Requires DesignXplorer.
\-l <language>
\\-l <language>
Specifies a language file to use other than English
This option is valid only if you have a translated message file
in an appropriately named subdirectory in
``/ansys_inc/v201/ansys/docu`` or
``Program Files\\ANSYS\\Inc\\V201\\ANSYS\\docu``
\-m <workspace>
\\-m <workspace>
Specifies the total size of the workspace
Workspace (memory) in megabytes used for the initial
allocation. If you omit the ``-m`` option, the default is 2 GB
(2048 MB). Specify a negative number to force a fixed size
throughout the run.
\-machines <IP>
\\-machines <IP>
Specifies the distributed machines
Machines on which to run a Distributed ANSYS analysis. See
Starting Distributed ANSYS in the Parallel Processing Guide for
more information.
\-mpi <value>
\\-mpi <value>
Specifies the type of MPI to use.
See the Parallel Processing Guide for more information.
\-mpifile <appfile>
\\-mpifile <appfile>
Specifies an existing MPI file
Specifies an existing MPI file (appfile) to be used in a
Distributed ANSYS run. See Using MPI Files in the Parallel
Processing Guide for more information.
\-na <value>
\\-na <value>
Specifies the number of GPU accelerator devices
Number of GPU devices per machine or compute node when running
with the GPU accelerator feature. See GPU Accelerator Capability
in the Parallel Processing Guide for more information.
\-name <value>
\\-name <value>
Defines Mechanical APDL parameters
Set mechanical APDL parameters at program start-up. The parameter
name must be at least two characters long. For details about
parameters, see the ANSYS Parametric Design Language Guide.
\-p <productname>
\\-p <productname>
ANSYS session product
Defines the ANSYS session product that will run during the
session. For more detailed information about the ``-p`` option,
see Selecting an ANSYS Product via the Command Line.
\-ppf <license feature name>
\\-ppf <license feature name>
HPC license
Specifies which HPC license to use during a parallel processing
run. See HPC Licensing in the Parallel Processing Guide for more
information.
\-smp
\\-smp
Enables shared-memory parallelism.
See the Parallel Processing Guide for more information.
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/mapdl/core/mapdl_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -2821,7 +2821,7 @@ def _check_on_docker(self):

if self.platform == "linux":
self.sys(
"if grep -sq 'docker\|lxc' /proc/1/cgroup; then echo 'true' > __outputcmd__.txt; else echo 'false' > __outputcmd__.txt;fi;"
r"if grep -sq 'docker\|lxc' /proc/1/cgroup; then echo 'true' > __outputcmd__.txt; else echo 'false' > __outputcmd__.txt;fi;"
)
elif self.platform == "windows": # pragma: no cover
return False # TODO: check if it is running a windows docker container. So far it is not supported.
Expand Down
8 changes: 4 additions & 4 deletions src/ansys/mapdl/core/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ def numcpu(self) -> int:
def routine(self) -> str:
"""Current routine string as a string. For example ``"/PREP7"``
MAPDL Command: \*GET, ACTIVE, 0, ROUT
MAPDL Command: \\*GET, ACTIVE, 0, ROUT
Returns
-------
Expand Down Expand Up @@ -564,7 +564,7 @@ def _set_parameter_array(self, name, arr):
"""Load a numpy array or python list directly to MAPDL
Writes the numpy array to disk and then reads it in within
MAPDL using \*VREAD.
MAPDL using \\*VREAD.
Parameters
----------
Expand Down Expand Up @@ -751,12 +751,12 @@ def is_array_listing(status):


def interp_star_status(status):
"""Interprets \*STATUS command output from MAPDL
"""Interprets \\*STATUS command output from MAPDL
Parameters
----------
status : str
Output from MAPDL \*STATUS
Output from MAPDL \\*STATUS
Returns
-------
Expand Down

0 comments on commit 278ecde

Please sign in to comment.