CFDEM environment variable and alias information

Obligatory environment variables

CFDEM_OF_DIR

Default:: $HOME/OpenFOAM/OpenFOAM-10, /opt/OpenFOAM/OpenFOAM-10

Location of OpenFOAM installation. Both default locations are being tested for existence. If both locations exist, the location in the user home directory takes precedence.

Note

This variable is unset (i.e. deleted) by the CFDEMcoupling bashrc after usage in order to avoid this variable being used by accident when resetting the environment.

CFDEM_ASX_INSTALL_DIR

Default:: determined from location of the aspherix executable

Installation folder of Aspherix containing the aspherix executable in bin/aspherix.

The bashrc will try to find the aspherix executable and set this variable automatically. If retrieving the executable fails, you must set this variable.

A typical value is $HOME/DCS-Computing/Aspherix-|version|

Note

This variable is unset (i.e. deleted) by the CFDEMcoupling bashrc after usage in order to avoid this variable being used by accident when resetting the environment.

CFDEM_PROJECT_DIR

Default:: determined from location of sourced CFDEMcoupling bashrc

Path to CFDEMcoupling installation

CFDEM_PROJECT_USER_DIR

Default:: your CFDEM_PROJECT_DIR prepended by your user name

The location where user-created cases and solvers are stored. This directory is automatically created when first entering it using the aliases cfdemRun, cfdemUsrSol or cfdemCreateUserDir.

Optional environment variables

CFDEM_VERBOSE

Default:: unset

If set to false the CFDEMcoupling environment settings will not be prompted to the terminal when loading the CFDEM bashrc.

CFDEM_ASX_EXEC

Default:: $CFDEM_ASX_INSTALL_DIR/bin/aspherix:

Path to Aspherix executable used in CFDEM scripts

CFDEM_SOCKET_HYPERTHREADING

Default:: on

The values on nad off are recognized. Set system wide default hyperthreading. This setting will be used by twoWaySocket and is documented there extensively.

CFDEM_SIM_USE_SLURM: Globally set cfdemSimulate to use slurm to start jobs.

Note

Does not exist by default, cfdemSimulate will only check existence of the variable but ignore the actual value.

CFDEM_SIM_SLURM_SBATCH: Globally set cfdemSimulate to use resources as stated in the SBATCH pragmas of the executing script.

Note

Does not exist by default, cfdemSimulate will only check existence of the variable but ignore the actual value.

Further environment variables

The following environment variables are set internally and can be used to conveniently to access further scripts and templates:

CFDEM_ETC_DIR: The etc dir containing the bashrc, compile scripts and so on.

CFDEM_SCRIPT_DIR: Directory containing extra scripts, automatically added to the PATH.

CFDEM_DEFAULT_DIR: Directory containing defaults for controlDict and various other settings.

CFDEM_SCHEME_PATH: Directory for the default schemes available in CFDEMcoupling, see also Modify a part of default fvSolution or fvSchemes settings.

Available aliases

alias name	usage	description
cfdem	cfdem	change dir to CFDEM install dir
cfdemSrc	cfdemSrc, cfdemsrc	change dir to CFDEM src dir
cfdemEtc	cfdemEtc, cfdemetc	change dir to CFDEM etc dir (location of bashrc)
cfdemTut	cfdemTut, cfdemtut	change dir to CFDEM tutorials dir
cfdemSol	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, use `-h` for options
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