License Methods

The license methods read the license number and check out or test the licenses of the current session or for an MPH file. This functionality can be used, for example, to limit the use of an application to one or a few license numbers or to dynamically adapt functionality of an application depending on which product licenses are available.


Name	Syntax	Description
checkoutLicense	boolean checkoutLicense(String... product)	Checks out licenses for all specified products. If not all licenses can be checked out, no licenses are checked out.
checkoutLicenseForFile	boolean checkoutLicenseForFile(String file)	Checks out licenses required to use a given MPH file. If not all required licenses can be checked out, no licenses are checked out.
checkoutLicenseForFileOnServer	boolean hasLicenseForFileOnServer(String file);	Checks out licenses required to use a given MPH file. If not all required licenses can be checked out, no licenses are checked out.
getLicenseNumber	String license = getLicenseNumber()	Returns a string with the license number for the current session.
hasProduct	boolean hasProduct(String... product)	Returns true if the COMSOL installation contains the software components required for running the specified products. Code completion can be used to get a list of valid product names.
hasProductForFile	boolean hasProductForFile(String file)	Returns true if the COMSOL installation contains the software components required for running the products required by a given MPH file.
hasProductForFileOnServer	boolean checkoutLicenseForFileOnServer(String file);	Returns true if the COMSOL installation contains the software components required for running the products required by a given MPH file.

Example code

The following code tries to check out a license for the AC/DC Module, and displays an error message if it fails:

if (!checkoutLicense("ACDC"))

alert("There seems to be a problem. Please contact Alice and Bob at 123-456-7890.");

You can use this to customize license error messages by calling a method containing this code before any add-on product specific features are used by the application.

In the Application Builder root node you can further select the check box. This will make it possible for users to start an application regardless of which licenses are available. However, this will not work if the application, at startup, uses features required by an add-on product. The application has to be created in such a way that the add-on product specific features are not used in the startup phase of the application but instead are deferred to later in the workflow.

To emulate a scenario where there are not enough available licenses you can, for example, disable one or more products in the dialog box, available from the menu in the COMSOL Desktop environment.

The following code tests if the COMSOL installation has the capability to use an MPH file:

boolean ok = hasProductForFile(“model_file.mph”);

Note that even if hasProductForFile return true, in a floating network license situation there may not be any free licenses to check out. If your application is going to process several MPH files and you want to make sure all licenses are checked out before the processing starts, instead use the checkoutLicense or checkoutLicenseForFile methods.

License Feature Strings

The following table contains the product strings for all add-on products in the COMSOL 6.1 product suite that can be used by the method checkoutLicense:


Product/Feature	Feature Name
AC/DC Module	ACDC
Acoustics Module	ACOUSTICS
Battery Design Module	BATTERYDESIGN
CAD Import Module	CADIMPORT
CFD Module	CFD
Chemical Reaction Engineering Module	CHEM
Corrosion Module	CORROSION
Design Module	DESIGN, CADIMPORT
ECAD Import Module	ECADIMPORT
Electrochemistry Module	ELECTROCHEMISTRY
Electrodeposition Module	ELECTRODEPOSITION
Fatigue Module	FATIGUE
File Import for CATIA V5	CATIA5
Fuel Cell & Electrolyzer Module	FUELCELLANDELECTROLYZER
Geomechanics Module	GEOMECHANICS
Heat Transfer Module	HEATTRANSFER
Liquid & Gas Properties Module	LIQUIDANDGASPROPERTIES
LiveLink™ for AutoCAD®	LLAUTOCAD, CADIMPORT
LiveLink™ for PTC® Creo® Parametric™	LLCREOPARAMETRIC, CADIMPORT
LiveLink™ for Excel®	LLEXCEL
LiveLink™ for Inventor®	LLINVENTOR, CADIMPORT
LiveLink™ for MATLAB®	LLMATLAB
LiveLink™ for Revit®	LLREVIT, CADIMPORT
LiveLink™ for PTC® Pro/ENGINEER®	LLPROENGINEER, CADIMPORT
LiveLink™ for Simulink®	LLSIMULINK
LiveLink™ for Solid Edge®	LLSOLIDEDGE, CADIMPORT
LiveLink™ for SOLIDWORKS®	LLSOLIDWORKS, CADIMPORT
Material Library	MATLIB
MEMS Module	MEMS
Metal Processing Module	METALPROCESSING
Microfluidics Module	MICROFLUIDICS
Mixer Module	MIXER
Molecular Flow Module	MOLECULARFLOW
Multibody Dynamics Module	MULTIBODYDYNAMICS
Nonlinear Structural Materials Module	NONLINEARSTRUCTMATERIALS
Optimization Module	OPTIMIZATION
Particle Tracing Module	PARTICLETRACING
Pipe Flow Module	PIPEFLOW
Plasma Module	PLASMA
Polymer Flow Module	POLYMERFLOW
Porous Media Flow Module	POROUSMEDIAFLOW
Ray Optics Module	RAYOPTICS
RF Module	RF
Rotordynamics Module	ROTORDYNAMICS
Semiconductor Module	SEMICONDUCTOR
Structural Mechanics Module	STRUCTURALMECHANICS
Subsurface Flow Module	SUBSURFACEFLOW
Uncertainty Quantification Module	UQ
Wave Optics Module	WAVEOPTICS