public interface Model extends AbstractModel
Modifier and Type | Method and Description |
---|---|
com.comsol.api.AppModel |
app()
Returns the runtime application API object.
|
Model |
basesystem(java.lang.String arg0)
Deprecated.
Use
baseSystem(String) instead. |
Model |
baseSystem(java.lang.String name)
Sets the base unit system.
|
BatchList |
batch()
Returns all batch jobs.
|
BatchFeature |
batch(java.lang.String tag)
Returns a batch job.
|
BEMFeatureList |
bem()
Returns all boundary elements.
|
BEMFeature |
bem(java.lang.String tag)
Return a boundary element.
|
CapeOpen |
capeopen()
Returns the CAPE-OPEN interface.
|
void |
clearThumbnail()
Clears the model thumbnail.
|
CoeffList |
coeff()
Returns all coefficient form equations.
|
Coeff |
coeff(java.lang.String tag)
Returns coefficient form equations.
|
java.lang.String |
colorTheme()
Returns the color theme used in graphics.
|
void |
colorTheme(java.lang.String theme)
Sets the color theme to be used in graphics.
|
ModelNodeList |
component()
Returns all model components.
|
ModelNode |
component(java.lang.String tag)
Returns a model component.
|
ConstrList |
constr()
Returns all constraints.
|
Constr |
constr(java.lang.String tag)
Returns a constraint.
|
CoordsysList |
coordsys()
Deprecated.
Use
AbstractModel.coordSystem() instead. |
Coordsys |
coordsys(java.lang.String arg0)
Deprecated.
Use
AbstractModel.coordSystem(String) instead. |
boolean |
disableUpdates()
Returns the current state of the disabling of variable updates.
|
boolean |
disableUpdates(boolean state)
Temporarily disables and re-enables the update of variables in
entities that automatically generates other entities.
|
ElemList |
elem()
Returns all elements.
|
Element |
elem(java.lang.String tag)
Returns an element.
|
ElementSetList |
elementSet()
Returns all mesh element sets.
|
ElementSet |
elementSet(java.lang.String tag)
Returns a mesh element set.
|
FieldList |
field()
Returns all fields.
|
Field |
field(java.lang.String tag)
Returns a field.
|
FileResourceList |
file()
Returns a list of file entities referenced by model entities.
|
FileResource |
file(java.lang.String tag)
Returns a file entity.
|
java.lang.String |
fontFamily()
Returns the font family to be used in plots.
|
void |
fontFamily(java.lang.String family)
Sets the font family to be used in plots.
|
int |
fontSize()
Returns the font size used in plots.
|
void |
fontSize(int size)
Sets the font size to be used in plots.
|
FormFeatureList |
form()
Returns all form features.
|
FormFeature |
form(java.lang.String tag)
Returns a form feature.
|
FrameList |
frame()
Returns all frames.
|
Frame |
frame(java.lang.String tag)
Returns a frame.
|
java.lang.String |
getComsolVersion()
Get the COMSOL version used to save the model, or the current version
if the model has never been saved.
|
java.lang.String |
getExpectedComputationTime()
Returns a text specifying the expected computation time.
|
java.lang.String |
getFilePath()
Returns the absolute path of the model.
|
long |
getLastComputationTime()
Returns the last computation time in milliseconds.
|
java.lang.String |
getLastComputationTime(java.lang.String format)
Returns the last computation time in the given format.
|
java.lang.String |
getThumbnail()
Get the path to the thumbnail file.
|
java.lang.String[] |
getUsedProducts()
Returns the products that this model uses.
|
GroupList |
group()
Returns all groups.
|
Group |
group(java.lang.String tag)
Returns a group.
|
History |
hist()
Returns the model history.
|
InitList |
init()
Returns all initial values.
|
Init |
init(java.lang.String tag)
Returns an initial value.
|
IntRuleList |
intrule()
Deprecated.
Use
intRule() instead. |
IntRuleList |
intRule()
Returns all integration rules.
|
IntRule |
intrule(java.lang.String arg0)
Deprecated.
Use
intRule(String) instead. |
IntRule |
intRule(java.lang.String tag)
Returns an integration rule.
|
boolean |
isReadOnly()
Returns whether the file where the model is saved is read-only and
cannot be overwritten.
|
MethodCallFeatureList |
methodCall()
Returns all method calls.
|
MethodCallFeature |
methodCall(java.lang.String tag)
Returns a method call.
|
AppFeature |
modelData()
Get the model data.
|
ModelNodeList |
modelNode()
Returns all model nodes.
|
ModelNode |
modelNode(java.lang.String tag)
Returns a model node.
|
java.lang.String |
modelPath()
Returns the model path, which is path for additional files related to
the model.
|
void |
modelPath(java.lang.String path)
Sets the model path, which is the path for additional files related to
the model.
|
NodeGroupList |
nodeGroup()
Returns all node groups.
|
NodeGroup |
nodeGroup(java.lang.String tag)
Returns a node group.
|
OdeList |
ode()
Returns all global equations.
|
Ode |
ode(java.lang.String tag)
Returns a global equation.
|
OptSequence |
opt()
Returns the optimization interface.
|
ModelParam |
param()
Returns the parameters.
|
ModelParamGroup |
param(java.lang.String gTag)
Returns a parameter group with the given tag.
|
ReducedModelList |
reduced()
Returns all reduced models.
|
ReducedModelBase |
reduced(java.lang.String tag)
Returns a reduced order model.
|
void |
resetHist()
Resets the history of the model to an almost minimal sequence of
actions that creates the current state.
|
Results |
result()
Returns postprocessing interface.
|
ResultFeature |
result(java.lang.String tag)
Returns a plot group.
|
void |
save()
Saves the model object to file.
|
void |
save(java.lang.String filename)
Saves the model object to file.
|
void |
save(java.lang.String filename,
java.lang.String type)
Saves a Model Java file or a Model M-file.
|
SavePointDataList |
savePoint()
Returns containers holding selections and hide features used by result
features.
|
SavePointData |
savePoint(java.lang.String tag)
Returns a container holding selections and hide features used by
result features.
|
void |
setExpectedComputationTime(java.lang.String text)
Sets a text specifying the expected computation time.
|
void |
setLastComputationTime(long timeInMs)
Manually sets the last computation time in milliseconds.
|
void |
setThumbnail(java.lang.String thumbnailPath)
Sets the model thumbnail.
|
ShapeList |
shape()
Returns all shape functions.
|
Shape |
shape(java.lang.String tag)
Returns a shape function.
|
java.lang.Object |
shortcutTarget(java.lang.String shortcut)
Internal use.
|
SolverSequenceList |
sol()
Returns all solver sequences.
|
SolverSequence |
sol(java.lang.String tag)
Returns a solver sequence.
|
EventList |
solverEvent()
Returns all events.
|
Event |
solverEvent(java.lang.String tag)
Returns an event.
|
StudyList |
study()
Returns all studies.
|
Study |
study(java.lang.String tag)
Returns a study.
|
UnitSystemList |
unitsystem()
Deprecated.
Use
unitSystem() instead. |
UnitSystemList |
unitSystem()
Returns all unit systems.
|
UnitSystem |
unitsystem(java.lang.String arg0)
Deprecated.
Use
unitSystem(String) instead. |
UnitSystem |
unitSystem(java.lang.String tag)
Returns a unit system.
|
WeakList |
weak()
Returns all weak form equations.
|
Weak |
weak(java.lang.String tag)
Returns a weak form equation.
|
basesystem, baseSystem, common, common, coordSystem, coordSystem, cpl, cpl, extraDim, extraDim, func, func, geom, geom, groupByType, massProp, massProp, material, material, mesh, mesh, multiphysics, multiphysics, pair, pair, physics, physics, probe, probe, selection, selection, setGroupByType, variable, variable, view, view
active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version
getContainer, getDisplayString
com.comsol.api.AppModel app()
Model baseSystem(java.lang.String name)
baseSystem
in interface AbstractModel
name
- Name of base unit system: : SI
, bft
,
cgs
,mpa
, emu
,
esu
, fps
, ips
, or
psi
.@Deprecated Model basesystem(java.lang.String arg0)
baseSystem(String)
instead.basesystem
in interface AbstractModel
BatchList batch()
BatchFeature batch(java.lang.String tag)
tag
- Batch job tag.BEMFeatureList bem()
BEMFeature bem(java.lang.String tag)
tag
- Boundary element tag.CapeOpen capeopen()
void clearThumbnail()
CoeffList coeff()
Coeff coeff(java.lang.String tag)
tag
- Coefficient form equations tag.java.lang.String colorTheme()
void colorTheme(java.lang.String theme)
theme
- The color theme to use.ModelNodeList component()
ModelNode component(java.lang.String tag)
tag
- Model component tag.ConstrList constr()
Constr constr(java.lang.String tag)
tag
- Constraint tag.@Deprecated CoordsysList coordsys()
AbstractModel.coordSystem()
instead.@Deprecated Coordsys coordsys(java.lang.String arg0)
AbstractModel.coordSystem(String)
instead.boolean disableUpdates()
#disableUpdates(boolean)}.
boolean disableUpdates(boolean state)
_src
. Trying to set a value to any of
these parameters, may give an error message unless to activate the
updates again. Other effects are that the generated variables are
unknown to the unit evaluator, and equation view readings may be
incomplete.state
- If true the update will be disabled from now on.ElemList elem()
Element elem(java.lang.String tag)
tag
- Element tag.ElementSetList elementSet()
ElementSet elementSet(java.lang.String tag)
tag
- Mesh element set tag.FieldList field()
Field field(java.lang.String tag)
tag
- Field tag.FileResourceList file()
FileResource file(java.lang.String tag)
tag
- File entity tag.java.lang.String fontFamily()
void fontFamily(java.lang.String family)
family
- Font family. The built-in font 'default' is always available. If using
Windows, most system fonts can also be used. The font 'automatic'
stands for getting the font specified in preference setting of the
actual running client.int fontSize()
void fontSize(int size)
size
- Integer font size. If the returned font size is '-1', it means the
font size is not fixed and will be fetched from the actual running
client, which makes the font size in graphics window look similar to
the one in GUI widgets even on different platforms. It is preferred
to set to '-1' instead of a fixed value.FormFeatureList form()
FormFeature form(java.lang.String tag)
tag
- Form feature tag.FrameList frame()
Frame frame(java.lang.String tag)
tag
- Frame tag.java.lang.String getComsolVersion()
java.lang.String getExpectedComputationTime()
java.lang.String getFilePath()
long getLastComputationTime()
java.lang.String getLastComputationTime(java.lang.String format)
hr:min:sec
Returns format in
hours, minutes, and seconds in the form X hr Y min Z
sec
. No translation.h:min:s
Returns format in
hours, minutes, and seconds in the form X h Y min Z s
.
No translation.detailed
Returns format in seconds
and also includes more readable units for longer times. Translates
the output to the current language.format
- Time format.java.lang.String getThumbnail()
null
if the model has
no thumbnail.java.lang.String[] getUsedProducts()
GroupList group()
Group group(java.lang.String tag)
tag
- Group tag.History hist()
InitList init()
Init init(java.lang.String tag)
tag
- Initial value tag.IntRuleList intRule()
IntRule intRule(java.lang.String tag)
tag
- Integration rule tag.@Deprecated IntRuleList intrule()
intRule()
instead.@Deprecated IntRule intrule(java.lang.String arg0)
intRule(String)
instead.boolean isReadOnly()
false
.MethodCallFeatureList methodCall()
MethodCallFeature methodCall(java.lang.String tag)
tag
- Method call tag.AppFeature modelData()
ModelNodeList modelNode()
ModelNode modelNode(java.lang.String tag)
tag
- Model node tag.java.lang.String modelPath()
void modelPath(java.lang.String path)
path
- Model path.NodeGroupList nodeGroup()
NodeGroup nodeGroup(java.lang.String tag)
tag
- Group tag.OdeList ode()
Ode ode(java.lang.String tag)
tag
- Global equation tag.OptSequence opt()
ModelParam param()
ModelParamGroup param(java.lang.String gTag)
gTag
- Parameter group tag.ReducedModelList reduced()
ReducedModelBase reduced(java.lang.String tag)
tag
- Reduced model sequence tag.void resetHist()
Results result()
ResultFeature result(java.lang.String tag)
tag
- Plot group tag.void save() throws java.io.IOException
java.io.IOException
void save(java.lang.String filename) throws java.io.IOException
filename
- File name.java.io.IOException
void save(java.lang.String filename, java.lang.String type)
filename
- File name.type
- File type.SavePointDataList savePoint()
SavePointData savePoint(java.lang.String tag)
tag
- The container's tag.void setExpectedComputationTime(java.lang.String text)
text
- Computation time text.void setLastComputationTime(long timeInMs)
timeInMs
- Computation time in milliseconds.void setThumbnail(java.lang.String thumbnailPath)
thumbnailPath
- The path to an image file.ShapeList shape()
Shape shape(java.lang.String tag)
tag
- Shape function tag.java.lang.Object shortcutTarget(java.lang.String shortcut)
shortcut
- Shortcut name.SolverSequenceList sol()
SolverSequence sol(java.lang.String tag)
tag
- Solver sequence tag.EventList solverEvent()
Event solverEvent(java.lang.String tag)
tag
- Event tag.StudyList study()
Study study(java.lang.String tag)
tag
- Study tag.UnitSystemList unitSystem()
UnitSystem unitSystem(java.lang.String tag)
tag
- Unit system tag.@Deprecated UnitSystemList unitsystem()
unitSystem()
instead.@Deprecated UnitSystem unitsystem(java.lang.String arg0)
unitSystem(String)
instead.WeakList weak()
Weak weak(java.lang.String tag)
tag
- Weak form equation tag.