CFDEM environment variable and alias information

Obligatory environment variables

• CFDEM_VERSION:

  • string representing the release name

  • default value: BASIC

• CFDEM_PROJECT_DIR:

  • path to CFDEMcoupling installation

  • default value: $HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION

• CFDEM_PROJECT_USER_DIR:

  • path to user specific run and src directories

  • default value: $HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION

• CFDEM_bashrc:

  • path to CFDEM bashrc

  • default value: $CFDEM_PROJECT_DIR/src/lagrangian/cfdemParticle/etc/bashrc

• CFDEM_ASX_INSTALL_DIR:

  • installation folder of Aspherix containing bin/aspherix folder

  • default value: $HOME/DCS-Computing/Aspherix-6.0.0

---

Optional environment variables

• CFDEM_VERBOSE:

  • if set false the CFDEM settings will not be prompted to the terminal during loading the CFDEM bashrc

  • default value: true

• CFDEM_ASX_EXEC:

  • path to Aspherix executable used in CFDEM scripts

  • default value: $CFDEM_ASX_INSTALL_DIR/bin/aspherix:

• CFDEM_SOCKET_HYPERTHREADING:

  • set system wide default for twoWaySocket hyperthreading setting

  • default value: on

---

Available aliases

alias name	usage	description
cfdem	cfdem	change dir to CFDEM install dir
cfdemSrc	cfdemSrc	change dir to CFDEM src dir
cfdemEtc	cfdemEtc	change dir to CFDEM etc dir (location of bashrc)
cfdemTut	cfdemTut	change dir to CFDEM tutorials dir
cfdemSol	cfdemSol	change dir to CFDEM solvers dir
cfdemUt	cfdemUt	change dir to CFDEM utilities dir
cfdemRun	cfdemRun	change dir to CFDEM user run dir
cfdemASX	cfdemASX	change dir to Aspherix installation dir
cfdemSysTest	cfdemSysTest	perform sanity checks on environment settings
cfdemCompCFDEM	cfdemCompCFDEM	compile CFDEMcoupling
cfdemCompCFDEMsrc	cfdemCompCFDEMsrc	compile the CDFEM source libraries
cfdemCompCFDEMsol	cfdemCompCFDEMsol	compile the CFDEM solvers
cfdemCompCFDEMuti	cfdemCompCFDEMuti	compile the CFDEM utilities
cfdemTestTUT	cfdemTestTUT	run all tutorial cases consecutively
cfdemAspherix	cfdemAspherix ./input/script/path	run Aspherix with the provided input script
cfdemAspherixPar	cfdemAspherixPar ./input/script/path np	run Aspherix in parallel with np cores
cfdemUnsetEnv	cfdemUnsetEnv	remove loaded CFDEM environment (incl. aliases, functions and variables) from the current bash environment