Package com.comsol.model

Interface FunctionFeature

All Superinterfaces:

IPlotAndImageExport, ModelEntity, PrimitiveModelEntity, PropFeature, SelectionContainer, SelectionEntity

All Known Subinterfaces:

CapeOpenFeature, ThermodynamicsFeature

public interface FunctionFeature
extends PropFeature, IPlotAndImageExport

Function.

Method Summary

Modifier and Type	Method	Description
void	continueRun()	For functions that need to be computed from input data before they can be accurately evaluated, perform this computation.
FunctionFeature	create(java.lang.String tag, java.lang.String oper)	Create a function.
ResultFeature	createPlot(java.lang.String plotGroupTag)	Creates a plot group with plots for the function.
void	discardData()	Discard any imported data.
void	export(java.lang.String filename)	For functions that support exporting the internal representation of the function, exports the function to the target file path in a standardized format for use with external tools and runtimes.
void	exportData(java.lang.String filename)	Export data.
FunctionFeatureList	feature()	Returns all functions.
FunctionFeature	feature(java.lang.String tag)	Return a function.
java.lang.String[]	functionNames()	Get function names.
void	importData()	Import data.
void	importData(java.lang.String filename)	Import data from specified file.
FunctionFeature	model(java.lang.String model)	Sets the model of the function.
ProblemList	problem()	Returns all problems for this feature.
ProblemFeature	problem(java.lang.String tag)	Returns a problem feature.
void	refresh()	Reread the files that this function depends on, if any.
void	run()	For functions that need to be computed from input data before they can be accurately evaluated, perform this computation.
void	runTest()	For functions that need to be computed from input data before they can be accurately evaluated, perform this computation to determine the accuracy of previous construction from input data.

Methods inherited from interface com.comsol.model.IPlotAndImageExport

image

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, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, selection, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

continueRun

void continueRun()

For functions that need to be computed from input data before they can be accurately evaluated, perform this computation. The result from the previous call to run() or continueRun() is used as the starting point for the computation.

create

FunctionFeature create(java.lang.String tag,
                       java.lang.String oper)

Create a function.

Parameters:

tag - Feature tag.

oper - Type of function.

Returns:

Created function.

createPlot

ResultFeature createPlot(java.lang.String plotGroupTag)

Creates a plot group with plots for the function. A dataset is also created.

Parameters:

plotGroupTag - The plot group tag.

Returns:

The plot group.

discardData

void discardData()

Discard any imported data.

export

void export(java.lang.String filename)

For functions that support exporting the internal representation of the function, exports the function to the target file path in a standardized format for use with external tools and runtimes.

Parameters:

filename - Filename.

exportData

void exportData(java.lang.String filename)

Export data.

Parameters:

filename - Filename.

feature

FunctionFeatureList feature()

Returns all functions.

Returns:

List of functions.

feature

FunctionFeature feature(java.lang.String tag)

Return a function.

Parameters:

tag - Function tag.

Returns:

Function.

functionNames

java.lang.String[] functionNames()

Get function names.

Returns:

Function names.

importData

void importData()

Import data.

importData

void importData(java.lang.String filename)

Import data from specified file.

Parameters:

filename - Filename.

model

FunctionFeature model(java.lang.String model)

Sets the model of the function.

Specified by:

model in interface ModelEntity

Parameters:

model - Model node tag.

Returns:

Function.

problem

ProblemList problem()

Returns all problems for this feature.

Returns:

Problem feature list.

problem

ProblemFeature problem(java.lang.String tag)

Returns a problem feature.

Parameters:

tag - Problem tag.

Returns:

Problem feature.

refresh

void refresh()

Reread the files that this function depends on, if any.

run

void run()

For functions that need to be computed from input data before they can be accurately evaluated, perform this computation.

runTest

void runTest()

For functions that need to be computed from input data before they can be accurately evaluated, perform this computation to determine the accuracy of previous construction from input data.