COMSOL

Introduction

COMSOL is a general-purpose platform software for modeling engineering applications. Compute Canada would like to thank COMSOL, Inc. for allowing its software to be hosted on Compute Canada clusters via a special agreement.

We recommend that Compute Canada users who wish to run COMSOL consult the documentation included with the software under File > Help > Documentation prior to attempting to use it on one of the clusters. Some of the basic manuals are available here.

Licensing

Compute Canada is a hosting provider for COMSOL. This means that we have COMSOL software installed on our clusters, but we do not provide a generic license accessible to everyone. However, many institutions, faculties, and departments already have licenses that can be used on our clusters.

Once the legal aspects are worked out for licensing, there will be remaining technical aspects. The license server on your end will need to be reachable by our compute nodes. This will require our technical team to get in touch with the technical people managing your license software. In some cases, this has already been done. You should then be able to load the COMSOL modules, and it should find its license automatically. If this is not the case, please contact our Technical support, so that we can arrange this for you.

Configuring your own license file

Our module for COMSOL is designed to look for license information in a few places. One of those places is your home folder. If you have your own license server, you can write the information to access it in the following format:

File : comsol.lic

SERVER <server> ANY <port>
USE_SERVER

and put this file in the folder $HOME/.licenses/. Note that firewall changes will need to be done on both our side and your side. To arrange this, send an email containing your servers flex port and ip address to Technical support. CMC license holders should use "SERVER 132.219.136.89 ANY 6601" on beluga, "SERVER 199.241.162.97 ANY 6601" on graham, or "SERVER 172.16.121.25 ANY 6601" on cedar.

Running COMSOL on a single node

Below is a sample submission script for running COMSOL with 8cores on a single Compute Canada compute node:

File : mysub1.sh

#!/bin/bash
#SBATCH --account=def-account     # Specify
#SBATCH --time=0-01:00            # d-hh:mm
#SBATCH --mem=3G                  # Change
#SBATCH --cpus-per-task=8         # Change
#SBATCH --nodes=1                 # Do not change
#SBATCH --ntasks-per-node=1       # Do not change
module load comsol/5.5
NCORE=$((SLURM_NTASKS * SLURM_CPUS_PER_TASK))

comsol batch -np $NCORE -inputfile FILENAME.mph -outputfile solved_out.mph

Note that depending on the complexity of the simulation, COMSOL may not be able to efficiently use very many cores. Therefore please test the scaling of your simulation by increasing the number of cores in #SBATCH --cpus-per-task=X from X=1 to the maximum number of cores on the compute node you are using. If you still get a good speed-up running on a full compute node then consider running the job over multiple full nodes by adjusting the following submission script.

Running COMSOL on multiple nodes

Below is a sample submission script for running COMSOL with 8cores distributed evenly over 2 Compute Canada compute nodes:

File : mysub2.sh

#!/bin/bash
#SBATCH --account=def-account     # Specify
#SBATCH --time=00-06:00           # dd-hh:mm
#SBATCH --mem=3G                  # Change (set to 0 for full nodes)
#SBATCH --nodes=2                 # Change
#SBATCH --cpus-per-task=4         # Change (set to max cores for full nodes)
#SBATCH --ntasks-per-node=1       # Recommended to not change
module load comsol/5.5

comsol batch -inputfile FILENAME.mph -outputfile solved_out.mph \
 -nn $SLURM_NTASKS -nnhost $SLURM_NTASKS_PER_NODE -np $SLURM_CPUS_PER_TASK