public interface Study extends ModelEntity, StudyContainer
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 |
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 |
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.
|
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
void continueRun()
StudyFeature create(java.lang.String tag, java.lang.String type)
tag
- Study tag.type
- Study type.void createAutoSequences(java.lang.String type)
type
- One of all
, jobs
, or
sol
.StudyFeatureList feature()
StudyFeature feature(java.lang.String study)
study
- Study tag.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[] getSolverSequences(java.lang.String type)
type
- One of All
, None
,
SolverSequence
, CopySolution
,
ParametricStore
, Stored
, or
Parametric
.boolean isStoreSolution()
true
if there should be a Store Solution node inserted
between each Study Step.void run()
void runNoGen()
boolean isGenConv()
true
convergence plots should be generatedboolean isGenPlots()
true
default results plots should be generatedvoid setGenConv(boolean value)
value
- true
if convergence plots should be generated.void setGenPlots(boolean value)
value
- true
if default results plots should be generated.void setStoreSolution(boolean store)
store
- true
if there should be a Store Solution node inserted
between each Study Step.void showAutoSequences(java.lang.String type)
type
- Generates a new attached solver sequence and/or job using default
solver settings.