COMSOL 6.4 - Model Utility Methods

Name	Syntax	Description
clearModel	clearModel(Model model) clearModel(String tag)	Remove everything from the model except for the application part and the things you can change on the root node in the Model Builder, such as thumbnail, comment, and author.
createModel	Model createModel(String tag)	Creates a new model with the given tag.
createModel	Model createModel()	Create a new model with a unique tag.
getModel	Model getModel(String tag)	Returns the model with a specified tag.
loadModel	Model loadModel(String location)	Loads a model with a specified tag from a file on the file system or in a database.
loadModel	Model loadModel(String tag, String location)	Loads a model from a file. The model is given a unique tag.
loadProtectedModel	Model loadProtectedModel(String tag, String filename, String password)	Loads a password protected model with a specified tag from a file.
loadProtectedModel	Model loadProtectedModel(String filename, String password)	Loads a password protected model from a file. The model is given a unique tag.
loadRecoveryModel	Model loadRecoveryModel(String tag, String foldername)	Loads a model from a recovery directory/folder structure.
loadRecoveryModel	Model loadRecoveryModel(String foldername)	Loads a model from a recovery directory/folder structure. The model is given a unique tag.
modelTags	String[] modelTags()	Returns an array of model tags for all loaded models, including the embedded model.
removeModel	removeModel(String tag) removeModel(Model model)	Removes a model. The embedded model cannot be removed.
saveModel	saveModel(Model model, String filename)	Saves a model to a file. The filename can be a file scheme path or (if allowed by security settings) a server file path.
uniqueModeltag	String uniqueModeltag(String prefix)	Returns a model tag that is not in use.
getComsolVersion	getComsolVersion()	Returns the current software version as a string.

clearModel(Model model)
clearModel(String tag)

Remove everything from the model except for the application part and the things you can change on the root node in the Model Builder, such as thumbnail, comment, and author.

createModel

Model createModel(String tag)

Creates a new model with the given tag.

createModel

Model createModel()

Create a new model with a unique tag.

getModel

Model getModel(String tag)

Returns the model with a specified tag.

loadModel

Model loadModel(String location)

Loads a model with a specified tag from a file on the file system or in a database.

loadModel

Model loadModel(String tag, String location)

Loads a model from a file. The model is given a unique tag.

loadProtectedModel

Model loadProtectedModel(String tag, String filename, String password)

Loads a password protected model with a specified tag from a file.

loadProtectedModel

Model loadProtectedModel(String filename, String password)

Loads a password protected model from a file. The model is given a unique tag.

loadRecoveryModel

Model loadRecoveryModel(String tag, String foldername)

Loads a model from a recovery directory/folder structure.

loadRecoveryModel

Model loadRecoveryModel(String foldername)

Loads a model from a recovery directory/folder structure. The model is given a unique tag.

modelTags

String[] modelTags()

Returns an array of model tags for all loaded models, including the embedded model.

removeModel

removeModel(String tag)
removeModel(Model model)

Removes a model. The embedded model cannot be removed.

saveModel

saveModel(Model model, String filename)

Saves a model to a file. The filename can be a file scheme path or (if allowed by security settings) a server file path.

uniqueModeltag

String uniqueModeltag(String prefix)

Returns a model tag that is not in use.

getComsolVersion

getComsolVersion()

Returns the current software version as a string.

For the built-in application methods loadModel(<location>) and loadModel(<tag>,<location>) the <location> argument scan either be the path to an MPH file found on the file system or a model location URI referencing a model version in a Model Manager database.

The model utility methods provide convenient shortcuts to commonly used methods in the ModelUtil class. In addition to these shortcuts, the ModelUtil class offers functionality for managing client–server operations. This includes methods for connecting to or disconnecting from a COMSOL Multiphysics server or COMSOL Server. For a complete list of available methods, refer to the Programming Reference Manual.

The code below loads a model using loadModel, presented in the table above. It extracts the x-, y-, and z-coordinates of all nodes and stores them in a 2D double array coords[3][N], where N is the number of nodes. The individual x-,y-, and z- coordinates are available as the length-N 1D arrays coords[0], coords[1], coords[2], respectively. (The node locations can be plotted by using the Cut Point 3D dataset in combination with a 3D Point Trajectories plot.)