Mapdl

Mapdl Class Specific Classes or Attributes

class ansys.mapdl.core.mapdl._MapdlCore(loglevel='DEBUG', use_vtk=True, log_apdl=False, local=True, **start_parm)

Contains methods in common between all Mapdl subclasses

Mapdl.add_file_handler(filepath[, append, level])

Add a file handler to the mapdl log.

Mapdl.allow_ignore

Invalid commands will be ignored rather than exceptions

Mapdl.chain_commands

Chain several mapdl commands.

Mapdl.directory

Current MAPDL directory

Mapdl.geometry

Geometry information.

Mapdl.get([par, entity, entnum, item1, …])

Retrieves a value and stores it as a scalar parameter or part of an array parameter.

Mapdl.get_array([entity, entnum, item1, …])

Uses the VGET command to Return an array from ANSYS as a Python array.

Mapdl.get_value([entity, entnum, item1, …])

Runs the GET command and returns a Python value.

Mapdl.ignore_errors

Flag to ignore MAPDL errors.

Mapdl.jobname

MAPDL job name.

Mapdl.last_response

Returns the last response from MAPDL.

Mapdl.load_table(name, array[, var1, var2, var3])

Load a table from Python to MAPDL.

Mapdl.mesh

Mesh information.

Mapdl.modal_analysis([method, nmode, freqb, …])

Run a modal with basic settings analysis

Mapdl.non_interactive

Non-interactive context manager.

Mapdl.open_apdl_log(filename[, mode])

Start writing all APDL commands to an ANSYS input file.

Mapdl.open_gui([include_result])

Saves existing database and opens up the APDL GUI.

Mapdl.parameters

Collection of MAPDL parameters obtainable from the *GET command or GET command.

Mapdl.result

Binary interface to the result file using pyansys.Result

Mapdl.run(command[, write_to_log])

Run single APDL command.

Mapdl.run_multiline(commands)

Run several commands as a single block

Mapdl.set_log_level(loglevel)

Sets log level

Mapdl.version

MAPDL build version

Latest 2021R1 and newer features

class ansys.mapdl.core.mapdl_grpc.MapdlGrpc(ip='127.0.0.1', port=None, timeout=15, loglevel='WARNING', cleanup_on_exit=False, log_apdl=False, set_no_abort=True, remove_temp_files=False, **kwargs)

This class connects to a GRPC MAPDL server and allows commands to be passed to a persistent session.

Parameters
  • ip (str, optional) – IP address to connect to the server. Defaults to ‘localhost’.

  • port (int, optional) – Port to connect to the mapdl server. Defaults to 50052.

  • timeout (float) – Maximum allowable time to connect to the MAPDL server.

  • loglevel (str, optional) – Sets which messages are printed to the console. Default ‘INFO’ prints out all ANSYS messages, ‘WARNING` prints only messages containing ANSYS warnings, and ‘ERROR’ prints only error messages.

  • cleanup_on_exit (bool, optional) – Exit MAPDL when Python exits or when this instance is garbage collected.

  • set_no_abort (bool, optional) – Sets MAPDL to not abort at the first error within /BATCH mode. Default True.

  • remove_temp_files (bool, optional) – Removes temporary files on exit if MAPDL is local. Default False.

Examples

Connect to an instance of MAPDL already running on locally on the default port 50052.

>>> from ansys.mapdl import core as pymapdl
>>> mapdl = pymapdl.Mapdl()

Connect to an instance of MAPDL running on the LAN on a default port

>>> mapdl = pymapdl.Mapdl('192.168.1.101')

Connect to an instance of MAPDL running on the LAN on a non-default port

>>> mapdl = pymapdl.Mapdl('192.168.1.101', port=60001)

mapdl_grpc.MapdlGrpc.download(target_name[, …])

Download a file from the gRPC instance

mapdl_grpc.MapdlGrpc.list_error_file()

Listing of errors written in JOBNAME.err

mapdl_grpc.MapdlGrpc.list_files([refresh_cache])

List the files in the working directory of MAPDL.

mapdl_grpc.MapdlGrpc.math

APDL math interface

mapdl_grpc.MapdlGrpc.mute

Silence the response from all MAPDL functions unless explicitly set to True.

mapdl_grpc.MapdlGrpc.upload(file_name[, …])

Upload a file to the grpc instance