Client

class Client(cores=None, version=None, port=None, host='localhost')[source]

Manages the Comsol client instance.

A client can either be a stand-alone instance or it could connect to a Comsol server instance started independently, possibly on a different machine on the network.

Example:

import mph
client = mph.Client(cores=1)
model = client.load('model.mph')
model.solve()
model.save()
client.remove(model)

Due to limitations of the Java bridge, provided by the JPype library, only one client can be instantiated at a time. This is because JPype cannot manage more than one Java virtual machine within the same Python session. Separate Python processes would have to be started, or spawned, to work around this limitation. NotImplementedError is therefore raised if another client is already running.

The number of cores (threads) the client instance uses can be restricted by specifying a number. Otherwise all available cores are used.

A specific Comsol version can be selected if several are installed, for example version='5.3a'. Otherwise the latest version is used, and reported via the .version attribute.

Initializes a stand-alone Comsol session if no port number is specified. Otherwise tries to connect to the Comsol server listening at the given port for client connections. The host address defaults to 'localhost', but could be any domain name or IP address.

Internally, the client is a wrapper around the ModelUtil object provided by Comsol’s Java API, which may also be accessed directly via the instance attribute .java.

load(file)[source]

Returns the model loaded from the given file.

create(name)[source]

Creates and returns a new, empty model with the given name.

This is not particularly useful unless you are prepared to drop down to the Java layer and add model features on your own. It may help to call the returned (Python) model object something like pymodel and assign the name model to pymodel.java. Then you can just copy-and-paste Java or Matlab code from the Comsol programming manual or as exported from the Comsol front-end. Python will gracefully overlook gratuitous semicolons at the end of statements, so this approach would even work for entire blocks of code.

models()[source]

Returns all model objects currently held in memory.

names()[source]

Names all models that are currently held in memory.

remove(model)[source]

Removes the given model from memory.

clear()[source]

Removes all loaded models from memory.

disconnect()[source]

Disconnects the client from the server.