The Model Page
The Model page shows the latest version of a model with respect to a branch in a repository. The toolbar at the top of the page contains the buttons and menu options:
•
Versions. View older versions of the model — see Model Version History.
•
Copy Location to Clipboard. Copy a location string identifier to your computer’s clipboard. This identifier can be used to quickly add a link to the model version when editing an asset on the Asset page — see Searching for Model Versions to Add.
•
Open in COMSOL Desktop. Open the model version in a COMSOL Multiphysics program session — see Opening Model Versions in the COMSOL Desktop.
•
Run in COMSOL Desktop. Run the model version in a COMSOL Multiphysics program session as an application — see Running Application Versions in the COMSOL Desktop. Only available for model versions of type Application.
•
Download. Download the model version as an MPH file — see Downloading a Model Version.
•
Customized Download. Download the model version as an MPH file using custom download settings.
•
Edit. Edit the model and save the changes as a new version — see Editing a Model.
The model page shows the title, description, assigned tags, filename, model tree, and thumbnail image of the model. A placeholder image is shown for models lacking a thumbnail image. The list of metadata fields on the left are:
•
Location. The repository and branch that the model version is saved in.
•
Owner. The user currently set as the owner of the model.
•
Saved. The point in time when the version was saved.
•
Saved by. The user that saved the version.
•
Saved in. The COMSOL Multiphysics version that the model was saved from.
•
Product requirements. The add-on products required to build the model in COMSOL Multiphysics. At least one product from each item in the bulleted list must be available for license checkout.
The model tree of the model version is shown in the Contents field. Click on a tree node to expand or collapse its children.
The model tree is only available for a model saved in COMSOL Multiphysics version 6.2 or later if the model was saved to the database by uploading an MPH file.
Models in the Model Manager Reference Manual.
Model Version References
You can see references between the current model version and other versions in the References table on the Model page. Select Show Referenced Versions to list all versions referenced by the current model version; select Show Referencing Versions to list all versions referencing the current model version.
The references are categorized by the following types:
•
Input file. A data file version used as input by a model version. Examples include CAD data, interpolation data, and mesh data.
•
Output file. A data file version generated as output from a model version. Examples include animations, images, plots, and reports.
•
Geometry part. A geometry part loaded from another model version.
You can filter the table by selecting from these types in the Reference Type list.
The table columns are:
•
The type column — an icon used to represent of the type of the version.
•
The Title column — the title of the version.
•
The Reference Type column — the type of version reference.
•
The Saved column — the point in time when the version was saved.
•
The Saved by column — the user that saved the version.
•
The Repository column — the repository that the version was saved in.
•
The Branch column — the branch that the version was saved in.
•
The Comments column — the commit comment written when the version was saved.
Click on the title of a version in the table to open its Model or File page.
The versions shown in the References table — with Show Referenced Versions selected — are so-called auxiliary data used by the model as either an input source or an output target.
The References Window in the Model Manager Reference Manual.
Asset Versions Linking to the Model Version
You can see asset versions that link to the current model version in the Assets table on the Model page. If more than one version of an asset link to the model version, only the most recently-saved asset version is included in the table.
The table columns are:
•
The Identifier column — the unique identifier of the asset.
•
The Title column — the title of the asset version.
•
The Saved column — the point in time when the asset version was saved.
•
The Saved by column — the user that saved the asset version.
•
The Owner column — the user that owns the asset.
Click on the title of an asset version in the table to open its Asset page.
Users that are granted permission to access the Model page of a model version will be able to see the information in the Assets table even if they are not permitted to open the corresponding Asset page.
Editing a Model
Click Edit to save a new version of the model. The Model page is shown with input fields for updating the model’s title, description, assigned tags, and filename. A modified input field can be returned to its original value by clicking the Reset button next to the field.
You can update the model from an MPH file. In Update from field, either drag and drop an MPH file to the dotted rectangular area or click the text Click here to upload to browse for an MPH file on your computer. Click Clear next to the filename of the uploaded MPH file to clear the field. Click Upload New File to replace with another MPH file. Only the title, description, assigned tags, and filename of the model will be updated if you leave the Update from field empty when saving.
Unless you have already modified the corresponding field on the page, Model Manager server will automatically update the values for the Title, Description, and Filename fields from values found in the uploaded MPH file. Click the Reset button next to a field if you would rather keep the value of the saved version.
None of the changes made on the page are stored in the database until you click Save, in which case all changes are saved collectively as a new model version. Click Cancel to return the page to its read mode with all data restored as it was before the edit began.
To save your changes as a new model version:
1
Click the Save button at the bottom of the page.
2
Write a commit comment in the opened Save Model dialog.
3
Click Save in the dialog.
Any version conflicts detected between the latest model version and a potential model version identified by the uploaded MPH file will be ignored when saving. Such a conflict may occur, for example, if the MPH file was previously obtained by downloading an older version of the model from the database.
Identical to Adding a New Model, a Model Manager server will preserve the format of the MPH file as originally saved in COMSOL Multiphysics when updating from an uploaded MPH file. You can update from MPH files saved in COMSOL Multiphysics version 5.3 or later.
Model Settings in the Model Manager Reference Manual.
Model Version History
You can view the model’s version history with respect to the latest version on a particular branch on the Model Versions page. Click Versions on the Model page to show a table with versions saved on the branch sorted chronologically with most recent first. To view the version history with respect to another branch, select it from the location selector in the upper right corner.
The table columns are:
•
The type column — an icon used to represent of the type of the version.
•
The Title column — the title of the version.
•
The Saved column — the point in time when the version was saved.
•
The Saved by column — the user that saved the version.
•
The Repository column — the repository that the version belongs to.
•
The Branch column — the branch that the version belongs to.
•
The Comments column — the commit comment written when the version was saved.
Click on a title in the Title column to open the Model page for that specific version.
The Versions Window in the Model Manager Reference Manual.
Downloading a Model Version
Click the Download button on the Model page to download the model version as an MPH file to your computer. For models with large solution data, the download may take some to begin as Model Manager server first needs to build the MPH file on the server computer.
The Model Manager server preserves the format of the model version as originally saved in COMSOL Multiphysics in the exported MPH file.
Built, computed, and plotted data is included in the downloaded MPH file based on the selected value in the On file list in the Save section of the Settings window for the root node of the model tree. To override this, click the expander button next to the Download button and select Customized Download. In the Customized Download dialog, under Computed data, select among the options:
•
Include or exclude based on application settings. Same behavior as when clicking the Download button. Default selected.
•
Include. Download with built, computed, and plotted data included.
•
Exclude. Download with built, computed, and plotted data excluded.
Click Download in the dialog to download the model version using the selected option for built, computed, and plotted data.
Opening Model Versions in the COMSOL Desktop
Users with a COMSOL Multiphysics installation on Windows® can open a model version in the COMSOL Desktop by clicking the Open in COMSOL Desktop button on the Model page. The Opening Model in the COMSOL Desktop dialog is shown in the web interface while an attempt is made to open the model version in a suitable COMSOL Multiphysics program session. If no program session is currently running, or if models are being solved in all available program sessions, a new program session will be launched. Otherwise, a dialog is shown in one of the program sessions asking how to open the model version:
•
Click Open in This Window to open in the current program session.
•
Click Open in New Window to launch a new program session.
•
Click Cancel to not open at all.
Opening a model version via Open in COMSOL Desktop is only supported for COMSOL Multiphysics version 6.4 or later on the Windows® operating system. You must have also selected the Associate links in the Model Manager server web interface with this installation checkbox in the Options step of the COMSOL Multiphysics installer.
You will get an error message in the COMSOL Desktop if there is no database configuration for the Model Manager server database in the Model Manager workspace. Select File>Open From>Add Database>Connect to Server Database and fill in the connection details for the Model Manager server. See also Connecting to a Server Database in the Model Manager Reference Manual. You can proceed by clicking Open in COMSOL Desktop once more from the web interface.
Running Application Versions in the COMSOL Desktop
For model versions of type Application, you can also click the expander button next to the Open in COMSOL Desktop button and select Run in COMSOL Desktop. The Running Application in the COMSOL Desktop dialog is shown while an attempt is made to run the model version as an application in COMSOL Multiphysics.
Using Copy Location to Clipboard to Open the Model Version
If you have an older installation of COMSOL Multiphysics (6.0–6.3), or if you are running on Linux® or macOS, you can use the location string identifier of the model version to open it:
1
Click the Copy Location to Clipboard button on the Model page.
The location string identifier for the model version has now been copied to the computer’s clipboard.
2
Launch the COMSOL Multiphysics software if not already running. Select File > Open From in the COMSOL Desktop.
3
Select the Clipboard menu option in the Open window. The model version is shown as a single option in the list on the right. Click Open.
You may be asked to fill in your username and password for the Model Manager server.
Copying to clipboard via the Copy Location to Clipboard button is only available when accessing the Model Manager server web interface via localhost or through a secure connection using HTTPS.