com.comsol.model

Interface Study

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, StudyContainer

public interface Study
extends ModelEntity, StudyContainer

List of study features.

Method Summary

Modifier and Type	Method and Description
void	continueRun() Continues the study.
StudyFeature	create(java.lang.String tag, java.lang.String type) Creates a study step.
void	createAutoSequences(java.lang.String type) Create an attached solver sequence and/or job using default solver settings.
StudyFeatureList	feature() Returns the study steps.
StudyFeature	feature(java.lang.String study) Returns a study step with the given tag.
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[]	getSolverSequences(java.lang.String type) Returns the tags for the solver sequences of a certain type related to this study.
boolean	isGenConv() Returns true if convergence plots should be generated.
boolean	isGenPlots() Returns true if default results plots should be generated.
boolean	isPlotUndefVals() Returns true if the plots of location of undefined values should be generated.
boolean	isStoreSolution() Returns true if there should be a Store Solution node inserted between each Study Step.
void	run() Runs the study.
void	runNoGen() Runs the attached solver sequence without regenerating it.
void	setGenConv(boolean value) Set if convergence plots should be generated.
void	setGenPlots(boolean value) Set if default results plots should be generated.
void	setPlotUndefVals(boolean value) Set if the plots of location of undefined values should be generated.
void	setStoreSolution(boolean store) Set if there should be a Store Solution node inserted between each Study Step.
void	showAutoSequences(java.lang.String type) Generates a new attached solver sequence and/or job using default solver settings.

Methods inherited from interface com.comsol.model.ModelEntity

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

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString

Method Detail

continueRun

void continueRun()

Continues the study.

create

StudyFeature create(java.lang.String tag,
                    java.lang.String type)

Creates a study step.

Parameters:

tag - Study tag.

type - Study type.

Returns:

Created study step.

createAutoSequences

void createAutoSequences(java.lang.String type)

Create an attached solver sequence and/or job using default solver settings.

Parameters:

type - One of all, jobs, or sol.

feature

StudyFeatureList feature()

Returns the study steps.

Returns:

List of study steps.

feature

StudyFeature feature(java.lang.String study)

Returns a study step with the given tag.

Parameters:

study - Study tag.

Returns:

Requested study tag.

getLastComputationTime

long getLastComputationTime()

Returns the last computation time in milliseconds.

Returns:

Computation time in milliseconds.

getLastComputationTime

java.lang.String getLastComputationTime(java.lang.String format)

Returns the last computation time in the given format. The format can either be a time unit or a text describing a longer format. Currently supported formats are:
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.
.

Parameters:

format - Time format.

Returns:

Formatted computation time.

getSolverSequences

java.lang.String[] getSolverSequences(java.lang.String type)

Returns the tags for the solver sequences of a certain type related to this study.

Parameters:

type - One of All, None, SolverSequence, CopySolution, ParametricStore, Stored, or Parametric.

Returns:

Solver sequence tags.

isGenConv

boolean isGenConv()

Returns true if convergence plots should be generated.

Returns:

true if convergence plots should be generated.

isGenPlots

boolean isGenPlots()

Returns true if default results plots should be generated.

Returns:

true if default results plots should be generated.

isPlotUndefVals

boolean isPlotUndefVals()

Returns true if the plots of location of undefined values should be generated.

Returns:

true if plots of location of undefined values should be generated.

isStoreSolution

boolean isStoreSolution()

Returns true if there should be a Store Solution node inserted between each Study Step.

Returns:

true if there should be a Store Solution node inserted between each Study Step.

run

void run()

Runs the study.

runNoGen

void runNoGen()

Runs the attached solver sequence without regenerating it.

setGenConv

void setGenConv(boolean value)

Set if convergence plots should be generated.

Parameters:

value - true if convergence plots should be generated.

setGenPlots

void setGenPlots(boolean value)

Set if default results plots should be generated.

Parameters:

value - true if default results plots should be generated.

setPlotUndefVals

void setPlotUndefVals(boolean value)

Set if the plots of location of undefined values should be generated.

Parameters:

value - true if the plots of location of undefined values should be generated.

setStoreSolution

void setStoreSolution(boolean store)

Set if there should be a Store Solution node inserted between each Study Step.

Parameters:

store - true if there should be a Store Solution node inserted between each Study Step.

showAutoSequences

void showAutoSequences(java.lang.String type)

Generates a new attached solver sequence and/or job using default solver settings.

Parameters:

type - Generates a new attached solver sequence and/or job using default solver settings.