public interface SolverSequence extends ModelEntity
Modifier and Type | Method and Description |
---|---|
java.lang.String |
adaptationStudyFeature()
Returns path to adaptation study feature.
|
void |
adaptationStudyFeature(java.lang.String tag)
Sets adaptation study feature.
|
void |
attach(java.lang.String study)
Attaches solver sequence to a study.
|
void |
clearSolution()
Deprecated.
Clears the solution data associated with the solver sequence. Prefer using
clearSolutionData() instead that generally works as expected. |
void |
clearSolutionData()
Clears the solution data associated with the solver sequence.
|
void |
continueRun()
Continues to run a solver sequence.
|
void |
copySolution(java.lang.String fname)
Copy the solution to a new solver sequence.
|
SolverFeature |
create(java.lang.String tag,
java.lang.String oper)
Create a solver feature.
|
void |
createAutoSequence(java.lang.String aSequence)
Creates a solver sequence automatically from the study.
|
void |
createAutoSequence(java.lang.String aSequence,
boolean forceSequence)
Creates a solver sequence automatically from the study.
|
void |
createSolution()
Create a solution.
|
void |
detach()
Detaches solver sequence from its study.
|
SolverFeatureList |
feature()
Returns all solver features.
|
SolverFeature |
feature(java.lang.String tag)
Returns solver feature.
|
java.lang.String |
getClusterStorage()
Gets the solution storage format on cluster.
|
int |
getDefaultSolnum()
Gets the default solution number.
|
java.lang.String |
getErrorMessage()
Returns error message.
|
java.lang.String |
getMesh(java.lang.String geom)
Returns mesh tag.
|
java.lang.String |
getMesh(java.lang.String geom,
int iMulti)
Returns mesh tag.
|
int |
getNU(java.lang.String uType)
Returns the number of solutions stored of a type.
|
java.lang.String[] |
getParamNames()
Returns the parameter names.
|
double[] |
getParamVals()
Returns the parameter values.
|
java.lang.String[] |
getPNames()
Gets parameter names.
|
double[] |
getPVals()
Returns for a solution of Parametric type the real part of all the
parameter values stored.
|
double[] |
getPVals(int solnum)
Returns for a solution of Parametric type the real part of all the
parameter values stored for a solution number.
|
double[] |
getPValsImag()
Gets the imaginary part of the parameter values for the default
solution number.
|
double[] |
getPValsImag(int solnum)
Gets the imaginary part of the parameter values for a solution number.
|
java.lang.String |
getSequenceType()
Get sequence type.
|
int[] |
getSize()
Returns an array of sizes for the solution data.
|
int[] |
getSize(int iMulti)
Returns an array of sizes for the solution data.
|
int[] |
getSizeMulti()
Returns an array of sizes for the solution data.
|
SolutionInfo |
getSolutioninfo()
Returns solution info object.
|
java.lang.String |
getType()
Get solution type.
|
double[] |
getU()
Retrieves the real part of the solution vector using a default
solution number.
|
double[] |
getU(int solnum)
Returns the real part of the solution vector for a solution number.
|
double[] |
getU(int solnum,
java.lang.String uType)
Returns the real part of the solution vector for a solution number.
|
double[] |
getU(int solnum,
java.lang.String uType,
int uNum)
Returns the real part of the solution vector for a solution number.
|
double[] |
getUBlock(int start,
int stop)
Gets blocks of real part of the solution vector solution for a default
solution number.
|
double[] |
getUBlock(int solnum,
int start,
int stop)
Gets blocks of real part of the solution vector solution for a default
solution number.
|
double[] |
getUBlock(int solnum,
java.lang.String uType,
int start,
int stop)
Gets blocks of real part of the solution vector solution for a default
solution number.
|
double[] |
getUBlock(int solnum,
java.lang.String uType,
int uNum,
int start,
int stop)
Gets blocks of real part of the solution vector solution for a default
solution number.
|
double[] |
getUDot()
Gets real part of the first time-derivative of the solution vector.
|
double[] |
getUDot(int solnum)
Gets real part of the first time-derivative of the solution vector for
a solution number.
|
double[] |
getUDotBlock(int start,
int stop)
Gets blocks of real part of the time-derivative of the solution vector
solution for a default solution number.
|
double[] |
getUDotBlock(int solnum,
int start,
int stop)
Gets blocks of real part of the time-derivative of the solution vector
solution for a default solution number.
|
double[] |
getUDotImag()
Gets imaginary part of first time-derivative solution vector for the
default solution number.
|
double[] |
getUDotImag(int solnum)
Gets imaginary part of first time-derivative solution vector for the
default solution number.
|
double[] |
getUDotImagBlock(int start,
int stop)
Gets blocks of imaginary part of the time-derivative of the solution
vector solution for a default solution number.
|
double[] |
getUDotImagBlock(int solnum,
int start,
int stop)
Gets blocks of imaginary part of the time-derivative of the solution
vector solution for a default solution number.
|
double[] |
getUImag()
Gets imaginary part of the solution vector for default solution
number.
|
double[] |
getUImag(int solnum)
Gets imaginary part of the solution vector for a solution number.
|
double[] |
getUImag(int solnum,
java.lang.String uType)
Gets imaginary part of the solution vector for a solution number.
|
double[] |
getUImag(int solnum,
java.lang.String uType,
int uNum)
Gets imaginary part of the solution vector for a solution number.
|
double[] |
getUImagBlock(int start,
int stop)
Gets blocks of imaginary part of the solution vector solution for a
default solution number.
|
double[] |
getUImagBlock(int solnum,
int start,
int stop)
Gets blocks of imaginary part of the solution vector solution for a
default solution number.
|
double[] |
getUImagBlock(int solnum,
java.lang.String uType,
int start,
int stop)
Gets blocks of imaginary part of the solution vector solution for a
default solution number.
|
double[] |
getUImagBlock(int solnum,
java.lang.String uType,
int uNum,
int start,
int stop)
Gets blocks of imaginary part of the solution vector solution for a
default solution number.
|
java.lang.String |
getWarningMessage()
Returns warning message.
|
boolean |
hasProblems()
Returns
true if solver sequence has problems. |
boolean |
isAttached()
Test if solver sequence is attached to a study.
|
boolean |
isEmpty()
Checks if the solutions associated with the solver sequence are empty.
|
boolean |
isInitialized()
Returns true if the solution is initialized.
|
boolean |
isRealPVals()
Returns true if the parameters are real.
|
boolean |
isRealU()
Returns true if the solution is real.
|
boolean |
isRealU(int solnum)
Returns true if the solution is real.
|
boolean |
isRealU(int solnum,
java.lang.String uType)
Returns true if the solution is real.
|
boolean |
isRealU(int solnum,
java.lang.String uType,
int uNum)
Returns true if the solution is real.
|
boolean |
isRealUDot()
Returns true if the time-derivative of the solution is real.
|
boolean |
isRealUDot(int solnum)
Returns true if the time-derivative of the solution is real.
|
void |
run()
Runs solver sequence.
|
void |
run(java.lang.String fname)
Runs the features in a solver sequence to a feature.
|
void |
runAll()
Runs all solver sequence.
|
void |
runFrom(java.lang.String fname)
Runs the features for a solver sequence from a feature.
|
void |
runFromTo(java.lang.String fstartname,
java.lang.String fstopname)
Runs the features in a solver sequence from a feature to a feature.
|
void |
setClusterStorage(java.lang.String format)
Sets the solution storage format on cluster.
|
void |
setPNames(java.lang.String[] names)
Sets parameter names of solution.
|
void |
setPVals(double[] val)
Sets real part of parameter values of solution.
|
void |
setPVals(int solnum,
double[] val)
Sets real part of parameter values of solution for solution number.
|
void |
setPValsImag(double[] val)
Sets imaginary part of parameter values of solution.
|
void |
setPValsImag(int solnum,
double[] val)
Sets imaginary part of parameter values of solution.
|
void |
setU(double[] val)
Sets real part of solution vector.
|
void |
setU(int solnum,
double[] val)
Sets real part of solution vector for a solution number.
|
void |
setUBlock(double[] val,
int start)
Sets blocks of the real part of the solution vector.
|
void |
setUBlock(int solnum,
double[] val,
int start)
Sets blocks of the real part of the solution vector.
|
void |
setUDot(double[] val)
Sets real part of time-derivative of the solution vector.
|
void |
setUDot(int solnum,
double[] val)
Sets real part of time-derivative of the solution vector for a
solution number.
|
void |
setUDotBlock(double[] val,
int start)
Sets blocks of the time derivative of the real part of the solution
vector.
|
void |
setUDotBlock(int solnum,
double[] val,
int start)
Sets blocks of the time derivative of the real part of the solution
vector.
|
void |
setUDotImag(double[] val)
Sets imaginary part of time-derivative of the solution vector.
|
void |
setUDotImag(int solnum,
double[] val)
Sets imaginary part of time-derivative of the solution vector for a
solution number.
|
void |
setUDotImagBlock(double[] val,
int start)
Sets blocks of the time derivative of the imaginary part of the
solution vector.
|
void |
setUDotImagBlock(int solnum,
double[] val,
int start)
Sets blocks of the time derivative of the imaginary part of the
solution vector.
|
void |
setUImag(double[] val)
Sets imaginary part of solution vector.
|
void |
setUImag(int solnum,
double[] val)
Sets imaginary part of solution vector.
|
void |
setUImagBlock(double[] val,
int start)
Sets blocks of the imaginary part of the solution vector.
|
void |
setUImagBlock(int solnum,
double[] val,
int start)
Sets blocks of the imaginary part of the solution vector.
|
java.lang.String |
study()
Returns the study tag of a solver sequence.
|
void |
study(java.lang.String tag)
Assigns a solver sequence to a study.
|
void |
updateSolution()
Updates a solver sequence to make it up to date with respect to the
current model.
|
XmeshInfo |
xmeshInfo()
Returns extended mesh information for solution.
|
XmeshInfo |
xmeshInfo(int iMulti)
Returns extended mesh information for solution iMulti of multi
solution object.
|
XmeshInfo |
xmeshInfo(java.lang.String meshCase)
Returns extended mesh information for solution for mesh case.
|
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
java.lang.String adaptationStudyFeature()
void adaptationStudyFeature(java.lang.String tag)
tag
- A path of tags to the adaptation study feature.void attach(java.lang.String study)
study
- Study tag.@Deprecated void clearSolution()
clearSolutionData()
instead that generally works as expected.void clearSolutionData()
void continueRun()
void copySolution(java.lang.String fname)
fname
- Tag of the new solution.SolverFeature create(java.lang.String tag, java.lang.String oper)
tag
- Feature tag.oper
- Type of feature.void createAutoSequence(java.lang.String aSequence)
aSequence
- Study tag of the study to generate the solver sequence from.void createAutoSequence(java.lang.String aSequence, boolean forceSequence)
aSequence
- Study tag of the study to generate the solver sequence from.forceSequence
- Always create a sequence if true.void createSolution()
void detach()
SolverFeatureList feature()
SolverFeature feature(java.lang.String tag)
tag
- Solver feature tag.java.lang.String getClusterStorage()
int getDefaultSolnum()
java.lang.String getErrorMessage()
java.lang.String getMesh(java.lang.String geom)
geom
- Geometry tag.java.lang.String getMesh(java.lang.String geom, int iMulti)
geom
- Geometry tag.iMulti
- Local solution number in multi solution.int getNU(java.lang.String uType)
uType
- Type of solution: Sol
(main solution),
Reacf
(reaction force), Adj
(adjoint solution), Fsens
(functional
sensitivity), and Sens
(forward sensitivity).java.lang.String[] getPNames()
double[] getPVals()
double[] getPVals(int solnum)
solnum
- Solution number.double[] getPValsImag()
double[] getPValsImag(int solnum)
solnum
- Solution number.java.lang.String[] getParamNames()
double[] getParamVals()
java.lang.String getSequenceType()
SolverSequence
,
CopySolution
,
ParametricStore
, Stored
,
Parametric
, or None
.int[] getSize()
int[] getSize(int iMulti)
iMulti
- Local solution number in multi solution.int[] getSizeMulti()
SolutionInfo getSolutioninfo()
java.lang.String getType()
Stationary
,Parametric
,
Time
, or Eigenvalue
.double[] getU()
double[] getU(int solnum)
solnum
- Solution number.double[] getU(int solnum, java.lang.String uType)
solnum
- Solution number.uType
- Real part of solution vector.double[] getU(int solnum, java.lang.String uType, int uNum)
solnum
- Solution number.uType
- Solution type.uNum
- Solution index.double[] getUBlock(int start, int stop)
start
- Start index.stop
- Stop index.double[] getUBlock(int solnum, int start, int stop)
solnum
- Solution number.start
- Start index.stop
- Stop index.double[] getUBlock(int solnum, java.lang.String uType, int start, int stop)
solnum
- Solution number.uType
- Solution type.start
- Start index.stop
- stop.double[] getUBlock(int solnum, java.lang.String uType, int uNum, int start, int stop)
solnum
- Solution number.uType
- Solution type.uNum
- Solution INDEX.start
- Start index.stop
- Stop index.double[] getUDot()
double[] getUDot(int solnum)
solnum
- Solution number.double[] getUDotBlock(int start, int stop)
start
- Start index.stop
- Stop index.double[] getUDotBlock(int solnum, int start, int stop)
solnum
- Solution number.start
- Start index.stop
- stop index.double[] getUDotImag()
double[] getUDotImag(int solnum)
solnum
- Solution number.double[] getUDotImagBlock(int start, int stop)
start
- Start index.stop
- Stop index.double[] getUDotImagBlock(int solnum, int start, int stop)
solnum
- Solution number.start
- Start index.stop
- Stop index.double[] getUImag()
double[] getUImag(int solnum)
solnum
- Solution number.double[] getUImag(int solnum, java.lang.String uType)
solnum
- Solution number.uType
- Solution type.double[] getUImag(int solnum, java.lang.String uType, int uNum)
solnum
- Solution number.uType
- Solution type.uNum
- Solution index.double[] getUImagBlock(int start, int stop)
start
- Start index.stop
- Stop index.double[] getUImagBlock(int solnum, int start, int stop)
solnum
- Solution number.start
- Start index.stop
- Stop index.double[] getUImagBlock(int solnum, java.lang.String uType, int start, int stop)
solnum
- Solution number.uType
- Solution type.start
- Start index.stop
- Stop index.double[] getUImagBlock(int solnum, java.lang.String uType, int uNum, int start, int stop)
solnum
- Solution number.uType
- Solution type.uNum
- Solution index.start
- Start index.stop
- Stop index.java.lang.String getWarningMessage()
boolean hasProblems()
true
if solver sequence has problems.true
if solver sequence has problems.boolean isAttached()
boolean isEmpty()
boolean isInitialized()
true
if solution is initialized.boolean isRealPVals()
true
if parameters are real.boolean isRealU()
true
if solution is real.boolean isRealU(int solnum)
solnum
- Solution number.true
if solution is real.boolean isRealU(int solnum, java.lang.String uType)
solnum
- Solution number.uType
- Solution type.true
if solution is real.boolean isRealU(int solnum, java.lang.String uType, int uNum)
solnum
- Solution number.uType
- Solution type.uNum
- Solution index.true
if solution is real.boolean isRealUDot()
true
if parameters are real.boolean isRealUDot(int solnum)
solnum
- Solution number.true
if parameters are real.void run()
void run(java.lang.String fname)
fname
- Run to this feature.void runAll()
void runFrom(java.lang.String fname)
fname
- Run from this feature.void runFromTo(java.lang.String fstartname, java.lang.String fstopname)
fstartname
- Run from feature.fstopname
- Run to feature.void setClusterStorage(java.lang.String format)
format
- Type of cluster storage format: all
(Solution is
stored on all nodes), single
(Only a single node
stores the entire solution).void setPNames(java.lang.String[] names)
names
- Parameter names.void setPVals(double[] val)
val
- Parameter values.void setPVals(int solnum, double[] val)
solnum
- Solution number.val
- Imaginary part of parameter values.void setPValsImag(double[] val)
val
- Imaginary part of parameter values.void setPValsImag(int solnum, double[] val)
solnum
- Solution number.val
- Imaginary part of parameter values.void setU(double[] val)
val
- Solution vector.void setU(int solnum, double[] val)
solnum
- Solution number.val
- Solution vector.void setUBlock(double[] val, int start)
val
- Solution vector.start
- start.void setUBlock(int solnum, double[] val, int start)
solnum
- Solution number.val
- Solution vector.start
- Start index.void setUDot(double[] val)
val
- Solution vector.void setUDot(int solnum, double[] val)
solnum
- Solution number.val
- Solution vector.void setUDotBlock(double[] val, int start)
val
- Solution vector.start
- Start index.void setUDotBlock(int solnum, double[] val, int start)
solnum
- Solution number.val
- Solution vector.start
- Start index.void setUDotImag(double[] val)
val
- Solution vector.void setUDotImag(int solnum, double[] val)
solnum
- Solution number.val
- Solution vector.void setUDotImagBlock(double[] val, int start)
val
- Solution vector.start
- Start index.void setUDotImagBlock(int solnum, double[] val, int start)
solnum
- Solution number.val
- Solution vector.start
- Start index.void setUImag(double[] val)
val
- Solution vector.void setUImag(int solnum, double[] val)
solnum
- Solution number.val
- Solution vector.void setUImagBlock(double[] val, int start)
val
- Solution vector.start
- Start index.void setUImagBlock(int solnum, double[] val, int start)
solnum
- Solution number.val
- Solution vector.start
- Start index.java.lang.String study()
void study(java.lang.String tag)
tag
- Study tag.void updateSolution()
XmeshInfo xmeshInfo()
XmeshInfo xmeshInfo(java.lang.String meshCase)
meshCase
- Mesh case.XmeshInfo xmeshInfo(int iMulti)
iMulti
- Local solution number in multi solution.