Skip to content

Commit

Permalink
Release 20.1.0 commit
Browse files Browse the repository at this point in the history
  • Loading branch information
dieter-wilhelm committed Feb 15, 2020
1 parent 24c6b31 commit 5ee29d7
Show file tree
Hide file tree
Showing 6 changed files with 197 additions and 162 deletions.
39 changes: 26 additions & 13 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#+STARTUP: all
#+DATE: Time-stamp: <2020-02-13>
#+DATE: Time-stamp: <2020-02-15>
#+bind: org-html-preamble-format (("en" "%d"))
#+OPTIONS: ':nil *:t -:t ::t <:t H:3 \n:nil ^:t arch:headline
#+OPTIONS: author:t c:nil creator:comment d:(not "LOGBOOK") date:t
Expand Down Expand Up @@ -50,14 +50,16 @@ Copyright (C) 2006 - 2020 H. Dieter Wilhelm, GPL V3
diminished. But APDL is here to stay: `WorkBench' and `AIM' operate
exclusively the ANSYS solver with it! They are sending APDL input
(.dat) files to the solver. For a true understanding of the GUIs'
inner workings a study of this APDL code is prerequisite.
inner workings a study of APDL code is prerequisite.

Moreover the GUIs are not supporting all solver features. So APDL
`Command Snippets' enhance the GUIs' modelling capabilities.
* Some highlights
Nowadays I find APDL-Mode mostly useful in writing these `Command
Snippets' or reading snippets from colleagues. Or for studying
solver (.dat) files which are created by WorkBench.
Nowadays I find APDL-Mode mostly useful in writing `Command
Snippets' and inspecting longer snippets from other sources.
Likewise for studying solver (.dat) files which were created by
WorkBench. Alone APDL-Mode's support for rapidly accessing the
ANSYS APDL documentation is worth using it.
** In-built APDL command help with argument counter
Especially for commands with a large number of arguments it is
cumbersome to count the arguments, *C-?* facilitates this for you
Expand Down Expand Up @@ -100,23 +102,34 @@ Copyright (C) 2006 - 2020 H. Dieter Wilhelm, GPL V3
# - APDL-Mode is now available on MELPA
# For further installation options

1) Install [[https://www.gnu.org/software/emacs/][GNU-Emacs]] (if you are new to Emacs please check the
tutorial in the `Help' menu).
2) Install the APDL-Mode package (You need at least Emacs-25.1.)
1) Install [[https://www.gnu.org/software/emacs/][GNU-Emacs]] (if you are new to the Emacs editor please check
the tutorial in the `Help' menu, please really do it ;-).

2) Download APDL-Mode's tar file from [[https://github.com/dieter-wilhelm/apdl-mode/releases/tag/20.1.0][Github]]:

3) Install the APDL-Mode package (You need at least emacs-25.1.)

Type `M-x package-install-file' and select the downloaded tar
package.


# melpa, add the following in your GNU-Emacs init file:
# (add-to-list 'package-archives
# '("melpa" . "http://melpa.org/packages/") t)
# Then do M-x package-list-packages, find apdl-mode and install it.

That's it.

For further installation options please have a
look in the [[file:INSTALLATION.org][INSTALLATION]] file.

* Usage
Please type `M-x apdl' then you are in an APDL-Mode buffer and you
can check the menu bar's `APDL' or `ANSYS' entries. Please select
`Describe APDL-Mode' or type `C-h m', which will display the
APDL-Mode help with further guidance.
Please type `M-x apdl' which opens an APDL-Mode buffer and you can
inspect the menu bar's `APDL' or `ANSYS' entries. Please select
`Describe APDL-Mode' or type `C-h m', which will display APDL-Mode's
help with further guidance in using it.

You might check the introductory APDL-Mode tutorial
You might also check the introductory APDL-Mode tutorial
([[file:doc/A-M_introductory_tutorial.org][A-M_introductory_tutorial.org]]) for an overview as well.

* Configuration and Customisation
Expand Down
24 changes: 11 additions & 13 deletions TODO.org
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#+DATE: Time-stamp: <2020-02-14>
#+DATE: Time-stamp: <2020-02-15>
#+bind: org-html-preamble-format (("en" "%d"))
#+OPTIONS: html-link-use-abs-url:nil html-postamble:t html-preamble:t
#+OPTIONS: html-scripts:t html-style:t html5-fancy:nil tex:t
Expand All @@ -15,31 +15,29 @@

#+STARTUP: showall
* 20.1.0
** bugs
- bug-report about package.el
- Build package with makefile and add installation recipe, update
INSTALLATION.org and do a 20.1.0 release
- M-? with too many commas throws an error
- The ANSYS menu enty is not working under Win10??
** bugs

- C-c C-b no warning, when -help-path is not initialised!!!
- M-? with too many commas throws an error, is message good enough?
- The APDL menu entry in the terminal is not working => wrong type
argument!
- check highlighting of -license-type
- apdl command in sandbox not working <= autoload not working?

- The ANSYS menu enty is not working under Win10??
- apdl command in sandbox not working <= autoload not working?, done
** wishes
- Remove unnecessary tags from Github
- Check customisation system
- online documentation: still ANSYS-mode!
- Trigger the ANSYS online manual, if there's no local docu
- Trigger the ANSYS online manual, if there's no local docu for C-c C-b
** misc
- bug-report about package.el "NAME-readme.txt", done
- package-lint
- problems with prefix names and default key bindings...
- are the material properties documented?
- how about the work branch?
- Read the ansys manual in EWW => (setq browse-url-browser-function
'eww-browse-url) I had to change the configuration of
apdl-ansys-help-path though: "/c:/CAx/App/ANSYS
Inc/v201/commonfiles/help/en-us/help/" (note the slash before c:!
whats going on here?) for chrome file:///c:/ is working as
well...
- what is default.el <=> apdl-config.el?, dito. a-m.el!?
- README (for package-el) README.org for github
- ANSYS is often used synonymous for ANSYS MAPDL solver /
Expand Down
146 changes: 77 additions & 69 deletions apdl-config.el
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

;; Copyright (C) 2016 - 20202 H. Dieter Wilhelm, GPL V3

;;; Comentary:

;; `apdl-config.el' can be used as a configuration file (after moving
;; it e. g. to `/usr/share/emacs/site-lisp' or
;; `c:\\EMACS_INSTALLDIR\\site-lisp'). Yet this file is then loaded
Expand All @@ -16,7 +18,7 @@
;; at least its corresponding sections) otherwise clashing settings in
;; `.emacs' will be overwritten!!!

;;; CONVENTIONS:
;;; Commentary:

;; The comment sign is `;' (one semi-colon ;) Textual hints are
;; indicated with DOUBLE semi-colons `;;', optionally uncomment the
Expand All @@ -25,14 +27,14 @@
;;; CODE:

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; IMPORTANT PREREQUISIT
;; IMPORTANT PREREQUISIT
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; !!! If the APDL-Mode files (*.el) are NOT placed in a default
;; Emacs load-path it is necessary to adjust the following
;; variable:!!! Hint: The directory site-lisp/ in the Emacs
;; installation tree, for example, is in its default load-path.

;; (add-to-list 'load-path "C:\\DIRECTORY-PATH\\WHERE\\THE\\APDL-MODE\\FILES\\RESIDE")
;(add-to-list 'load-path "C:\\DIRECTORY-PATH\\WHERE\\THE\\APDL-MODE\\FILES\\RESIDE")

;; for example: "c:\\emacs\\apdl-mode" for a Windows system or
;; "/usr/local/src/emacs/apdl-mode" for a GNU-Linux system.
Expand All @@ -42,25 +44,25 @@
;; ANSYS (if they are differing from the defaults and restart Emacs
;; ;-), the complete paths will be constructed with below information

;; (setq apdl-current-apdl-version "150") ; "162" default in APDL-Mode 162-1
;(setq apdl-current-apdl-version "150") ; "162" default in APDL-Mode 162-1

;; if `apdl-install-directory' is not set APDL-Mode tries to
;; if `apdl-ansys-install-directory' is not set APDL-Mode tries to
;; initialise it from the environment variable `AWP_ROOT162'.

;; conditional: Linux or Windows
;; (cond ((string= window-system "x")
;; ;; This is an example of an installation directory on GNU-Linux
;; (setq apdl-install-directory "/appl")) ; default: "/"
;; (t
;; ;;This an example of an installation dir. on WINDOWS
;; (setq apdl-install-directory "D:\\Ansys")) ; default: "C:\\Program Files"
;; )
;(cond ((string= window-system "x")
; ;; This is an example of an installation directory on GNU-Linux
; (setq apdl-ansys-install-directory "/appl")) ; default: "/"
; (t
; ;;This an example of an installation dir. on WINDOWS
; (setq apdl-ansys-install-directory "D:\\Ansys")) ; default: "C:\\Program Files"
; )

;; If the paths of your ANSYS installation is completely differing
;; from the normal ANSYS structures, please see below.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; IMPORTANT END
;; IMPORTANT END
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
Expand All @@ -84,46 +86,46 @@
(add-to-list 'auto-mode-alist '("\\.anf$" . apdl-mode))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Auto insertion
;; Auto insertion
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; auto insertion stuff (when creating a new APDL file)

(auto-insert-mode 1) ; insert automatically templates
(auto-insert-mode 1) ; insert automatically templates
(add-hook 'find-file-hook 'auto-insert) ; when opening new files
(setq auto-insert-query t) ; aks for auto insertion of APDL template
(add-to-list 'auto-insert-alist
'(apdl-mode . [apdl-skeleton-outline-template])) ;which template to insert
'(apdl-mode . [apdl-skeleton-outline-template])) ;which template to insert

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Autoloading
;; Autoloading
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Set of useful commands which are interactively available (M-x ...)
;; even when APDL Mode was not (yet) activated i.e. the lisp files not
;; loaded.

(autoload 'apdl "apdl-mode" "Opening an empty buffer in APDL-Mode" 'interactive)
(autoload 'apdl-mode "apdl-mode" "Switch to APDL-Mode" 'interactive)
(autoload 'apdl-customise-ansys "apdl-mode" "Activate the function for
(autoload 'apdl "apdl-mode" "Opening an empty buffer in APDL-Mode" 'interactive)
(autoload 'apdl-mode "apdl-mode" "Switch to APDL-Mode" 'interactive)
(autoload 'apdl-customise-ansys "apdl-mode" "Activate the function for
calling a special ANSYS customisation buffer." 'interactive)
(autoload 'apdl-abort-file "apdl-mode" "Activate the function for aborting ANSYS runs." 'interactive)
(autoload 'apdl-display-error-file "apdl-mode" "Activate the function for inspecting the ANSYS error file." 'interactive)
(autoload 'apdl-start-apdl-help "apdl-mode" "Activate the function for starting the ANSYS help browser." 'interactive)
(autoload 'apdl-start-ansys "apdl-mode" "Activate the function for starting the APDL interpreter under GNU-Linux or product launcher under Windows." 'interactive)
(autoload 'apdl-start-classics "apdl-mode" "Activate the function for starting the MAPDL in GUI Mode (APDL-Classics)." 'interactive)
(autoload 'apdl-start-wb "apdl-mode" "Activate the function for starting Workbench." 'interactive)
(autoload 'apdl-license-status "apdl-mode" "Activate the function for displaying ANSYS license status or starting a license utility." 'interactive)
(autoload 'apdl-mode-version "apdl-mode" "Show APDL-Mode's version number." 'interactive)
(autoload 'apdl-abort-file "apdl-mode" "Activate the function for aborting ANSYS runs." 'interactive)
(autoload 'apdl-display-error-file "apdl-mode" "Activate the function for inspecting the ANSYS error file." 'interactive)
(autoload 'apdl-start-apdl-help "apdl-mode" "Activate the function for starting the ANSYS help browser." 'interactive)
(autoload 'apdl-start-ansys "apdl-mode" "Activate the function for starting the APDL interpreter under GNU-Linux or product launcher under Windows." 'interactive)
(autoload 'apdl-start-classics "apdl-mode" "Activate the function for starting the MAPDL in GUI Mode (APDL-Classics)." 'interactive)
(autoload 'apdl-start-wb "apdl-mode" "Activate the function for starting Workbench." 'interactive)
(autoload 'apdl-license-status "apdl-mode" "Activate the function for displaying ANSYS license status or starting a license utility." 'interactive)
(autoload 'apdl-mode-version "apdl-mode" "Show APDL-Mode's version number." 'interactive)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Outlining
;; Outlining
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; activating outline minor mode for selectively hiding/unhiding
;; sections

(add-hook 'apdl-mode-hook 'apdl-outline-minor-mode) ;enable outlining

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Highlighting/Colourisation
;; Highlighting/Colourisation
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; The following toggles a dynamics change of the highlighting: While
Expand All @@ -134,78 +136,84 @@
;; files (but only when apdl-highlighting-level is set to 2, see
;; below).

;; (setq apdl-dynamic-highlighting-flag nil)
;; (setq apdl-dynamic-highlighting-flag t) ;default
;(setq apdl-dynamic-highlighting-flag nil)
;(setq apdl-dynamic-highlighting-flag t) ;default

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; fontification (highlighting) of user variables and decoration
;; levels (0,1,2 are available), user variables highlighting is only
;; in level 2 available (statical, if above flag is not set), the
;; default is 2

;; (setq apdl-highlighting-level 1) ; default: 2
;(setq apdl-highlighting-level 1) ; default: 2

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; ANSYS version and paths
;; ANSYS version and paths
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; Things you might have to configure if your ANSYS installation is
;; completely differing from default ANSYS installation paths, as in
;; the example below:

;; (setq apdl-help-program
;; "/appl/ansys_inc/16.2.0/v162/commonfiles/help/HelpViewer/ANSYSHelpViewer.exe")
;; ;;the ANSYS path to the help viewer looks normally like this:
;; ;; "/INSTALL_DIRECTORY/ansys_inc/v162/commonfiles/help/HelpViewer/ANSYSHelpViewer.exe"
;; (setq apdl-help-path "/appl/ansys_inc/16.2.0/v162/commonfiles/help/en-us/help/")
;; (setq apdl-program "/appl/ansys_inc/16.2.0/v162/ansys/bin/ansys162")
;; (setq apdl-lmutil-program "/appl/ansys_inc/16.2.0/shared_files/licensing/linx64/lmutil")
; (setq apdl-help-program
; "/appl/ansys_inc/16.2.0/v162/commonfiles/help/HelpViewer/ANSYSHelpViewer.exe")
; ;;the ANSYS path to the help viewer looks normally like this:
; ;; "/INSTALL_DIRECTORY/ansys_inc/v162/commonfiles/help/HelpViewer/ANSYSHelpViewer.exe"
;; ;; on windows systems (note the slash before c:!)
;; (setq apdl-ansys-help-path "/c:/Program Files/ANSYS Inc/16.2.0/v162/commonfiles/help/en-us/help/")

; (setq apdl-ansys-help-path "/appl/ansys_inc/16.2.0/v162/commonfiles/help/en-us/help/")
; (setq apdl-ansys-program "/appl/ansys_inc/16.2.0/v162/ansys/bin/ansys162")
; (setq apdl-lmutil-program "/appl/ansys_inc/16.2.0/shared_files/licensing/linx64/lmutil")

;; if you want to read the manual in GNU-Emacs' EWW browser
;(setq browse-url-browser-function 'eww-browse-url)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; ANSYS processes stuff
;; ANSYS processes stuff
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; license server configuration
;; license server configuration


;; GNU-Linux 64 bit only !!! Warning specifiying many license server
;; takes a long time for displaying the license status!!!
;; GNU-Linux 64 bit only !!! Warning specifiying many license server
;; takes a long time for displaying the license status!!!

;; for starting the solver & apdl-license-status & ANSYS help
;; (setq ;
;; license servers (or license file name)nn
;; specify even the default port for lmutil (since ANSYS V 12.0) on GNU-Linux
;; GNU-Linux: License servers separated by colons (":"), 1055 is the default port
;; apdl-license-file
;; "32002@ls_fr_ansyslmd_ww_1.conti.de"
;; "32002@ls_fr_ansyslmd_ww_1.conti.de:32002@ls_fr_ansyslmd_ww_2.conti.de:32002@ls_fr_ansyslmd_ww_4.conti.de:1055@frlifl01.auto.contiwan.com:1055@frlifl02.auto.contiwan.com"
;; for starting the solver & apdl-license-status & ANSYS help
; (setq ;
;; license servers (or license file name)nn
;; specify even the default port for lmutil (since ANSYS V 12.0) on GNU-Linux
;; GNU-Linux: License servers separated by colons (":"), 1055 is the default port
; apdl-license-file
; "32002@ls_fr_ansyslmd_ww_1.conti.de"
; "32002@ls_fr_ansyslmd_ww_1.conti.de:32002@ls_fr_ansyslmd_ww_2.conti.de:32002@ls_fr_ansyslmd_ww_4.conti.de:1055@frlifl01.auto.contiwan.com:1055@frlifl02.auto.contiwan.com"

;; since ANSYS 12.0 there is an intermediate server for
;; the communication between flexlm and ANSYS, 2325 is the default port
;; apdl-ansysli-servers
;; "2325@ls_fr_ansyslmd_ww_1.conti.de"
;; "2325@ls_fr_ansyslmd_ww_1.conti.de:2325@ls_fr_ansyslmd_ww_3.conti.de:2325@ls_fr_ansyslmd_ww_4.conti.de:2325@frlifl01.auto.contiwan.com:2325@frlifl02.auto.contiwan.com"
;; )
;; since ANSYS 12.0 there is an intermediate server for
;; the communication between flexlm and ANSYS, 2325 is the default port
; apdl-ansysli-servers
; "2325@ls_fr_ansyslmd_ww_1.conti.de"
; "2325@ls_fr_ansyslmd_ww_1.conti.de:2325@ls_fr_ansyslmd_ww_3.conti.de:2325@ls_fr_ansyslmd_ww_4.conti.de:2325@frlifl01.auto.contiwan.com:2325@frlifl02.auto.contiwan.com"
; )

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; options when starting the solver
;; options when starting the solver
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; Number of cores for the run, 2 does not require HPC licenses
;; (setq apdl-no-of-processors 8) ;default: 2
;; Number of cores for the run, 2 does not require HPC licenses
;(setq apdl-no-of-processors 8) ;default: 2

;; which license type to use for the solver
;; (setq apdl-license "ansys") ;default: "struct"
;; which license type to use for the solver
;(setq apdl-license "ansys") ;default: "struct"

;; ANSYS job name
;; (setq apdl-job "otto"); default: "file"
;; ANSYS job name
;(setq apdl-job "otto"); default: "file"

;; adding the directory of this (loaded) file to the load-path
(add-to-list 'load-path (file-name-directory load-file-name))
;; setting the APDL-Mode install directory
(setq apdl-mode-install-directory (file-name-directory load-file-name))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; The End
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; The End
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;; apdl-config.el ends here

Expand Down
Loading

0 comments on commit 5ee29d7

Please sign in to comment.